Package 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:

java.lang.Comparable<java.nio.file.Path>, java.lang.Iterable<java.nio.file.Path>, java.nio.file.Path, java.nio.file.Watchable, WithFileAttributeCache, WithFileAttributes

public class SftpPathImpl
extends SftpPath
implements WithFileAttributeCache

An SftpPath that can cache SftpClient.Attributes.

Field Summary

Fields

Modifier and Type	Field	Description
private SftpClient.Attributes	attributes
private int	cachingLevel

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

names, root

Constructor Summary

Constructors

Constructor	Description
SftpPathImpl(SftpFileSystem fileSystem, java.lang.String root, java.util.List<java.lang.String> names)

Method Summary

Modifier and Type	Method	Description
protected void	cacheAttributes(boolean doCache)	SftpPath instances can cache SFTP SftpClient.Attributes.
SftpClient.Attributes	getAttributes()	Retrieves the SftpClient.Attributes of this object, if it has any.
void	setAttributes(SftpClient.Attributes attributes)	Sets the attributes.
<T> T	withAttributeCache(IOFunction<java.nio.file.Path,T> operation)	Performs the given operation with attribute caching.

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

Field Detail

attributes

private SftpClient.Attributes attributes

cachingLevel

private int cachingLevel

Constructor Detail

SftpPathImpl

public SftpPathImpl(SftpFileSystem fileSystem,
                    java.lang.String root,
                    java.util.List<java.lang.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 WithFileAttributeCache.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:

WithFileAttributeCache.withAttributeCache(Path, IOFunction)

setAttributes

public void setAttributes(SftpClient.Attributes attributes)

Description copied from interface: WithFileAttributeCache

Sets the attributes.

Specified by:

setAttributes in interface WithFileAttributeCache

Parameters:

attributes - SftpClient.Attributes to set

getAttributes

public SftpClient.Attributes getAttributes()

Description copied from interface: WithFileAttributes

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

Specified by:

getAttributes in interface WithFileAttributes

Overrides:

getAttributes in class SftpPath

Returns:

the SftpClient.Attributes or null if there are none

withAttributeCache

public <T> T withAttributeCache(IOFunction<java.nio.file.Path,T> operation)
                         throws java.io.IOException

Description copied from interface: WithFileAttributeCache

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 WithFileAttributeCache.withAttributeCache(IOFunction) may be nested. The cache is cleared at the start and at the end of the outermost invocation.

Specified by:

withAttributeCache in interface WithFileAttributeCache

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:

java.io.IOException - if thrown by the operation