Package com.sshtools.client.sftp

Class SftpChannel

java.lang.Object

com.sshtools.client.tasks.AbstractSubsystem

com.sshtools.client.sftp.SftpChannel

public class SftpChannel
extends AbstractSubsystem

Abstract task implementing SFTP operations.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_VERSION
static final int	OPEN_APPEND	File open flag, forces all writes to append data at the end of the file.
static final int	OPEN_CREATE	File open flag, if specified a new file will be created if one does not already exist.
static final int	OPEN_EXCLUSIVE	File open flag, causes an open request to fail if the named file already exists.
static final int	OPEN_READ	File open flag, opens the file for reading.
static final int	OPEN_TEXT	File open flag, causes the file to be opened in text mode.
static final int	OPEN_TRUNCATE	File open flag, forces an existing file with the same name to be truncated to zero length when creating a file by specifying OPEN_CREATE.
static final int	OPEN_WRITE	File open flag, opens the file for writing.
static final int	SSH_FXF_ACCESS_APPEND_DATA
static final int	SSH_FXF_ACCESS_APPEND_DATA_ATOMIC
static final int	SSH_FXF_ACCESS_AUDIT_ALARM_INFO
static final int	SSH_FXF_ACCESS_BACKUP
static final int	SSH_FXF_ACCESS_BLOCK_ADVISORY
static final int	SSH_FXF_ACCESS_BLOCK_DELETE
static final int	SSH_FXF_ACCESS_BLOCK_READ
static final int	SSH_FXF_ACCESS_BLOCK_WRITE
static final int	SSH_FXF_ACCESS_DISPOSITION	Version 5 new flags
static final int	SSH_FXF_ACCESS_TEXT_MODE
static final int	SSH_FXF_BACKUP_STREAM
static final int	SSH_FXF_CREATE_NEW
static final int	SSH_FXF_CREATE_TRUNCATE
static final int	SSH_FXF_DELETE_ON_CLOSE
static final int	SSH_FXF_NOFOLLOW
static final int	SSH_FXF_OPEN_EXISTING
static final int	SSH_FXF_OPEN_OR_CREATE
static final int	SSH_FXF_OVERRIDE_OWNER
static final int	SSH_FXF_TRUNCATE_EXISTING
static final int	SSH_FXP_ATTRS
static final int	SSH_FXP_DATA
static final int	SSH_FXP_EXTENDED
static final int	SSH_FXP_EXTENDED_REPLY
static final int	SSH_FXP_HANDLE
static final int	SSH_FXP_NAME
static final int	SSH_FXP_RENAME_ATOMIC
static final int	SSH_FXP_RENAME_NATIVE
static final int	SSH_FXP_RENAME_OVERWRITE
static final int	SSH_FXP_STATUS

Fields inherited from class com.sshtools.client.tasks.AbstractSubsystem

con, session, timeout

Constructor Summary

Constructors

Constructor	Description
SftpChannel(SshConnection con)

Method Summary

Modifier and Type	Method	Description
void	changePermissions(byte[] file, int permissions)	Deprecated, for removal: This API element is subject to removal in a future version.
void	changePermissions(byte[] handle, PosixPermissions permissions)	Change the permissions of a file.
void	changePermissions(String filename, int permissions)	Deprecated, for removal: This API element is subject to removal in a future version.
void	changePermissions(String filename, PosixPermissions permissions)	Change the permissions of a file.
void	changePermissions(String filename, String permissions)	Change the permissions of a file.
void	close()
void	closeFile(SftpHandle file)	Deprecated.
void	closeHandle(byte[] handle)	Deprecated.
void	createLink(String targetpath, String linkpath, boolean symbolic)	Create a symbolic link.
protected Packet	createPacket()	Get a packet from the available pool or create if non available
void	createSymbolicLink(String targetpath, String linkpath)	Create a symbolic link.
String	getAbsolutePath(SftpFile file)	Get the absolute path of a file.
String	getAbsolutePath(String path)	Get the absolute path of a file.
SftpFileAttributes	getAttributes(SftpFile file)	Deprecated, for removal: This API element is subject to removal in a future version.
SftpFileAttributes	getAttributes(String path)	Get the attributes of a file.
protected SftpFileAttributes	getAttributes(String path, int messageId, String messageName)
byte[]	getCanonicalNewline()	Returns the canonical newline convention in use when reading/writing text files.
String	getCharsetEncoding()	Get the current encoding being used for filename Strings.
SshClientContext	getContext()
String	getDefaultDirectory()	Gets the users default directory.
SftpMessage	getExtendedReply(SftpMessage bar, String path, com.sshtools.common.util.UnsignedInteger32 requestId)
SftpMessage	getExtendedReply(com.sshtools.common.util.UnsignedInteger32 requestId, String path)
byte[]	getExtension(String name)	Get the data value of a supported SFTP extension.
Map<String,byte[]>	getExtensions()
SftpFile	getFile(String path)	Utility method to obtain an SftpFile instance for a given path.
SftpHandle	getHandle(com.sshtools.common.util.UnsignedInteger32 requestId, SftpFile file)
byte[]	getHandleResponse(SftpMessage bar, SftpFile file, com.sshtools.common.util.UnsignedInteger32 requestId)
SftpFileAttributes	getLinkAttributes(String path)	Get the attributes of a file.
int	getMaximumLocalPacketLength()
com.sshtools.common.util.UnsignedInteger32	getMaximumLocalWindowSize()
protected int	getMaximumPacketSize()
int	getMaximumRemotePacketLength()
com.sshtools.common.util.UnsignedInteger32	getMaximumRemoteWindowSize()
protected com.sshtools.common.util.UnsignedInteger32	getMaximumWindowSize()
protected com.sshtools.common.util.UnsignedInteger32	getMinimumWindowSize()
void	getOKRequestStatus(com.sshtools.common.util.UnsignedInteger32 requestId, String path)	Verify that an OK status has been returned for a request id.
SftpMessage	getResponse(com.sshtools.common.util.UnsignedInteger32 requestId)
int	getServerVersion()	Version 4 of the SFTP protocol allows the server to return its maximum supported version instead of the actual version to be used.
SessionChannelNG	getSession()
SftpFile	getSingleFileResponse(SftpMessage bar, String messageName, String path, com.sshtools.common.util.UnsignedInteger32 requestId)	Get a single SftpFile object from a message returning SSH_FXP_NAME result.
String	getSymbolicLinkTarget(String linkpath)	Get the target path of a symbolic link.
int	getVersion()
boolean	isClosed()
int	listChildren(SftpFile file, List<SftpFile> children)	Deprecated, for removal: This API element is subject to removal in a future version.
void	lockFile(byte[] handle, long offset, long length, int lockFlags)	Deprecated, for removal: This API element is subject to removal in a future version.
void	makeDirectory(String path)	Make a directory.
void	makeDirectory(String path, SftpFileAttributes attrs)	Make a directory.
SftpHandle	openDirectory(String path)	Open a directory.
SftpHandle	openFile(String absolutePath, int flags)	Open a file.
SftpHandle	openFile(String path, int flags, SftpFileAttributes attrs)	Open a file.
SftpHandle	openFileVersion5(String path, int flags, int accessFlags, SftpFileAttributes attrs)
void	performOptimizedRead(String filename, byte[] handle, long length, int blocksize, OutputStream out, int outstandingRequests, FileTransferProgress progress)	Deprecated, for removal: This API element is subject to removal in a future version.
void	performOptimizedRead(String filename, byte[] handle, long length, int blocksize, OutputStream out, int outstandingRequests, FileTransferProgress progress, long position)	Deprecated, for removal: This API element is subject to removal in a future version.
void	performOptimizedWrite(String filename, byte[] handle, int blocksize, int maxAsyncRequests, InputStream in, int buffersize, FileTransferProgress progress)	Deprecated.
void	performOptimizedWrite(String filename, byte[] handle, int blocksize, int maxAsyncRequests, InputStream in, int buffersize, FileTransferProgress progress, long position)	Deprecated, for removal: This API element is subject to removal in a future version.
void	performSynchronousRead(byte[] handle, int blocksize, OutputStream out, FileTransferProgress progress, long position)	Deprecated, for removal: This API element is subject to removal in a future version.
com.sshtools.common.util.UnsignedInteger32	postReadRequest(byte[] handle, long offset, int len)	Deprecated, for removal: This API element is subject to removal in a future version.
com.sshtools.common.util.UnsignedInteger32	postWriteRequest(byte[] handle, long position, byte[] data, int off, int len)	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	processSupported(byte[] data)
protected void	processSupported2(byte[] data)
int	readFile(byte[] handle, com.sshtools.common.util.UnsignedInteger64 offset, byte[] output, int off, int len)	Deprecated, for removal: This API element is subject to removal in a future version.
void	recurseMakeDirectory(String path)	Recurse through a hierarchy of directories creating them as necessary.
void	removeDirectory(String path)	Remove an empty directory.
void	removeFile(String path)	Remove a file.
void	renameFile(String oldpath, String newpath)	Rename an existing file.
void	renameFile(String oldpath, String newpath, int flags)
com.sshtools.common.util.UnsignedInteger32	sendExtensionMessage(String request, byte[] requestData)	Send an extension message and return the response.
void	setAttributes(byte[] handle, SftpFileAttributes attrs)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setAttributes(SftpFile path, SftpFileAttributes attrs)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setAttributes(String path, SftpFileAttributes attrs)	Sets the attributes of a file.
void	setCharsetEncoding(String charset)	Allows the default character encoding to be overriden for filename strings.
boolean	supportsExtension(String name)	Does the server support an SFTP extension? This checks the extensions returned by the server during the SFTP version negotiation.
void	unlockFile(byte[] handle, long offset, long length)	Deprecated, for removal: This API element is subject to removal in a future version.
void	writeFile(byte[] handle, com.sshtools.common.util.UnsignedInteger64 offset, byte[] data, int off, int len)	Write a block of data to an open file.

