Package org.apache.sshd.sftp.client.fs

Class SftpFileSystem.Wrapper

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.client.subsystem.AbstractSubsystemClient

org.apache.sshd.sftp.client.impl.AbstractSftpClient

org.apache.sshd.sftp.client.fs.SftpFileSystem.Wrapper

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.Channel, ClientChannelHolder, ClientSessionHolder, SubsystemClient, ChannelHolder, NamedResource, SessionContextHolder, SessionHolder<ClientSession>, FullAccessSftpClient, RawSftpClient, SftpClient, SftpErrorDataHandler

Enclosing class:

SftpFileSystem

private final class SftpFileSystem.Wrapper
extends AbstractSftpClient

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sshd.sftp.client.SftpClient

SftpClient.Attribute, SftpClient.Attributes, SftpClient.CloseableHandle, SftpClient.CopyMode, SftpClient.DirEntry, SftpClient.Handle, SftpClient.OpenMode

Field Summary

Fields

Modifier and Type	Field	Description
private SftpClient	delegate
private java.util.concurrent.atomic.AtomicBoolean	open
private int	readSize
private int	writeSize

Fields inherited from class org.apache.sshd.sftp.client.impl.AbstractSftpClient

errorDataHandler, INIT_COMMAND_SIZE, SFTP_CLIENT_CMD_TIMEOUT

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.common.NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Fields inherited from interface org.apache.sshd.sftp.client.SftpClient

DEFAULT_CHANNEL_MODES, EMPTY_DIR_ENTRIES, IO_BUFFER_SIZE, MIN_BUFFER_SIZE, MIN_READ_BUFFER_SIZE, MIN_WRITE_BUFFER_SIZE

Fields inherited from interface org.apache.sshd.sftp.client.SftpErrorDataHandler

EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Wrapper(SftpClient delegate, SftpErrorDataHandler errorHandler, int readSize, int writeSize)

Method Summary

Modifier and Type	Method	Description
java.lang.String	canonicalPath(java.lang.String path)	The effective "normalized" remote path
void	close()
void	close(SftpClient.Handle handle)	Close the handle obtained from one of the open methods
ClientChannel	getClientChannel()
ClientSession	getClientSession()
java.nio.charset.Charset	getNameDecodingCharset()
java.util.NavigableMap<java.lang.String,byte[]>	getServerExtensions()
int	getVersion()
boolean	isClosing()
boolean	isOpen()
void	link(java.lang.String linkPath, java.lang.String targetPath, boolean symbolic)	Create a link
java.lang.Iterable<SftpClient.DirEntry>	listDir(SftpClient.Handle handle)
void	lock(SftpClient.Handle handle, long offset, long length, int mask)
SftpClient.Attributes	lstat(java.lang.String path)	Retrieve remote path meta-data - do not follow symbolic links
void	mkdir(java.lang.String path)	Create remote directory
SftpClient.CloseableHandle	open(java.lang.String path, java.util.Collection<SftpClient.OpenMode> options)	Opens a remote file with the specified mode(s)
SftpClient.CloseableHandle	openDir(java.lang.String path)	Obtain a handle for a directory
void	put(java.io.InputStream stream, java.lang.String path)
void	put(java.io.InputStream stream, java.lang.String path, java.util.Collection<SftpClient.OpenMode> modes)
void	put(java.io.InputStream stream, java.lang.String path, SftpClient.OpenMode... modes)
void	put(java.nio.file.Path localFile, java.lang.String path)
void	put(java.nio.file.Path localFile, java.lang.String path, java.util.Collection<SftpClient.OpenMode> modes)
void	put(java.nio.file.Path localFile, java.lang.String path, SftpClient.OpenMode... modes)
java.io.InputStream	read(java.lang.String path)
java.io.InputStream	read(java.lang.String path, java.util.Collection<SftpClient.OpenMode> mode)
java.io.InputStream	read(java.lang.String path, SftpClient.OpenMode... mode)
int	read(SftpClient.Handle handle, long fileOffset, byte[] dst, int dstOffset, int len)
java.util.List<SftpClient.DirEntry>	readDir(SftpClient.Handle handle)
java.util.List<SftpClient.DirEntry>	readDir(SftpClient.Handle handle, java.util.concurrent.atomic.AtomicReference<java.lang.Boolean> eolIndicator)
java.lang.String	readLink(java.lang.String path)	Retrieve target of a link
Buffer	receive(int id)
Buffer	receive(int id, long timeout)
Buffer	receive(int id, java.time.Duration timeout)
void	remove(java.lang.String path)
void	rename(java.lang.String oldPath, java.lang.String newPath, java.util.Collection<SftpClient.CopyMode> options)
void	rmdir(java.lang.String path)	Remove remote directory
int	send(int cmd, Buffer buffer)
void	setNameDecodingCharset(java.nio.charset.Charset cs)
void	setStat(java.lang.String path, SftpClient.Attributes attributes)	Update remote node meta-data
void	setStat(SftpClient.Handle handle, SftpClient.Attributes attributes)	Update remote node meta-data
SftpClient.Attributes	stat(java.lang.String path)	Retrieve remote path meta-data - follow symbolic links if encountered
SftpClient.Attributes	stat(SftpClient.Handle handle)	Retrieve file/directory handle meta-data
void	symLink(java.lang.String linkPath, java.lang.String targetPath)	Create symbolic link
void	unlock(SftpClient.Handle handle, long offset, long length)
SftpMessage	write(int cmd, Buffer buffer)
java.io.OutputStream	write(java.lang.String path)
java.io.OutputStream	write(java.lang.String path, java.util.Collection<SftpClient.OpenMode> mode)
java.io.OutputStream	write(java.lang.String path, SftpClient.OpenMode... mode)
void	write(SftpClient.Handle handle, long fileOffset, byte[] src, int srcOffset, int len)	Write data to (open) file handle

Methods inherited from class org.apache.sshd.sftp.client.impl.AbstractSftpClient

checkAttributes, checkAttributesResponse, checkCommandStatus, checkDataResponse, checkDirResponse, checkHandle, checkHandleResponse, checkOneName, checkOneNameResponse, checkResponseStatus, checkResponseStatus, errorData, getChannel, getExtension, getExtension, getParsedServerExtensions, getParsedServerExtensions, getReadBufferSize, getReferencedName, getWriteBufferSize, handleUnexpectedAttributesPacket, handleUnexpectedHandlePacket, handleUnexpectedPacket, handleUnknownDataPacket, handleUnknownDirListingPacket, handleUnknownOneNamePacket, openRemoteFileChannel, put, putReferencedName, read, read, readAttributes, readDir, response, rpc, throwStatusException, write, writeAttributes

Methods inherited from class org.apache.sshd.client.subsystem.AbstractSubsystemClient

toString

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.session.SessionHolder

getSessionContext

Methods inherited from interface org.apache.sshd.sftp.client.SftpClient

getExtension, getName, open, open, openRemoteFileChannel, openRemotePathChannel, openRemotePathChannel, put, put, put, put, put, read, read, read, read, readEntries, rename, rename, singleSessionInstance, write, write, write

Methods inherited from interface org.apache.sshd.client.subsystem.SubsystemClient

getSession

Field Detail

delegate

private final SftpClient delegate

readSize

private final int readSize

writeSize

private final int writeSize

open

private final java.util.concurrent.atomic.AtomicBoolean open

Constructor Detail

Wrapper

private Wrapper(SftpClient delegate,
                SftpErrorDataHandler errorHandler,
                int readSize,
                int writeSize)

Method Detail

getVersion

public int getVersion()

Returns:

The negotiated SFTP protocol version

getClientSession

public ClientSession getClientSession()

Returns:

The underlying ClientSession used

getClientChannel

public ClientChannel getClientChannel()

Returns:

The underlying ClientChannel used

getServerExtensions

public java.util.NavigableMap<java.lang.String,byte[]> getServerExtensions()

Returns:

An (unmodifiable) NavigableMap of the reported server extensions. where key=extension name (case insensitive)

getNameDecodingCharset

public java.nio.charset.Charset getNameDecodingCharset()

Returns:

The (never null) Charset used to decode referenced files/folders names

See Also:

SftpModuleProperties.NAME_DECODING_CHARSET

setNameDecodingCharset

public void setNameDecodingCharset(java.nio.charset.Charset cs)

isClosing

public boolean isClosing()

isOpen

public boolean isOpen()

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException

open

public SftpClient.CloseableHandle open(java.lang.String path,
                                       java.util.Collection<SftpClient.OpenMode> options)
                                throws java.io.IOException

Description copied from interface: SftpClient

Opens a remote file with the specified mode(s)

Specified by:

open in interface SftpClient

Overrides:

open in class AbstractSftpClient

Parameters:

path - The remote path

options - The desired mode - if none specified then SftpClient.OpenMode.Read is assumed

Returns:

The file's SftpClient.CloseableHandle

Throws:

java.io.IOException - If failed to open the remote file

close

public void close(SftpClient.Handle handle)
           throws java.io.IOException

Description copied from interface: SftpClient

Close the handle obtained from one of the open methods

Specified by:

close in interface SftpClient

Overrides:

close in class AbstractSftpClient

Parameters:

handle - The Handle to close

Throws:

java.io.IOException - If failed to execute

remove

public void remove(java.lang.String path)
            throws java.io.IOException

Specified by:

remove in interface SftpClient

Overrides:

remove in class AbstractSftpClient

Parameters:

path - The remote path to remove

Throws:

java.io.IOException - If failed to execute

rename

public void rename(java.lang.String oldPath,
                   java.lang.String newPath,
                   java.util.Collection<SftpClient.CopyMode> options)
            throws java.io.IOException

Specified by:

rename in interface SftpClient

Overrides:

rename in class AbstractSftpClient

Throws:

java.io.IOException

read

public int read(SftpClient.Handle handle,
                long fileOffset,
                byte[] dst,
                int dstOffset,
                int len)
         throws java.io.IOException

Throws:

java.io.IOException

write

public void write(SftpClient.Handle handle,
                  long fileOffset,
                  byte[] src,
                  int srcOffset,
                  int len)
           throws java.io.IOException

Description copied from interface: SftpClient

Write data to (open) file handle

Specified by:

write in interface SftpClient

Overrides:

write in class AbstractSftpClient

Parameters:

handle - The file SftpClient.Handle

fileOffset - Zero-based offset to write in file

src - Data buffer

srcOffset - Offset of valid data in buffer

len - Number of bytes to write

Throws:

java.io.IOException - If failed to write the data

mkdir

public void mkdir(java.lang.String path)
           throws java.io.IOException

Description copied from interface: SftpClient

Create remote directory

Specified by:

mkdir in interface SftpClient

Overrides:

mkdir in class AbstractSftpClient

Parameters:

path - Remote directory path

Throws:

java.io.IOException - If failed to execute

rmdir

public void rmdir(java.lang.String path)
           throws java.io.IOException

Description copied from interface: SftpClient

Remove remote directory

Specified by:

rmdir in interface SftpClient

Overrides:

rmdir in class AbstractSftpClient

Parameters:

path - Remote directory path

Throws:

java.io.IOException - If failed to execute

openDir

public SftpClient.CloseableHandle openDir(java.lang.String path)
                                   throws java.io.IOException

Description copied from interface: SftpClient

Obtain a handle for a directory

Specified by:

openDir in interface SftpClient

Overrides:

openDir in class AbstractSftpClient

Parameters:

path - Remote directory path

Returns:

The associated directory SftpClient.Handle

Throws:

java.io.IOException - If failed to execute

readDir

public java.util.List<SftpClient.DirEntry> readDir(SftpClient.Handle handle)
                                            throws java.io.IOException

Parameters:

handle - Directory SftpClient.Handle to read from

Returns:

A List of entries - null to indicate no more entries Note: the list may be incomplete since the client and server have some internal imposed limit on the number of entries they can process. Therefore several calls to this method may be required (until null). In order to iterate over all the entries use SftpClient.readDir(String)

Throws:

java.io.IOException - If failed to access the remote site

listDir

public java.lang.Iterable<SftpClient.DirEntry> listDir(SftpClient.Handle handle)
                                                throws java.io.IOException

Specified by:

listDir in interface SftpClient

Overrides:

listDir in class AbstractSftpClient

Parameters:

handle - A directory SftpClient.Handle

Returns:

An Iterable that can be used to iterate over all the directory entries (like SftpClient.readDir(String)). Note: the iterable instance is not re-usable - i.e., files can be iterated only once

Throws:

java.io.IOException - If failed to access the directory

canonicalPath

public java.lang.String canonicalPath(java.lang.String path)
                               throws java.io.IOException

Description copied from interface: SftpClient

The effective "normalized" remote path

Specified by:

canonicalPath in interface SftpClient

Overrides:

canonicalPath in class AbstractSftpClient

Parameters:

path - The requested path - may be relative, and/or contain dots - e.g., ".", "..", "./foo", "../bar"

Returns:

The effective "normalized" remote path

Throws:

java.io.IOException - If failed to execute

stat

public SftpClient.Attributes stat(java.lang.String path)
                           throws java.io.IOException

Description copied from interface: SftpClient

Retrieve remote path meta-data - follow symbolic links if encountered

Specified by:

stat in interface SftpClient

Overrides:

stat in class AbstractSftpClient

Parameters:

path - The remote path

Returns:

The associated SftpClient.Attributes

Throws:

java.io.IOException - If failed to execute

lstat

public SftpClient.Attributes lstat(java.lang.String path)
                            throws java.io.IOException

Description copied from interface: SftpClient

Retrieve remote path meta-data - do not follow symbolic links

Specified by:

lstat in interface SftpClient

Overrides:

lstat in class AbstractSftpClient

Parameters:

path - The remote path

Returns:

The associated SftpClient.Attributes

Throws:

java.io.IOException - If failed to execute

stat

public SftpClient.Attributes stat(SftpClient.Handle handle)
                           throws java.io.IOException

Description copied from interface: SftpClient

Retrieve file/directory handle meta-data

Specified by:

stat in interface SftpClient

Overrides:

stat in class AbstractSftpClient

Parameters:

handle - The SftpClient.Handle obtained via one of the open calls

Returns:

The associated SftpClient.Attributes

Throws:

java.io.IOException - If failed to execute

setStat

public void setStat(java.lang.String path,
                    SftpClient.Attributes attributes)
             throws java.io.IOException

Description copied from interface: SftpClient

Update remote node meta-data

Specified by:

setStat in interface SftpClient

Overrides:

setStat in class AbstractSftpClient

Parameters:

path - The remote path

attributes - The SftpClient.Attributes to update

Throws:

java.io.IOException - If failed to execute

setStat

public void setStat(SftpClient.Handle handle,
                    SftpClient.Attributes attributes)
             throws java.io.IOException

Description copied from interface: SftpClient

Update remote node meta-data

Specified by:

setStat in interface SftpClient

Overrides:

setStat in class AbstractSftpClient

Parameters:

handle - The SftpClient.Handle obtained via one of the open calls

attributes - The SftpClient.Attributes to update

Throws:

java.io.IOException - If failed to execute

readLink

public java.lang.String readLink(java.lang.String path)
                          throws java.io.IOException

Description copied from interface: SftpClient

Retrieve target of a link

Specified by:

readLink in interface SftpClient

Overrides:

readLink in class AbstractSftpClient

Parameters:

path - Remote path that represents a link

Returns:

The link target

Throws:

java.io.IOException - If failed to execute

symLink

public void symLink(java.lang.String linkPath,
                    java.lang.String targetPath)
             throws java.io.IOException

Description copied from interface: SftpClient

Create symbolic link

Parameters:

linkPath - The link location

targetPath - The referenced target by the link

Throws:

java.io.IOException - If failed to execute

See Also:

SftpClient.link(String, String, boolean)

readDir

public java.util.List<SftpClient.DirEntry> readDir(SftpClient.Handle handle,
                                                   java.util.concurrent.atomic.AtomicReference<java.lang.Boolean> eolIndicator)
                                            throws java.io.IOException

Specified by:

readDir in interface SftpClient

Overrides:

readDir in class AbstractSftpClient

Parameters:

handle - Directory SftpClient.Handle to read from

eolIndicator - An indicator that can be used to get information whether end of list has been reached - ignored if null. Upon return, set value indicates whether all entries have been exhausted - a null value means that this information cannot be provided and another call to readDir is necessary in order to verify that no more entries are pending

Returns:

A List of entries - null to indicate no more entries

