org.apache.sshd.sftp.client.impl

Class SftpPathImpl

java.lang.Object

org.apache.sshd.common.file.util.BasePath<SftpPath,SftpFileSystem>

org.apache.sshd.sftp.client.fs.SftpPath

org.apache.sshd.sftp.client.impl.SftpPathImpl

All Implemented Interfaces:

Comparable<Path>, Iterable<Path>, Path, Watchable

public class SftpPathImpl
extends SftpPath

An SftpPath that can cache SftpClient.Attributes.

Field Summary

Fields inherited from class org.apache.sshd.common.file.util.BasePath

names, root

Constructor Summary

Constructors

Constructor and Description
SftpPathImpl(SftpFileSystem fileSystem, String root, List<String> names)

Method Summary

Modifier and Type	Method and Description
protected void	cacheAttributes(boolean doCache) SftpPath instances can cache SFTP SftpClient.Attributes.
void	cacheAttributes(SftpClient.Attributes attributes) Sets the cached attributes to the argument if this SftpPath instance is currently caching attributes.
SftpClient.Attributes	getAttributes() Retrieves the cached SftpClient.Attributes of this SftpPath, if it has any.
void	setAttributes(SftpClient.Attributes attributes) Unconditionally set the cached attributes, whether or not this instance's attribute cache is enabled.
<T> T	withAttributeCache(org.apache.sshd.common.util.io.functors.IOFunction<Path,T> operation) Performs the given operation with attribute caching.
static <T> T	withAttributeCache(Path path, org.apache.sshd.common.util.io.functors.IOFunction<Path,T> operation) Performs the given operation with attribute caching, if the given Path can cache attributes, otherwise simply executes the operation.

Methods inherited from class org.apache.sshd.sftp.client.fs.SftpPath

toRealPath

Methods inherited from class org.apache.sshd.common.file.util.BasePath

asString, asT, calculatedHashCode, checkPath, compare, compareTo, create, create, create, endsWith, endsWith, endsWith, equals, getFileName, getFileSystem, getName, getNameCount, getParent, getRoot, hashCode, isAbsolute, isNormal, iterator, normalize, register, register, relativize, resolve, resolve, resolveSibling, resolveSibling, startsWith, startsWith, startsWith, subpath, toAbsolutePath, toFile, toString, toUri

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SftpPathImpl

public SftpPathImpl(SftpFileSystem fileSystem,
                    String root,
                    List<String> names)

Method Detail

cacheAttributes

protected void cacheAttributes(boolean doCache)

SftpPath instances can cache SFTP SftpClient.Attributes. Caching can be enabled by passing true. If the SftpPath instance is already caching attributes, a counter is increased only. To disable caching, pass false, which decreases the counter. The cache is cleared when the counter reaches zero again.

Each call of cacheAttributes(true) must be matched by a call to cacheAttributes(false). Such call pairs can be nested; caching is enabled for the duration of the outermost such pair. The outermost call passing true clears any possibly already cached attributes so that the next attempt to read remote attributes will fetch them anew.

Client code should use withAttributeCache(Path, IOFunction), which ensures the above condition.

Parameters:

doCache - whether to start caching (increasing the cache level) or to stop caching (decreasing the cache level)

See Also:

withAttributeCache(Path, IOFunction)

cacheAttributes

public void cacheAttributes(SftpClient.Attributes attributes)

Sets the cached attributes to the argument if this SftpPath instance is currently caching attributes. Otherwise a no-op.

Parameters:

attributes - the SftpClient.Attributes to cache

setAttributes

public void setAttributes(SftpClient.Attributes attributes)

Unconditionally set the cached attributes, whether or not this instance's attribute cache is enabled.

Parameters:

attributes - the SftpClient.Attributes to cache

getAttributes

public SftpClient.Attributes getAttributes()

Description copied from class: SftpPath

Retrieves the cached SftpClient.Attributes of this SftpPath, if it has any.

Overrides:

getAttributes in class SftpPath

Returns:

the cached SftpClient.Attributes or null if there are none cached

withAttributeCache

public <T> T withAttributeCache(org.apache.sshd.common.util.io.functors.IOFunction<Path,T> operation)
                         throws IOException

Performs the given operation with attribute caching. If SftpClient.Attributes are fetched by the operation, they will be cached and subsequently these cached attributes will be re-used for this SftpPath instance throughout the operation. Calls to withAttributeCache(IOFunction) may be nested. The cache is cleared at the start and at the end of the outermost invocation.

Type Parameters:

T - result type of the operation

Parameters:

operation - to perform; may return null if it has no result

Returns:

the result of the operation

Throws:

IOException - if thrown by the operation

withAttributeCache

public static <T> T withAttributeCache(Path path,
                                       org.apache.sshd.common.util.io.functors.IOFunction<Path,T> operation)
                                throws IOException

Performs the given operation with attribute caching, if the given Path can cache attributes, otherwise simply executes the operation.

Type Parameters:

T - result type of the operation

Parameters:

path - Path to operate on

operation - to perform; may return null if it has no result

Returns:

the result of the operation

Throws:

IOException - if thrown by the operation

See Also:

withAttributeCache(IOFunction)