Methods inherited from class com.sshtools.client.tasks.AbstractSubsystem

getConnection, nextMessage, onCloseSession, sendMessage

Methods inherited from class java.lang.Object

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

Field Details

OPEN_READ

public static final int OPEN_READ

File open flag, opens the file for reading.

See Also:

• Constant Field Values

OPEN_WRITE

public static final int OPEN_WRITE

File open flag, opens the file for writing.

See Also:

• Constant Field Values

OPEN_APPEND

public static final int OPEN_APPEND

File open flag, forces all writes to append data at the end of the file.

See Also:

• Constant Field Values

OPEN_CREATE

public static final int OPEN_CREATE

File open flag, if specified a new file will be created if one does not already exist.

See Also:

• Constant Field Values

OPEN_TRUNCATE

public static final int OPEN_TRUNCATE

File open flag, forces an existing file with the same name to be truncated to zero length when creating a file by specifying OPEN_CREATE.

See Also:

• Constant Field Values

OPEN_EXCLUSIVE

public static final int OPEN_EXCLUSIVE

File open flag, causes an open request to fail if the named file already exists. OPEN_CREATE must also be specified if this flag is used.

See Also:

• Constant Field Values

OPEN_TEXT

public static final int OPEN_TEXT

File open flag, causes the file to be opened in text mode. This instructs the server to convert the text file to the canonical newline convention in use. Any files retrieved using this mode should then be converted from the canonical newline convention to that of the clients.

See Also:

• Constant Field Values

SSH_FXP_STATUS

public static final int SSH_FXP_STATUS

See Also:

• Constant Field Values

SSH_FXP_HANDLE

public static final int SSH_FXP_HANDLE

See Also:

• Constant Field Values

SSH_FXP_DATA

public static final int SSH_FXP_DATA

See Also:

• Constant Field Values

SSH_FXP_NAME

public static final int SSH_FXP_NAME

See Also:

• Constant Field Values

SSH_FXP_ATTRS

public static final int SSH_FXP_ATTRS

See Also:

• Constant Field Values

SSH_FXP_EXTENDED

public static final int SSH_FXP_EXTENDED

See Also:

• Constant Field Values

SSH_FXP_EXTENDED_REPLY

public static final int SSH_FXP_EXTENDED_REPLY

See Also:

• Constant Field Values

MAX_VERSION

public static final int MAX_VERSION

See Also:

• Constant Field Values

SSH_FXF_ACCESS_DISPOSITION

public static final int SSH_FXF_ACCESS_DISPOSITION

Version 5 new flags

See Also:

• Constant Field Values

SSH_FXF_CREATE_NEW

public static final int SSH_FXF_CREATE_NEW

See Also:

• Constant Field Values

SSH_FXF_CREATE_TRUNCATE

public static final int SSH_FXF_CREATE_TRUNCATE

See Also:

• Constant Field Values

SSH_FXF_OPEN_EXISTING

public static final int SSH_FXF_OPEN_EXISTING

See Also:

• Constant Field Values

SSH_FXF_OPEN_OR_CREATE

public static final int SSH_FXF_OPEN_OR_CREATE

See Also:

• Constant Field Values

SSH_FXF_TRUNCATE_EXISTING

public static final int SSH_FXF_TRUNCATE_EXISTING

See Also:

• Constant Field Values

SSH_FXF_ACCESS_APPEND_DATA

public static final int SSH_FXF_ACCESS_APPEND_DATA

See Also:

• Constant Field Values

SSH_FXF_ACCESS_APPEND_DATA_ATOMIC

public static final int SSH_FXF_ACCESS_APPEND_DATA_ATOMIC

See Also:

• Constant Field Values

SSH_FXF_ACCESS_TEXT_MODE

public static final int SSH_FXF_ACCESS_TEXT_MODE

See Also:

• Constant Field Values

SSH_FXF_ACCESS_BLOCK_READ

public static final int SSH_FXF_ACCESS_BLOCK_READ

See Also:

• Constant Field Values

SSH_FXF_ACCESS_BLOCK_WRITE

public static final int SSH_FXF_ACCESS_BLOCK_WRITE

See Also:

• Constant Field Values

SSH_FXF_ACCESS_BLOCK_DELETE

public static final int SSH_FXF_ACCESS_BLOCK_DELETE

See Also:

• Constant Field Values

SSH_FXF_ACCESS_BLOCK_ADVISORY

public static final int SSH_FXF_ACCESS_BLOCK_ADVISORY

See Also:

• Constant Field Values

SSH_FXF_NOFOLLOW

public static final int SSH_FXF_NOFOLLOW

See Also:

• Constant Field Values

SSH_FXF_DELETE_ON_CLOSE

public static final int SSH_FXF_DELETE_ON_CLOSE

See Also:

• Constant Field Values

SSH_FXF_ACCESS_AUDIT_ALARM_INFO

public static final int SSH_FXF_ACCESS_AUDIT_ALARM_INFO

See Also:

• Constant Field Values

SSH_FXF_ACCESS_BACKUP

public static final int SSH_FXF_ACCESS_BACKUP

See Also:

• Constant Field Values

SSH_FXF_BACKUP_STREAM

public static final int SSH_FXF_BACKUP_STREAM

See Also:

• Constant Field Values

SSH_FXF_OVERRIDE_OWNER

public static final int SSH_FXF_OVERRIDE_OWNER

See Also:

• Constant Field Values

SSH_FXP_RENAME_OVERWRITE

public static final int SSH_FXP_RENAME_OVERWRITE

See Also:

• Constant Field Values

SSH_FXP_RENAME_ATOMIC

public static final int SSH_FXP_RENAME_ATOMIC

See Also:

• Constant Field Values

SSH_FXP_RENAME_NATIVE

public static final int SSH_FXP_RENAME_NATIVE

See Also:

• Constant Field Values

Constructor Details

SftpChannel

public SftpChannel(SshConnection con)
            throws SshException

Throws:

SshException

Method Details

getVersion

public int getVersion()

getMinimumWindowSize

protected com.sshtools.common.util.UnsignedInteger32 getMinimumWindowSize()

Specified by:

getMinimumWindowSize in class AbstractSubsystem

getMaximumWindowSize

protected com.sshtools.common.util.UnsignedInteger32 getMaximumWindowSize()

Specified by:

getMaximumWindowSize in class AbstractSubsystem

getMaximumPacketSize

protected int getMaximumPacketSize()

Specified by:

getMaximumPacketSize in class AbstractSubsystem

getExtensions

public Map<String,byte[]> getExtensions()

getSession

public SessionChannelNG getSession()

Overrides:

getSession in class AbstractSubsystem

getCanonicalNewline

public byte[] getCanonicalNewline()
                           throws SftpStatusException

Returns the canonical newline convention in use when reading/writing text files.

Returns:

String

Throws:

SftpStatusException

processSupported2

protected void processSupported2(byte[] data)
                          throws IOException

Throws:

IOException

processSupported

protected void processSupported(byte[] data)
                         throws IOException

Throws:

IOException

setCharsetEncoding

public void setCharsetEncoding(String charset)
                        throws SshException,
UnsupportedEncodingException

Allows the default character encoding to be overriden for filename strings. This method should only be called once the channel has been initialized, if the version of the protocol is less than or equal to 3 the encoding is defaulted to latin1 as no encoding is specified by the protocol. If the version is greater than 3 the default encoding will be UTF-8.

Parameters:

charset -

Throws:

UnsupportedEncodingException

SshException

getServerVersion

public int getServerVersion()

Version 4 of the SFTP protocol allows the server to return its maximum supported version instead of the actual version to be used. This method returns the value provided by the server, if the servers version is less than or equal to 3 then this method will return the protocol number in use, otherwise it returns the maximum version supported by the server.

Returns:

int

getCharsetEncoding

public String getCharsetEncoding()

Get the current encoding being used for filename Strings.

Returns:

String

supportsExtension

public boolean supportsExtension(String name)

Does the server support an SFTP extension? This checks the extensions returned by the server during the SFTP version negotiation.

Parameters:

name - String

Returns:

boolean

getExtension

public byte[] getExtension(String name)

Get the data value of a supported SFTP extension. Call supportsExtension(java.lang.String) before calling this method to determine if the extension is available.

Parameters:

name - String

Returns:

String

close

public void close()

getResponse

public SftpMessage getResponse(com.sshtools.common.util.UnsignedInteger32 requestId)
                        throws SshException

Throws:

SshException

changePermissions

@Deprecated(since="3.1.0",
            forRemoval=true)
public void changePermissions(byte[] file,
 int permissions)
                       throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Change the permissions of a file.

Parameters:

file - the file

permissions - an integer value containing a file permissions mask

Throws:

SshException - ,SftpStatusException

SftpStatusException

See Also:

• }

changePermissions

@Deprecated(since="3.1.0",
            forRemoval=true)
public void changePermissions(String filename,
 int permissions)
                       throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Change the permissions of a file.

Parameters:

filename - the path to the file.

permissions - an integer value containing a file permissions mask.

Throws:

SshException - ,SftpStatusException

SftpStatusException

See Also:

• }

changePermissions

public void changePermissions(byte[] handle,
 PosixPermissions permissions)
                       throws SftpStatusException,