Throws:

java.io.IOException - If failed to access the remote site

See Also:

SFTP v6 - section 9.4

read

public java.io.InputStream read(java.lang.String path)
                         throws java.io.IOException

Throws:

java.io.IOException

read

public java.io.InputStream read(java.lang.String path,
                                SftpClient.OpenMode... mode)
                         throws java.io.IOException

Throws:

java.io.IOException

read

public java.io.InputStream read(java.lang.String path,
                                java.util.Collection<SftpClient.OpenMode> mode)
                         throws java.io.IOException

Throws:

java.io.IOException

write

public java.io.OutputStream write(java.lang.String path)
                           throws java.io.IOException

Throws:

java.io.IOException

write

public java.io.OutputStream write(java.lang.String path,
                                  SftpClient.OpenMode... mode)
                           throws java.io.IOException

Throws:

java.io.IOException

write

public java.io.OutputStream write(java.lang.String path,
                                  java.util.Collection<SftpClient.OpenMode> mode)
                           throws java.io.IOException

Throws:

java.io.IOException

put

public void put(java.nio.file.Path localFile,
                java.lang.String path)
         throws java.io.IOException

Throws:

java.io.IOException

put

public void put(java.io.InputStream stream,
                java.lang.String path)
         throws java.io.IOException

Throws:

java.io.IOException

put

public void put(java.nio.file.Path localFile,
                java.lang.String path,
                SftpClient.OpenMode... modes)
         throws java.io.IOException

Throws:

java.io.IOException

put

public void put(java.io.InputStream stream,
                java.lang.String path,
                SftpClient.OpenMode... modes)
         throws java.io.IOException

Throws:

java.io.IOException

put

public void put(java.nio.file.Path localFile,
                java.lang.String path,
                java.util.Collection<SftpClient.OpenMode> modes)
         throws java.io.IOException

Throws:

java.io.IOException

put

public void put(java.io.InputStream stream,
                java.lang.String path,
                java.util.Collection<SftpClient.OpenMode> modes)
         throws java.io.IOException

Throws:

java.io.IOException

link

public void link(java.lang.String linkPath,
                 java.lang.String targetPath,
                 boolean symbolic)
          throws java.io.IOException

Description copied from interface: SftpClient

Create a link

Specified by:

link in interface SftpClient

Overrides:

link in class AbstractSftpClient

Parameters:

linkPath - The link location

targetPath - The referenced target by the link

symbolic - If true then make this a symbolic link, otherwise a hard one

Throws:

java.io.IOException - If failed to execute

lock

public void lock(SftpClient.Handle handle,
                 long offset,
                 long length,
                 int mask)
          throws java.io.IOException

Specified by:

lock in interface SftpClient

Overrides:

lock in class AbstractSftpClient

Throws:

java.io.IOException

unlock

public void unlock(SftpClient.Handle handle,
                   long offset,
                   long length)
            throws java.io.IOException

Specified by:

unlock in interface SftpClient

Overrides:

unlock in class AbstractSftpClient

Throws:

java.io.IOException

send

public int send(int cmd,
                Buffer buffer)
         throws java.io.IOException

Parameters:

cmd - Command to send - Note: only lower 8-bits are used

buffer - The Buffer containing the command data

Returns:

The assigned request id

Throws:

java.io.IOException - if failed to send command

write

public SftpMessage write(int cmd,
                         Buffer buffer)
                  throws java.io.IOException

Throws:

java.io.IOException

receive

public Buffer receive(int id)
               throws java.io.IOException

Parameters:

id - The expected request id

Returns:

The received response Buffer containing the request id

Throws:

java.io.IOException - If connection closed or interrupted

receive

public Buffer receive(int id,
                      long timeout)
               throws java.io.IOException

Parameters:

id - The expected request id

timeout - The amount of time to wait for the response

Returns:

The received response Buffer containing the request id

Throws:

java.io.IOException - If connection closed or interrupted

receive

public Buffer receive(int id,
                      java.time.Duration timeout)
               throws java.io.IOException

Parameters:

id - The expected request id

timeout - The amount of time to wait for the response

Returns:

The received response Buffer containing the request id

Throws:

java.io.IOException - If connection closed or interrupted