Package com.sshtools.common.sftp

Class SftpSubsystem

java.lang.Object

com.sshtools.common.ssh.Subsystem

com.sshtools.common.sftp.SftpSubsystem

All Implemented Interfaces:

SftpSpecification

public class SftpSubsystem
extends Subsystem
implements SftpSpecification

This class provides the SFTP subsystem. The subsystem obtains an instance of the configured com.sshtools.common.sftp.FileSystem to serve files through the SFTP protocol. This implementation currently supports up to version 3 of the protocol.

Author:

Lee David Painter

Field Summary

Fields

Modifier and Type	Field	Description
static final Integer	SFTP_QUEUE
static final String	SUBSYSTEM_NAME

Fields inherited from class com.sshtools.common.ssh.Subsystem

context, session, SUBSYSTEM_INCOMING, SUBSYSTEM_OUTGOING

Fields inherited from interface com.sshtools.common.sftp.SftpSpecification

SSH_FX_BYTE_RANGE_LOCK_CONFLICT, SSH_FX_BYTE_RANGE_LOCK_REFUSED, SSH_FX_CANNOT_DELETE, SSH_FX_DELETE_PENDING, SSH_FX_DIR_NOT_EMPTY, SSH_FX_FILE_ALREADY_EXISTS, SSH_FX_FILE_CORRUPT, SSH_FX_FILE_IS_A_DIRECTORY, SSH_FX_GROUP_INVALID, SSH_FX_INVALID_FILENAME, SSH_FX_INVALID_HANDLE, SSH_FX_INVALID_PARAMETER, SSH_FX_LINK_LOOP, SSH_FX_LOCK_CONFLICT, SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK, SSH_FX_NO_MEDIA, SSH_FX_NO_SPACE_ON_FILESYSTEM, SSH_FX_NO_SUCH_PATH, SSH_FX_NOT_A_DIRECTORY, SSH_FX_OWNER_INVALID, SSH_FX_QUOTA_EXCEEDED, SSH_FX_UNKNOWN_PRINCIPAL, SSH_FX_WRITE_PROTECT, SSH_FXF_ACCESS_APPEND_DATA, SSH_FXF_ACCESS_APPEND_DATA_ATOMIC, SSH_FXF_ACCESS_AUDIT_ALARM_INFO, SSH_FXF_ACCESS_BACKUP, SSH_FXF_ACCESS_BLOCK_ADVISORY, SSH_FXF_ACCESS_BLOCK_DELETE, SSH_FXF_ACCESS_BLOCK_READ, SSH_FXF_ACCESS_BLOCK_WRITE, SSH_FXF_ACCESS_DISPOSITION, SSH_FXF_ACCESS_TEXT_MODE, SSH_FXF_BACKUP_STREAM, SSH_FXF_CREATE_NEW, SSH_FXF_CREATE_TRUNCATE, SSH_FXF_DELETE_ON_CLOSE, SSH_FXF_NOFOLLOW, SSH_FXF_OPEN_EXISTING, SSH_FXF_OPEN_OR_CREATE, SSH_FXF_OVERRIDE_OWNER, SSH_FXF_TRUNCATE_EXISTING, SSH_FXP_ATTRS, SSH_FXP_BLOCK, SSH_FXP_CLOSE, SSH_FXP_DATA, SSH_FXP_EXTENDED, SSH_FXP_EXTENDED_REPLY, SSH_FXP_FSETSTAT, SSH_FXP_FSTAT, SSH_FXP_HANDLE, SSH_FXP_INIT, SSH_FXP_LINK, SSH_FXP_LSTAT, SSH_FXP_MKDIR, SSH_FXP_NAME, SSH_FXP_OPEN, SSH_FXP_OPENDIR, SSH_FXP_READ, SSH_FXP_READDIR, SSH_FXP_READLINK, SSH_FXP_REALPATH, SSH_FXP_REMOVE, SSH_FXP_RENAME, SSH_FXP_RMDIR, SSH_FXP_SETSTAT, SSH_FXP_STAT, SSH_FXP_STATUS, SSH_FXP_SYMLINK, SSH_FXP_UNBLOCK, SSH_FXP_VERSION, SSH_FXP_WRITE, STATUS_FX_EOF, STATUS_FX_FAILURE, STATUS_FX_NO_SUCH_FILE, STATUS_FX_OK, STATUS_FX_OP_UNSUPPORTED, STATUS_FX_PERMISSION_DENIED

Constructor Summary

Constructors

Constructor	Description
SftpSubsystem()

Method Summary

Modifier and Type	Method	Description
void	addTransferEvent(String handle, TransferEvent evt)
void	addWrapper(SftpOperationWrapper wrapper)
String	checkDefaultPath(String path)
protected void	cleanupSubsystem()
protected void	fireCloseFileEvent(byte[] handle, Exception error)
protected void	fireCloseFileEvent(TransferEvent evt, Exception error)
void	fireEvent(Event event)
protected void	fireMakeDirectoryEvent(String path, Date started, Exception error)
protected void	fireOpenDirectoryEvent(String path, Date started, byte[] handle, Exception error)
protected void	fireOpenFileEvent(com.sshtools.common.util.UnsignedInteger32 flags, SftpFileAttributes attrs, String path, Date started, byte[] handle, Exception error)
protected void	fireOpenInitEvent(com.sshtools.common.util.UnsignedInteger32 flags, SftpFileAttributes attrs, String path, Date started, Exception error)
protected void	fireRemoveFileEvent(String path, Date started, Exception error)
protected void	fireRenameFileEvent(String oldpath, String newpath, Date started, Exception error)
protected void	fireRmDirEvent(String path, Date started, Exception error)
protected void	fireSetStatEvent(String path, SftpFileAttributes old, SftpFileAttributes attrs, Date started, Exception error)
protected void	fireStatEvent(String path, SftpFileAttributes attrs, Date started, Exception error)
protected void	fireSymlinkEvent(String linkpath, String targetpath, Date started, Exception error)
String	getCharsetEncoding()
AbstractFileSystem	getFileSystem()
int	getVersion()
void	init(SessionChannel session, Context context)	Initialize the subsystem with the current session and configuration.
protected void	onMessageReceived(byte[] msg)	Called when a subsystem message has been extracted from the incoming data stream.
protected void	onSubsystemFree()	Called to free the subsystem and its resources.
void	removeWrapper(SftpOperationWrapper wrapper)
void	sendAttributesMessage(int id, SftpFileAttributes attrs)
int	sendFilenameMessage(int id, SftpFile[] files, boolean isRealPath, boolean isAbsolute)
void	sendHandleMessage(int id, byte[] handle)
void	sendStatusMessage(int id, int reason, String description)
void	submitTask(Runnable runnable)

Methods inherited from class com.sshtools.common.ssh.Subsystem

cleanup, executeOperation, free, getConnection, getContext, getSession, onFreeMessage, parseMessage, processMessage, sendMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sshtools.common.sftp.SftpSpecification

sendMessage

Field Details

SFTP_QUEUE

public static final Integer SFTP_QUEUE

SUBSYSTEM_NAME

public static final String SUBSYSTEM_NAME

See Also:

• Constant Field Values

Constructor Details

SftpSubsystem

public SftpSubsystem()

Method Details

init

public void init(SessionChannel session,
 Context context)
          throws IOException,
PermissionDeniedException

Description copied from class: Subsystem

Initialize the subsystem with the current session and configuration.

Overrides:

init in class Subsystem

Throws:

IOException

PermissionDeniedException

cleanupSubsystem

protected void cleanupSubsystem()

Specified by:

cleanupSubsystem in class Subsystem

onSubsystemFree

protected void onSubsystemFree()

Called to free the subsystem and its resources.

Specified by:

onSubsystemFree in class Subsystem

onMessageReceived

protected void onMessageReceived(byte[] msg)
                          throws IOException

Description copied from class: Subsystem

Called when a subsystem message has been extracted from the incoming data stream.

Specified by:

onMessageReceived in class Subsystem

Throws:

IOException

fireSetStatEvent

protected void fireSetStatEvent(String path,
 SftpFileAttributes old,
 SftpFileAttributes attrs,
 Date started,
 Exception error)

fireStatEvent

protected void fireStatEvent(String path,
 SftpFileAttributes attrs,
 Date started,
 Exception error)

fireSymlinkEvent

protected void fireSymlinkEvent(String linkpath,
 String targetpath,
 Date started,
 Exception error)

fireRmDirEvent

protected void fireRmDirEvent(String path,
 Date started,
 Exception error)

fireRenameFileEvent

protected void fireRenameFileEvent(String oldpath,
 String newpath,
 Date started,
 Exception error)

fireRemoveFileEvent

protected void fireRemoveFileEvent(String path,
 Date started,
 Exception error)

fireOpenFileEvent

protected void fireOpenFileEvent(com.sshtools.common.util.UnsignedInteger32 flags,
 SftpFileAttributes attrs,
 String path,
 Date started,
 byte[] handle,
 Exception error)

fireOpenInitEvent

protected void fireOpenInitEvent(com.sshtools.common.util.UnsignedInteger32 flags,
 SftpFileAttributes attrs,
 String path,
 Date started,
 Exception error)

sendHandleMessage

public void sendHandleMessage(int id,
 byte[] handle)
                       throws IOException

Throws:

IOException

fireCloseFileEvent

protected void fireCloseFileEvent(byte[] handle,
 Exception error)

fireCloseFileEvent

protected void fireCloseFileEvent(TransferEvent evt,
 Exception error)

sendAttributesMessage

public void sendAttributesMessage(int id,
 SftpFileAttributes attrs)
                           throws IOException

Throws:

IOException

fireOpenDirectoryEvent

protected void fireOpenDirectoryEvent(String path,
 Date started,
 byte[] handle,
 Exception error)

sendStatusMessage

public void sendStatusMessage(int id,
 int reason,
 String description)

Specified by:

sendStatusMessage in interface SftpSpecification

sendFilenameMessage

public int sendFilenameMessage(int id,
 SftpFile[] files,
 boolean isRealPath,
 boolean isAbsolute)
                        throws IOException

Throws:

IOException

fireMakeDirectoryEvent

protected void fireMakeDirectoryEvent(String path,
 Date started,
 Exception error)

checkDefaultPath

public String checkDefaultPath(String path)
                        throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

fireEvent

public void fireEvent(Event event)

getFileSystem

public AbstractFileSystem getFileSystem()

Specified by:

getFileSystem in interface SftpSpecification

submitTask

public void submitTask(Runnable runnable)

addWrapper

public void addWrapper(SftpOperationWrapper wrapper)

removeWrapper

public void removeWrapper(SftpOperationWrapper wrapper)

getCharsetEncoding

public String getCharsetEncoding()

addTransferEvent

public void addTransferEvent(String handle,
 TransferEvent evt)

getVersion

public int getVersion()