SshException

Change the permissions of a file.

Parameters:

handle - the file

permissions - permissions set.

Throws:

SshException - ,SftpStatusException

SftpStatusException

changePermissions

public void changePermissions(String filename,
 PosixPermissions permissions)
                       throws SftpStatusException,
SshException

Change the permissions of a file.

Parameters:

filename - the path to the file.

permissions - permissions set.

Throws:

SshException - ,SftpStatusException

SftpStatusException

changePermissions

public void changePermissions(String filename,
 String permissions)
                       throws SftpStatusException,
SshException

Change the permissions of a file.

Parameters:

filename - the path to the file.

permissions - a string containing the permissions, for example "rw-r--r--"

Throws:

SftpStatusException - , SshException

SshException

getOKRequestStatus

public void getOKRequestStatus(com.sshtools.common.util.UnsignedInteger32 requestId,
 String path)
                        throws SftpStatusException,
SshException

Verify that an OK status has been returned for a request id.

Parameters:

requestId -

Throws:

SftpStatusException - , SshException

SshException

setAttributes

@Deprecated(since="3.1.0",
            forRemoval=true)
public void setAttributes(SftpFile path,
 SftpFileAttributes attrs)
                   throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Set the attributes of a file.

Parameters:

path - the path to the file

attrs - the file attributes

Throws:

SftpStatusException

SshException

See Also:

• SftpFile.attributes(SftpFileAttributes)

setAttributes

public void setAttributes(String path,
 SftpFileAttributes attrs)
                   throws SftpStatusException,
SshException

Sets the attributes of a file.

Parameters:

path - the path to the file.

attrs - the file attributes.

Throws:

SftpStatusException - , SshException // * @deprecated

SshException

See Also:

• SftpFile.attributes(SftpFileAttributes)

setAttributes

@Deprecated(since="3.1.0",
            forRemoval=true)
public void setAttributes(byte[] handle,
 SftpFileAttributes attrs)
                   throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Sets the attributes of a file.

Parameters:

handle - the file object.

attrs - the new attributes.

Throws:

SshException

SftpStatusException

See Also:

• SftpHandle#setAttributes(byte[], SftpFileAttributes)

postWriteRequest

@Deprecated(since="3.1.0",
            forRemoval=true)
public com.sshtools.common.util.UnsignedInteger32 postWriteRequest(byte[] handle,
 long position,
 byte[] data,
 int off,
 int len)
                                                            throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Send a write request for an open file but do not wait for the response from the server.

Parameters:

handle -

position -

data -

off -

len -

Returns:

UnsignedInteger32

Throws:

SshException

SftpStatusException

See Also:

• SftpHandle.postWriteRequest(long, byte[], int, int)

writeFile

public void writeFile(byte[] handle,
 com.sshtools.common.util.UnsignedInteger64 offset,
 byte[] data,
 int off,
 int len)
               throws SftpStatusException,
SshException

Write a block of data to an open file.

Parameters:

handle - the open file handle.

offset - the offset in the file to start writing

data - a buffer containing the data to write

off - the offset to start in the buffer

len - the length of data to write (setting to false will increase file transfer but may miss errors)

Throws:

SshException

SftpStatusException

performOptimizedWrite

public void performOptimizedWrite(String filename,
 byte[] handle,
 int blocksize,
 int maxAsyncRequests,
 InputStream in,
 int buffersize,
 FileTransferProgress progress)
                           throws SftpStatusException,
SshException,
TransferCancelledException

Deprecated.

Performs an optimized write of a file through asynchronous messaging and through buffering the local file into memory.

Parameters:

handle - the open file handle to write to

blocksize - the block size to send data, should be between 4096 and 65536

outstandingRequests - the maximum number of requests that can be outstanding at any one time

in - the InputStream to read from

buffersize - the size of the temporary buffer to read from the InputStream. Data is buffered into a temporary buffer so that the number of local filesystem reads is reducted to a minimum. This increases performance and so the buffer size should be as high as possible. The default operation, if buffersize <= 0 is to allocate a buffer the same size as the blocksize, meaning no buffer optimization is performed.

progress - provides progress information, may be null.

Throws:

SshException

SftpStatusException

TransferCancelledException

See Also:

• SftpHandle.performOptimizedWrite(String, int, int, java.io.InputStream, int, FileTransferProgress, long)

performOptimizedWrite

@Deprecated(since="3.1.0",
            forRemoval=true)
public void performOptimizedWrite(String filename,
 byte[] handle,
 int blocksize,
 int maxAsyncRequests,
 InputStream in,
 int buffersize,
 FileTransferProgress progress,
 long position)
                           throws SftpStatusException,
SshException,
TransferCancelledException

Deprecated, for removal: This API element is subject to removal in a future version.

Performs an optimized write of a file through asynchronous messaging and through buffering the local file into memory.

Parameters:

handle - the open file handle to write to

blocksize - the block size to send data, should be between 4096 and 65536

outstandingRequests - the maximum number of requests that can be outstanding at any one time

in - the InputStream to read from

buffersize - the size of the temporary buffer to read from the InputStream. Data is buffered into a temporary buffer so that the number of local filesystem reads is reducted to a minimum. This increases performance and so the buffer size should be as high as possible. The default operation, if buffersize <= 0 is to allocate a buffer the same size as the blocksize, meaning no buffer optimization is performed.

progress - provides progress information, may be null.

position - the position in the file to start writing to.

Throws:

SshException

SftpStatusException

TransferCancelledException

See Also:

• SftpHandle.performOptimizedWrite(String, int, int, java.io.InputStream, int, FileTransferProgress, long)

performOptimizedRead

@Deprecated(since="3.1.0",
            forRemoval=true)
public void performOptimizedRead(String filename,
 byte[] handle,
 long length,
 int blocksize,
 OutputStream out,
 int outstandingRequests,
 FileTransferProgress progress)
                          throws SftpStatusException,
SshException,
TransferCancelledException

Deprecated, for removal: This API element is subject to removal in a future version.

Performs an optimized read of a file through use of asynchronous messages. The total number of outstanding read requests is configurable. This should be safe on file objects as the SSH protocol states that file read operations should return the exact number of bytes requested in each request. However the server is not required to return the exact number of bytes on device files and so this method should not be used for device files.

Parameters:

handle - the open files handle

length - the length of the file

blocksize - the blocksize to read

out - an OutputStream to output the file into

outstandingRequests - the maximum number of read requests to

progress -

Throws:

SshException

SftpStatusException

TransferCancelledException

See Also:

• SftpHandle.performOptimizedRead(String, long, int, OutputStream, int, FileTransferProgress, long)

performOptimizedRead

@Deprecated(since="3.1.0",
            forRemoval=true)
public void performOptimizedRead(String filename,
 byte[] handle,
 long length,
 int blocksize,
 OutputStream out,
 int outstandingRequests,
 FileTransferProgress progress,
 long position)
                          throws SftpStatusException,
SshException,
TransferCancelledException

Deprecated, for removal: This API element is subject to removal in a future version.

Performs an optimized read of a file through use of asynchronous messages. The total number of outstanding read requests is configurable. This should be safe on file objects as the SSH protocol states that file read operations should return the exact number of bytes requested in each request. However the server is not required to return the exact number of bytes on device files and so this method should not be used for device files.

Parameters:

handle - the open files handle

length - the amount of the file file to be read, equal to the file length when reading the whole file

blocksize - the blocksize to read

out - an OutputStream to output the file into

outstandingRequests - the maximum number of read requests to

progress -

position - the postition from which to start reading the file

Throws:

SshException

SftpStatusException

TransferCancelledException

See Also:

• SftpHandle.performOptimizedRead(String, long, int, OutputStream, int, FileTransferProgress, long)

performSynchronousRead

@Deprecated(since="3.1.0",
            forRemoval=true)
public void performSynchronousRead(byte[] handle,
 int blocksize,
 OutputStream out,
 FileTransferProgress progress,
 long position)
                            throws SftpStatusException,
SshException,
TransferCancelledException

Deprecated, for removal: This API element is subject to removal in a future version.

Perform a synchronous read of a file from the remote file system. This implementation waits for acknowledgement of every data packet before requesting additional data.

Parameters:

handle -

blocksize -

out -

progress -

position -

Throws:

SftpStatusException

SshException

TransferCancelledException

See Also:

• SftpHandle.performSynchronousRead(int, OutputStream, FileTransferProgress, long)

postReadRequest

@Deprecated(since="3.1.0",
            forRemoval=true)
public com.sshtools.common.util.UnsignedInteger32 postReadRequest(byte[] handle,
 long offset,
 int len)
                                                           throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Post a read request to the server and return the request id; this is used to optimize file downloads. In normal operation the files are transfered by using a synchronous set of requests, however this slows the download as the client has to wait for the servers response before sending another request.

Parameters:

handle -

offset -

len -

Returns:

UnsignedInteger32

Throws:

SshException

SftpStatusException

See Also:

• SftpHandle.postReadRequest(long, int)

readFile

@Deprecated(since="3.1.0",
            forRemoval=true)
public int readFile(byte[] handle,
 com.sshtools.common.util.UnsignedInteger64 offset,
 byte[] output,
 int off,
 int len)
             throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Read a block of data from an open file.

Parameters:

handle - the open file handle

offset - the offset to start reading in the file

output - a buffer to write the returned data to

off - the starting offset in the output buffer

len - the length of data to read

Returns:

int

Throws:

SshException

SftpStatusException

See Also:

• SftpHandle.readFile(UnsignedInteger64, byte[], int, int)

getFile

