Apache Mina SSHD 2.15.0 · org.apache.sshd.sftp.client.impl.SftpPathImpl

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

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

Method Summary

Modifier and Type	Method and Description
protected void	cacheAttributes(boolean whether to start caching (increasing the cache level) or to stop caching (decreasing the cache level) doCache) `SftpPath` instances can cache SFTP `SftpClient.Attributes`.
public SftpClient.Attributes	getAttributes() Overrides org.apache.sshd.sftp.client.fs.SftpPath.getAttributes. Implements org.apache.sshd.sftp.client.fs.WithFileAttributes.getAttributes. Retrieves the `Attributes` of this object, if it has any.
public void	setAttributes(SftpClient.Attributes `SftpClient.Attributes` to set attributes) Implements org.apache.sshd.sftp.client.fs.WithFileAttributeCache.setAttributes. Sets the attributes.
public <T> T	withAttributeCache(IOFunction<Path, T> to perform; may return `null` if it has no result operation) Implements org.apache.sshd.sftp.client.fs.WithFileAttributeCache.withAttributeCache. Performs the given operation with attribute caching.

Inherited from org.apache.sshd.sftp.client.fs.SftpPath:: toRealPath

attributes	back to summary
private SftpClient.Attributes attributes

cachingLevel	back to summary
private int cachingLevel

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

Method Detail

cacheAttributes back to summary

cacheAttributes	back to summary
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:boolean whether to start caching (increasing the cache level) or to stop caching (decreasing the cache level) See Also `withAttributeCache(Path, IOFunction)`

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:boolean: whether to start caching (increasing the cache level) or to stop caching (decreasing the cache level)

See Also

withAttributeCache(Path, IOFunction)

getAttributes back to summary

getAttributes	back to summary
public SftpClient.Attributes getAttributes() Overrides org.apache.sshd.sftp.client.fs.SftpPath.getAttributes. Implements org.apache.sshd.sftp.client.fs.WithFileAttributes.getAttributes. Doc from org.apache.sshd.sftp.client.fs.WithFileAttributes.getAttributes. Retrieves the `Attributes` of this object, if it has any. Returns:SftpClient.Attributes the `Attributes` or `null` if there are none Annotations @Override

public SftpClient.Attributes getAttributes()

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

Implements org.apache.sshd.sftp.client.fs.WithFileAttributes.getAttributes.

Doc from org.apache.sshd.sftp.client.fs.WithFileAttributes.getAttributes.

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

Returns:SftpClient.Attributes

the Attributes or null if there are none

Annotations

@Override

setAttributes back to summary

setAttributes	back to summary
public void setAttributes(SftpClient.Attributes attributes) Implements org.apache.sshd.sftp.client.fs.WithFileAttributeCache.setAttributes. Doc from org.apache.sshd.sftp.client.fs.WithFileAttributeCache.setAttributes. Sets the attributes. Parameters attributes:SftpClient.Attributes `SftpClient.Attributes` to set Annotations @Override

public void setAttributes(SftpClient.Attributes attributes)

Implements org.apache.sshd.sftp.client.fs.WithFileAttributeCache.setAttributes.

Doc from org.apache.sshd.sftp.client.fs.WithFileAttributeCache.setAttributes.

Sets the attributes.

Parameters

attributes:SftpClient.Attributes: SftpClient.Attributes to set

Annotations

@Override

withAttributeCache back to summary

withAttributeCache	back to summary
public <T> T withAttributeCache(IOFunction<Path, T> operation) throws IOException Implements org.apache.sshd.sftp.client.fs.WithFileAttributeCache.withAttributeCache. Doc from org.apache.sshd.sftp.client.fs.WithFileAttributeCache.withAttributeCache. 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. Parameters <T> result type of the `operation` operation:IOFunction<Path, T> to perform; may return `null` if it has no result Returns:T the result of the `operation` Annotations @Override Exceptions IOException: if thrown by the `operation`

public <T> T withAttributeCache(IOFunction<Path, T> operation) throws IOException

Implements org.apache.sshd.sftp.client.fs.WithFileAttributeCache.withAttributeCache.

Doc from org.apache.sshd.sftp.client.fs.WithFileAttributeCache.withAttributeCache.

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.

Parameters

<T>: result type of the operation
operation:IOFunction<Path, T>: to perform; may return null if it has no result

Returns:T

the result of the operation

Annotations

@Override

Exceptions

IOException:: if thrown by the operation

public Class SftpPathImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail