org.apache.sshd.client.subsystem.sftp.impl

Class AbstractSftpClient

java.lang.Object

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

org.apache.sshd.client.subsystem.AbstractSubsystemClient

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultSftpClient, SftpFileSystem.Wrapper

public abstract class AbstractSftpClient
extends AbstractSubsystemClient
implements SftpClient, RawSftpClient

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_WRITE_CHUNK_SIZE Default value for "sftp-client-write-chunk-size"
private SftpClient.Attributes	fileOpenAttributes
static int	INIT_COMMAND_SIZE
private java.util.concurrent.atomic.AtomicReference<java.util.Map<java.lang.String,java.lang.Object>>	parsedExtensionsHolder
static java.lang.String	WRITE_CHUNK_SIZE Property used to avoid large buffers when SftpClient.write(Handle, long, byte[], int, int) is invoked with a large buffer size.

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

log

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

DEFAULT_CHANNEL_MODES, DEFAULT_CHANNEL_OPEN_TIMEOUT, DEFAULT_NAME_DECODING_CHARSET, DEFAULT_WAIT_TIMEOUT, EMPTY_DIR_ENTRIES, IO_BUFFER_SIZE, MIN_BUFFER_SIZE, MIN_READ_BUFFER_SIZE, MIN_WRITE_BUFFER_SIZE, NAME_DECODING_CHARSET, SFTP_CHANNEL_OPEN_TIMEOUT

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

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSftpClient()

Method Summary

Modifier and Type	Method and Description
java.lang.String	canonicalPath(java.lang.String path) The effective "normalized" remote path
protected SftpClient.Attributes	checkAttributes(int cmd, Buffer request)
protected SftpClient.Attributes	checkAttributesResponse(int cmd, Buffer buffer)
protected void	checkCommandStatus(int cmd, Buffer request) Sends the specified command, waits for the response and then invokes checkResponseStatus(int, Buffer)
protected int	checkData(int cmd, Buffer request, int dstOffset, byte[] dst, java.util.concurrent.atomic.AtomicReference<java.lang.Boolean> eofSignalled)
protected int	checkDataResponse(int cmd, Buffer buffer, int dstoff, byte[] dst, java.util.concurrent.atomic.AtomicReference<java.lang.Boolean> eofSignalled)
protected java.util.List<SftpClient.DirEntry>	checkDirResponse(int cmd, Buffer buffer, java.util.concurrent.atomic.AtomicReference<java.lang.Boolean> eolIndicator)
protected byte[]	checkHandle(int cmd, Buffer request)
protected byte[]	checkHandleResponse(int cmd, Buffer buffer)
protected java.lang.String	checkOneName(int cmd, Buffer request)
protected java.lang.String	checkOneNameResponse(int cmd, Buffer buffer)
protected void	checkResponseStatus(int cmd, Buffer buffer) Checks if the incoming response is an SSH_FXP_STATUS one, and if so whether the substatus is SSH_FX_OK.
protected void	checkResponseStatus(int cmd, int id, int substatus, java.lang.String msg, java.lang.String lang)
void	close(SftpClient.Handle handle) Close the handle obtained from one of the open methods
Channel	getChannel()
<E extends SftpClientExtension> E	getExtension(java.lang.Class<? extends E> extensionType)
protected SftpClientExtension	getExtension(SftpClientExtensionFactory factory)
SftpClientExtension	getExtension(java.lang.String extensionName)
protected java.util.Map<java.lang.String,java.lang.Object>	getParsedServerExtensions()
protected java.util.Map<java.lang.String,java.lang.Object>	getParsedServerExtensions(java.util.Map<java.lang.String,byte[]> extensions)
protected int	getReadBufferSize()
protected java.lang.String	getReferencedName(int cmd, Buffer buf, int nameIndex)
protected int	getWriteBufferSize()
protected SftpClient.Attributes	handleUnexpectedAttributesPacket(int cmd, int id, int type, int length, Buffer buffer)
protected byte[]	handleUnexpectedHandlePacket(int cmd, int id, int type, int length, Buffer buffer)
protected java.io.IOException	handleUnexpectedPacket(int cmd, int expected, int id, int type, int length, Buffer buffer)
protected int	handleUnknownDataPacket(int cmd, int id, int type, int length, Buffer buffer)
protected java.util.List<SftpClient.DirEntry>	handleUnknownDirListingPacket(int cmd, int id, int type, int length, Buffer buffer)
protected java.lang.String	handleUnknownOneNamePacket(int cmd, int id, int type, int length, Buffer buffer)
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
java.nio.channels.FileChannel	openRemoteFileChannel(java.lang.String path, java.util.Collection<SftpClient.OpenMode> modes) Opens an FileChannel on the specified remote path
protected <B extends Buffer> B	putReferencedName(int cmd, B buf, java.lang.String name, int nameIndex)
int	read(SftpClient.Handle handle, long fileOffset, byte[] dst, int dstOffset, int len, java.util.concurrent.atomic.AtomicReference<java.lang.Boolean> eofSignalled) Reads data from the open (file) handle
java.io.InputStream	read(java.lang.String path, java.util.Collection<SftpClient.OpenMode> mode)
java.io.InputStream	read(java.lang.String path, int bufferSize, java.util.Collection<SftpClient.OpenMode> mode) Read a remote file's data via an input stream
protected SftpClient.Attributes	readAttributes(int cmd, Buffer buffer, java.util.concurrent.atomic.AtomicInteger nameIndex)
java.util.List<SftpClient.DirEntry>	readDir(SftpClient.Handle handle, java.util.concurrent.atomic.AtomicReference<java.lang.Boolean> eolIndicator)
java.lang.Iterable<SftpClient.DirEntry>	readDir(java.lang.String path)
java.lang.String	readLink(java.lang.String path) Retrieve target of a link
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
void	setStat(SftpClient.Handle handle, SftpClient.Attributes attributes) Update remote node meta-data
void	setStat(java.lang.String path, SftpClient.Attributes attributes) Update remote node meta-data
SftpClient.Attributes	stat(SftpClient.Handle handle) Retrieve file/directory handle meta-data
SftpClient.Attributes	stat(java.lang.String path) Retrieve remote path meta-data - follow symbolic links if encountered
protected void	throwStatusException(int cmd, int id, int substatus, java.lang.String msg, java.lang.String lang)
void	unlock(SftpClient.Handle handle, long offset, long length)
protected void	validateIncomingResponse(int cmd, int id, int type, int length, Buffer buffer)
void	write(SftpClient.Handle handle, long fileOffset, byte[] src, int srcOffset, int len) Write data to (open) file handle
java.io.OutputStream	write(java.lang.String path, java.util.Collection<SftpClient.OpenMode> mode)
java.io.OutputStream	write(java.lang.String path, int bufferSize, java.util.Collection<SftpClient.OpenMode> mode) Write to a remote file via an output stream
protected <B extends Buffer> B	writeAttributes(int cmd, B buffer, SftpClient.Attributes attributes)

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

toString

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

getSimplifiedLogger

Methods inherited from class java.lang.Object

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

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

getName, getNameDecodingCharset, getServerExtensions, getVersion, isClosing, open, open, openRemoteFileChannel, openRemotePathChannel, openRemotePathChannel, read, read, read, read, read, read, read, readDir, rename, rename, setNameDecodingCharset, symLink, write, write, write, write, write

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

getSession

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

getSessionContext

Methods inherited from interface org.apache.sshd.client.session.ClientSessionHolder

getClientSession

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

findByName, getNameList, getNames, ofName, removeByName

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Methods inherited from interface org.apache.sshd.client.channel.ClientChannelHolder

getClientChannel

Methods inherited from interface org.apache.sshd.client.subsystem.sftp.RawSftpClient

receive, receive, send

Field Detail

INIT_COMMAND_SIZE

public static final int INIT_COMMAND_SIZE

See Also:

Constant Field Values

WRITE_CHUNK_SIZE

public static final java.lang.String WRITE_CHUNK_SIZE

Property used to avoid large buffers when SftpClient.write(Handle, long, byte[], int, int) is invoked with a large buffer size.

See Also:

Constant Field Values

DEFAULT_WRITE_CHUNK_SIZE

public static final int DEFAULT_WRITE_CHUNK_SIZE

Default value for "sftp-client-write-chunk-size"

See Also:

Constant Field Values

fileOpenAttributes

private final SftpClient.Attributes fileOpenAttributes

parsedExtensionsHolder

private final java.util.concurrent.atomic.AtomicReference<java.util.Map<java.lang.String,java.lang.Object>> parsedExtensionsHolder

Constructor Detail

AbstractSftpClient

protected AbstractSftpClient()

Method Detail

getChannel

public Channel getChannel()

Specified by:

getChannel in interface ClientChannelHolder

Specified by:

getChannel in interface ChannelHolder

Returns:

The associated Channel instance

getExtension

public <E extends SftpClientExtension> E getExtension(java.lang.Class<? extends E> extensionType)

Specified by:

getExtension in interface SftpClient

Type Parameters:

E - The generic extension type

Parameters:

extensionType - The extension type

Returns:

The extension instance - Note: it is up to the caller to invoke OptionalFeature.isSupported() - null if this extension type is not implemented by the client

See Also:

SftpClient.getServerExtensions()

getExtension

public SftpClientExtension getExtension(java.lang.String extensionName)

Specified by:

getExtension in interface SftpClient

Parameters:

extensionName - The extension name

Returns:

The extension instance - Note: it is up to the caller to invoke OptionalFeature.isSupported() - null if this extension type is not implemented by the client

See Also:

SftpClient.getServerExtensions()

getExtension

protected SftpClientExtension getExtension(SftpClientExtensionFactory factory)

getParsedServerExtensions

protected java.util.Map<java.lang.String,java.lang.Object> getParsedServerExtensions()

getParsedServerExtensions

protected java.util.Map<java.lang.String,java.lang.Object> getParsedServerExtensions(java.util.Map<java.lang.String,byte[]> extensions)

getReferencedName

protected java.lang.String getReferencedName(int cmd,
                                             Buffer buf,
                                             int nameIndex)

Parameters:

cmd - The command that was sent whose response contains the name to be decoded

buf - The Buffer containing the encoded name

nameIndex - The zero-based order of the requested names for the command - e.g.,

• When listing a directory's contents each successive name will have an increasing index.
• For SFTP version 3, when retrieving a single name, short name will have index=0 and the long one index=1.

Returns:

The decoded referenced name

putReferencedName

protected <B extends Buffer> B putReferencedName(int cmd,
                                                 B buf,
                                                 java.lang.String name,
                                                 int nameIndex)

Type Parameters:

B - Type of Buffer being updated

Parameters:

cmd - The command for which this name is being added

buf - The buffer instance to update

name - The name to place in the buffer

nameIndex - The zero-based order of the name for the specific command if more than one name required - e.g., rename, link/symbolic link

Returns:

The updated buffer

checkCommandStatus

protected void checkCommandStatus(int cmd,
                                  Buffer request)
                           throws java.io.IOException

Sends the specified command, waits for the response and then invokes checkResponseStatus(int, Buffer)

Parameters:

cmd - The command to send

request - The request Buffer

Throws:

java.io.IOException - If failed to send, receive or check the returned status

See Also:

RawSftpClient.send(int, Buffer), RawSftpClient.receive(int), checkResponseStatus(int, Buffer)

checkResponseStatus

protected void checkResponseStatus(int cmd,
                                   Buffer buffer)
                            throws java.io.IOException

Checks if the incoming response is an SSH_FXP_STATUS one, and if so whether the substatus is SSH_FX_OK.

Parameters:

cmd - The sent command opcode

buffer - The received response Buffer

Throws:

java.io.IOException - If response does not carry a status or carries a bad status code

See Also:

checkResponseStatus(int, int, int, String, String)

checkResponseStatus

protected void checkResponseStatus(int cmd,
                                   int id,
                                   int substatus,
                                   java.lang.String msg,
                                   java.lang.String lang)
                            throws java.io.IOException

Parameters:

cmd - The sent command opcode

id - The request id

substatus - The sub-status value

msg - The message

lang - The language

Throws:

java.io.IOException - if the sub-status is not SSH_FX_OK

See Also:

throwStatusException(int, int, int, String, String)

throwStatusException

protected void throwStatusException(int cmd,
                                    int id,
                                    int substatus,
                                    java.lang.String msg,
                                    java.lang.String lang)
                             throws java.io.IOException

Throws:

java.io.IOException

checkHandle

protected byte[] checkHandle(int cmd,
                             Buffer request)
                      throws java.io.IOException

Parameters:

cmd - Command to be sent

request - The Buffer containing the request

Returns:

The received handle identifier

Throws:

java.io.IOException - If failed to send/receive or process the response

See Also:

RawSftpClient.send(int, Buffer), RawSftpClient.receive(int), checkHandleResponse(int, Buffer)

checkHandleResponse

protected byte[] checkHandleResponse(int cmd,
                                     Buffer buffer)
                              throws java.io.IOException

Throws:

java.io.IOException

handleUnexpectedHandlePacket

protected byte[] handleUnexpectedHandlePacket(int cmd,
                                              int id,
                                              int type,
                                              int length,
                                              Buffer buffer)
                                       throws java.io.IOException

Throws:

java.io.IOException

checkAttributes

protected SftpClient.Attributes checkAttributes(int cmd,
                                                Buffer request)
                                         throws java.io.IOException

Parameters:

cmd - Command to be sent

request - Request Buffer

Returns:

The decoded response Attributes

Throws:

java.io.IOException - If failed to send/receive or process the response

See Also:

RawSftpClient.send(int, Buffer), RawSftpClient.receive(int), checkAttributesResponse(int, Buffer)

checkAttributesResponse

protected SftpClient.Attributes checkAttributesResponse(int cmd,
                                                        Buffer buffer)
                                                 throws java.io.IOException

Throws:

java.io.IOException

handleUnexpectedAttributesPacket

protected SftpClient.Attributes handleUnexpectedAttributesPacket(int cmd,
                                                                 int id,
                                                                 int type,
                                                                 int length,
                                                                 Buffer buffer)
                                                          throws java.io.IOException

Throws:

java.io.IOException

checkOneName

protected java.lang.String checkOneName(int cmd,
                                        Buffer request)
                                 throws java.io.IOException

Parameters:

cmd - Command to be sent

request - The request Buffer

Returns:

The retrieved name

Throws:

java.io.IOException - If failed to send/receive or process the response

See Also:

RawSftpClient.send(int, Buffer), RawSftpClient.receive(int), checkOneNameResponse(int, Buffer)

checkOneNameResponse

protected java.lang.String checkOneNameResponse(int cmd,
                                                Buffer buffer)
                                         throws java.io.IOException

Throws:

java.io.IOException

handleUnknownOneNamePacket

protected java.lang.String handleUnknownOneNamePacket(int cmd,
                                                      int id,
                                                      int type,
                                                      int length,
                                                      Buffer buffer)
                                               throws java.io.IOException

Throws:

java.io.IOException

readAttributes

protected SftpClient.Attributes readAttributes(int cmd,
                                               Buffer buffer,
                                               java.util.concurrent.atomic.AtomicInteger nameIndex)
                                        throws java.io.IOException

Throws:

java.io.IOException

writeAttributes

protected <B extends Buffer> B writeAttributes(int cmd,
                                               B buffer,
                                               SftpClient.Attributes attributes)
                                        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

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

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

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

Throws:

java.io.IOException

read

public int read(SftpClient.Handle handle,
                long fileOffset,
                byte[] dst,
                int dstOffset,
                int len,
                java.util.concurrent.atomic.AtomicReference<java.lang.Boolean> eofSignalled)
         throws java.io.IOException

Description copied from interface: SftpClient

Reads data from the open (file) handle

Specified by:

read in interface SftpClient

Parameters:

handle - The file SftpClient.Handle to read from

fileOffset - The file offset to read from

dst - The destination buffer

dstOffset - Offset in destination buffer to place the read data

len - Available destination buffer size to read

eofSignalled - If not null then upon return holds a value indicating whether EOF was reached due to the read. If null indicator value then this indication is not available

Returns:

Number of read bytes - -1 if EOF reached

Throws:

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

See Also:

SFTP v6 - section 9.3

checkData

protected int checkData(int cmd,
                        Buffer request,
                        int dstOffset,
                        byte[] dst,
                        java.util.concurrent.atomic.AtomicReference<java.lang.Boolean> eofSignalled)
                 throws java.io.IOException

Throws:

java.io.IOException

checkDataResponse

protected int checkDataResponse(int cmd,
                                Buffer buffer,
                                int dstoff,
                                byte[] dst,
                                java.util.concurrent.atomic.AtomicReference<java.lang.Boolean> eofSignalled)
                         throws java.io.IOException

Throws:

java.io.IOException

handleUnknownDataPacket

protected int handleUnknownDataPacket(int cmd,
                                      int id,
                                      int type,
                                      int length,
                                      Buffer buffer)
                               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

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

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

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

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,
                                                   java.util.concurrent.atomic.AtomicReference<java.lang.Boolean> eolIndicator)
                                            throws java.io.IOException

Specified by:

readDir in interface SftpClient

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

checkDirResponse

protected java.util.List<SftpClient.DirEntry> checkDirResponse(int cmd,
                                                               Buffer buffer,
                                                               java.util.concurrent.atomic.AtomicReference<java.lang.Boolean> eolIndicator)
                                                        throws java.io.IOException

Throws:

java.io.IOException

validateIncomingResponse

protected void validateIncomingResponse(int cmd,
                                        int id,
                                        int type,
                                        int length,
                                        Buffer buffer)
                                 throws java.io.IOException

Throws:

java.io.IOException

handleUnknownDirListingPacket

protected java.util.List<SftpClient.DirEntry> handleUnknownDirListingPacket(int cmd,
                                                                            int id,
                                                                            int type,
                                                                            int length,
                                                                            Buffer buffer)
                                                                     throws java.io.IOException

Throws:

java.io.IOException

handleUnexpectedPacket

protected java.io.IOException handleUnexpectedPacket(int cmd,
                                                     int expected,
                                                     int id,
                                                     int type,
                                                     int length,
                                                     Buffer buffer)
                                              throws java.io.IOException

Parameters:

cmd - The initial command sent

expected - The expected packet type

id - The reported identifier

type - The reported SFTP response type

length - The packet length

buffer - The Buffer after reading from it whatever data led to this call

Returns:

The exception to throw - if null then implementor assumed to handle the exception internal. Otherwise, the exception is re-thrown

Throws:

java.io.IOException - If failed to handle the exception internally

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

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

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

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

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

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

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

Parameters:

path - Remote path that represents a link

Returns:

The link target

Throws:

java.io.IOException - If failed to execute

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

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

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

Throws:

java.io.IOException

readDir

public java.lang.Iterable<SftpClient.DirEntry> readDir(java.lang.String path)
                                                throws java.io.IOException

Specified by:

readDir in interface SftpClient

Parameters:

path - The remote directory path

Returns:

An Iterable that can be used to iterate over all the directory entries (unlike SftpClient.readDir(Handle))

Throws:

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

See Also:

SftpClient.readDir(Handle)

listDir

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

Specified by:

listDir in interface SftpClient

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

openRemoteFileChannel

public java.nio.channels.FileChannel openRemoteFileChannel(java.lang.String path,
                                                           java.util.Collection<SftpClient.OpenMode> modes)
                                                    throws java.io.IOException

Description copied from interface: SftpClient

Opens an FileChannel on the specified remote path

Specified by:

openRemoteFileChannel in interface SftpClient

Parameters:

path - The remote path

modes - The access mode(s) - if null/empty then the SftpClient.DEFAULT_CHANNEL_MODES are used

Returns:

The open FileChannel - Note: do not close this owner client instance until the channel is no longer needed since it uses the client for providing the channel's functionality.

Throws:

java.io.IOException - If failed to open the channel

See Also:

Channels.newInputStream(java.nio.channels.ReadableByteChannel), Channels.newOutputStream(java.nio.channels.WritableByteChannel)

read

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

Description copied from interface: SftpClient

Read a remote file's data via an input stream

Specified by:

read in interface SftpClient

Parameters:

path - The remote file path

bufferSize - The internal read buffer size

mode - The remote file SftpClient.OpenModes

Returns:

An InputStream for reading the remote file data

Throws:

java.io.IOException - If failed to execute

read

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

Specified by:

read in interface SftpClient

Throws:

java.io.IOException

write

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

Description copied from interface: SftpClient

Write to a remote file via an output stream

Specified by:

write in interface SftpClient

Parameters:

path - The remote file path

bufferSize - The internal write buffer size

mode - The remote file SftpClient.OpenModes

Returns:

An OutputStream for writing the data

Throws:

java.io.IOException - If failed to execute

write

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

Specified by:

write in interface SftpClient

Throws:

java.io.IOException

getReadBufferSize

protected int getReadBufferSize()

getWriteBufferSize

protected int getWriteBufferSize()