public SftpFile getFile(String path)
                 throws SftpStatusException,
SshException

Utility method to obtain an SftpFile instance for a given path.

Parameters:

path -

Returns:

SftpFile

Throws:

SftpStatusException

SshException

getAbsolutePath

public String getAbsolutePath(SftpFile file)
                       throws SftpStatusException,
SshException

Get the absolute path of a file.

Parameters:

file -

Returns:

String

Throws:

SshException

SftpStatusException

lockFile

@Deprecated(since="3.1.0",
            forRemoval=true)
public void lockFile(byte[] handle,
 long offset,
 long length,
 int lockFlags)
              throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Lock file.

Parameters:

handle -

offset -

length -

lockFlags -

Throws:

SftpStatusException

SshException

See Also:

• SftpHandle.lock()

unlockFile

@Deprecated(since="3.1.0",
            forRemoval=true)
public void unlockFile(byte[] handle,
 long offset,
 long length)
                throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Lock file.

Parameters:

handle -

offset -

length -

lockFlags -

Throws:

SftpStatusException

SshException

See Also:

• SftpHandle.lock()

createSymbolicLink

public void createSymbolicLink(String targetpath,
 String linkpath)
                        throws SftpStatusException,
SshException

Create a symbolic link.

Parameters:

targetpath - the symbolic link to create

linkpath - the path to which the symbolic link points

Throws:

SshException - if the remote SFTP version is < 3 an exception is thrown as this feature is not supported by previous versions of the protocol.

SftpStatusException

createLink

public void createLink(String targetpath,
 String linkpath,
 boolean symbolic)
                throws SftpStatusException,
SshException

Create a symbolic link.

Parameters:

targetpath - the symbolic link to create

linkpath - the path to which the symbolic link points

Throws:

SshException - if the remote SFTP version is < 3 an exception is thrown as this feature is not supported by previous versions of the protocol.

SftpStatusException

getSymbolicLinkTarget

public String getSymbolicLinkTarget(String linkpath)
                             throws SftpStatusException,
SshException

Get the target path of a symbolic link.

Parameters:

linkpath -

Returns:

String

Throws:

SshException - if the remote SFTP version is < 3 an exception is thrown as this feature is not supported by previous versions of the protocol.

SftpStatusException

getDefaultDirectory

public String getDefaultDirectory()
                           throws SftpStatusException,
SshException

Gets the users default directory.

Returns:

String

Throws:

SshException

SftpStatusException

getAbsolutePath

public String getAbsolutePath(String path)
                       throws SftpStatusException,
SshException

Get the absolute path of a file.

Parameters:

path -

Returns:

String

Throws:

SshException

SftpStatusException

getSingleFileResponse

public SftpFile getSingleFileResponse(SftpMessage bar,
 String messageName,
 String path,
 com.sshtools.common.util.UnsignedInteger32 requestId)
                               throws SshException,
SftpStatusException

Get a single SftpFile object from a message returning SSH_FXP_NAME result.

Parameters:

bar -

messageName -

Returns:

Throws:

SshException

SftpStatusException

listChildren

@Deprecated(since="3.1.0",
            forRemoval=true)
public int listChildren(SftpFile file,
 List<SftpFile> children)
                 throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

List the children of a directory.

To use this method first open a directory with the openDirectory method and then create a Vector to store the results. To retrieve the results keep calling this method until it returns -1 which indicates no more results will be returned.

 SftpFile dir = sftp.openDirectory("code/foobar");
 Vector results = new Vector();
 while (sftp.listChildren(dir, results) > -1)
        ;
 sftp.closeFile(dir);
 

Parameters:

file -

children -

Returns:

int

Throws:

SftpStatusException - , SshException

SshException

See Also:

• SftpHandle.listChildren(List)

recurseMakeDirectory

public void recurseMakeDirectory(String path)
                          throws SftpStatusException,
SshException

Recurse through a hierarchy of directories creating them as necessary.

Parameters:

path -

Throws:

SftpStatusException - , SshException

SshException

openFile

public SftpHandle openFile(String absolutePath,
 int flags)
                    throws SftpStatusException,
SshException

Open a file.

Parameters:

absolutePath -

flags -

Returns:

SftpFile

Throws:

SftpStatusException - , SshException

SshException

openFile

public SftpHandle openFile(String path,
 int flags,
 SftpFileAttributes attrs)
                    throws SftpStatusException,
SshException

Open a file.

Parameters:

path -

flags -

attrs -

Returns:

SftpFile

Throws:

SftpStatusException - , SshException

SshException

openFileVersion5

public SftpHandle openFileVersion5(String path,
 int flags,
 int accessFlags,
 SftpFileAttributes attrs)
                            throws SftpStatusException,
SshException

Throws:

SftpStatusException

SshException

openDirectory

public SftpHandle openDirectory(String path)
                         throws SftpStatusException,
SshException

Open a directory.

Parameters:

path -

Returns:

sftpfile

Throws:

SftpStatusException - , SshException

SshException

closeHandle

@Deprecated(since="3.1.0")
public void closeHandle(byte[] handle)
                 throws SftpStatusException,
SshException

Deprecated.

Throws:

SftpStatusException

SshException

closeFile

@Deprecated
public void closeFile(SftpHandle file)
               throws IOException

Deprecated.

Close a file or directory.

Parameters:

file -

Throws:

SftpStatusException - , SshException

IOException

removeDirectory

public void removeDirectory(String path)
                     throws SftpStatusException,
SshException

Remove an empty directory.

Parameters:

path -

Throws:

SftpStatusException - , SshException

SshException

removeFile

public void removeFile(String path)
                throws SftpStatusException,
SshException

Remove a file.

Parameters:

path -

Throws:

SftpStatusException - , SshException

SshException

renameFile

public void renameFile(String oldpath,
 String newpath)
                throws SftpStatusException,
SshException

Rename an existing file.

Parameters:

oldpath -

newpath -

Throws:

SftpStatusException - , SshException

SshException

renameFile

public void renameFile(String oldpath,
 String newpath,
 int flags)
                throws SftpStatusException,
SshException

Throws:

SftpStatusException

SshException

getAttributes

public SftpFileAttributes getAttributes(String path)
                                 throws SftpStatusException,
SshException

Get the attributes of a file. This method follows symbolic links

Parameters:

path -

Returns:

SftpFileAttributes

Throws:

SshException

SftpStatusException

getLinkAttributes

public SftpFileAttributes getLinkAttributes(String path)
                                     throws SftpStatusException,
SshException

Get the attributes of a file. This method does not follow symbolic links so will return the attributes of an actual link, not its target.

Parameters:

path -

Returns:

Throws:

SftpStatusException

SshException

getAttributes

protected SftpFileAttributes getAttributes(String path,
 int messageId,
 String messageName)
                                    throws SftpStatusException,
SshException

Throws:

SftpStatusException

SshException

getAttributes

@Deprecated(since="3.1.0",
            forRemoval=true)
public SftpFileAttributes getAttributes(SftpFile file)
                                 throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Get the attributes of a file.

Parameters:

file -

Returns:

SftpFileAttributes

Throws:

SftpStatusException - , SshException

SshException

See Also:

• SftpHandle#setAttributes(byte[], SftpFileAttributes)

makeDirectory

public void makeDirectory(String path)
                   throws SftpStatusException,
SshException

Make a directory. If the directory exists this method will throw an exception.

Parameters:

path -

Throws:

SftpStatusException - , SshException

SshException

makeDirectory

public void makeDirectory(String path,
 SftpFileAttributes attrs)
                   throws SftpStatusException,
SshException

Make a directory. If the directory exists this method will throw an exception.

Parameters:

path -

attrs -

Throws:

SftpStatusException - , SshException

SshException

getExtendedReply

public SftpMessage getExtendedReply(com.sshtools.common.util.UnsignedInteger32 requestId,
 String path)
                             throws SftpStatusException,
SshException

Throws:

SftpStatusException

SshException

getExtendedReply

public SftpMessage getExtendedReply(SftpMessage bar,
 String path,
 com.sshtools.common.util.UnsignedInteger32 requestId)
                             throws SftpStatusException,
SshException

Throws:

SftpStatusException

SshException

getHandle

public SftpHandle getHandle(com.sshtools.common.util.UnsignedInteger32 requestId,
 SftpFile file)
                     throws SftpStatusException,
SshException

Throws:

SftpStatusException

SshException

getHandleResponse

public byte[] getHandleResponse(SftpMessage bar,
 SftpFile file,
 com.sshtools.common.util.UnsignedInteger32 requestId)
                         throws SftpStatusException,
SshException

Throws:

SftpStatusException

SshException

sendExtensionMessage

public com.sshtools.common.util.UnsignedInteger32 sendExtensionMessage(String request,
 byte[] requestData)
                                                                throws SshException,
SftpStatusException

Send an extension message and return the response. This is for advanced use only.

Parameters:

request - String

requestData - byte[]

Returns:

SftpMessage

Throws:

SshException

SftpStatusException

createPacket

protected Packet createPacket()
                       throws IOException

Get a packet from the available pool or create if non available

Returns:

Packet

Throws:

IOException

isClosed

public boolean isClosed()

getMaximumLocalWindowSize

public com.sshtools.common.util.UnsignedInteger32 getMaximumLocalWindowSize()

getMaximumLocalPacketLength

public int getMaximumLocalPacketLength()

getMaximumRemoteWindowSize

public com.sshtools.common.util.UnsignedInteger32 getMaximumRemoteWindowSize()

getMaximumRemotePacketLength

public int getMaximumRemotePacketLength()

getContext

public SshClientContext getContext()