net.sf.sshapi.sftp

Class SftpException

java.lang.Object

java.lang.Throwable

java.lang.Exception

net.sf.sshapi.SshException

net.sf.sshapi.sftp.SftpException

All Implemented Interfaces:

java.io.Serializable

public class SftpException
extends SshException

Specialised SshException that is thrown by operations in SftpClient. The SFTP server will return error codes that may be useful to clients.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SftpException.SftpCode SFTP error code.

Nested classes/interfaces inherited from class net.sf.sshapi.SshException

SshException.Code

Field Summary

Fields

Modifier and Type	Field and Description
static SshException.Code	SSH_FX_BAD_MESSAGE SSH_FX_BAD_MESSAGE
static SshException.Code	SSH_FX_BYTE_RANGE_LOCK_CONFLICT SSH_FX_BYTE_RANGE_LOCK_CONFLICT
static SshException.Code	SSH_FX_BYTE_RANGE_LOCK_REFUSED SSH_FX_BYTE_RANGE_LOCK_REFUSED
static SshException.Code	SSH_FX_CANNOT_DELETE SSH_FX_CANNOT_DELETE
static SshException.Code	SSH_FX_CONNECTION_LOST SSH_FX_NO_CONNECTION
static SshException.Code	SSH_FX_DELETE_PENDING SSH_FX_DELETE_PENDING
static SshException.Code	SSH_FX_DIR_NOT_EMPTY SSH_FX_DIR_NOT_EMPTY
static SshException.Code	SSH_FX_EOF SSH_FX_EOF
static SshException.Code	SSH_FX_FAILURE SSH_FX_FAILURE
static SshException.Code	SSH_FX_FILE_ALREADY_EXISTS SSH_FX_FILE_ALREADY_EXISTS
static SshException.Code	SSH_FX_FILE_CORRUPT SSH_FX_FILE_CORRUPT
static SshException.Code	SSH_FX_FILE_IS_A_DIRECTORY SSH_FX_FILE_IS_A_DIRECTORY
static SshException.Code	SSH_FX_GROUP_INVALID SSH_FX_GROUP_INVALID
static SshException.Code	SSH_FX_INVALID_FILENAME SSH_FX_INVALID_FILENAME
static SshException.Code	SSH_FX_INVALID_HANDLE SSH_FX_NO_SUCH_PATH
static SshException.Code	SSH_FX_INVALID_PARAMETER SSH_FX_INVALID_PARAMETER
static SshException.Code	SSH_FX_LINK_LOOP SSH_FX_LINK_LOOP
static SshException.Code	SSH_FX_LOCK_CONFLICT SSH_FX_LOCK_CONFLICT
static SshException.Code	SSH_FX_NO_CONNECTION SSH_FX_BAD_MESSAGE
static SshException.Code	SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK
static SshException.Code	SSH_FX_NO_MEDIA SSH_FX_NO_MEDIA
static SshException.Code	SSH_FX_NO_SPACE_ON_FILESYSTEM SSH_FX_NO_SPACE_ON_FILESYSTEM
static SshException.Code	SSH_FX_NO_SUCH_FILE SSH_FX_NO_SUCH_FILE
static SshException.Code	SSH_FX_NO_SUCH_PATH SSH_FX_NO_SUCH_PATH
static SshException.Code	SSH_FX_NOT_A_DIRECTORY SSH_FX_NOT_A_DIRECTORY
static SshException.Code	SSH_FX_OK SSH_FX_OK
static SshException.Code	SSH_FX_OP_UNSUPPORTED SSH_FX_OP_UNSUPPORTED
static SshException.Code	SSH_FX_OWNER_INVALID SSH_FX_OWNER_INVALID
static SshException.Code	SSH_FX_PERMISSION_DENIED SSH_FX_PERMISSION_DENIED
static SshException.Code	SSH_FX_QUOTA_EXCEEDED SSH_FX_QUOTA_EXCEEDED
static SshException.Code	SSH_FX_UNKNOWN_PRINCIPAL SSH_FX_UNKNOWN_PRINCIPAL
static SshException.Code	SSH_FX_WRITE_PROTECT SSH_FX_WRITE_PROTECT

Fields inherited from class net.sf.sshapi.SshException

ALREADY_OPEN, AUTHENTICATION_ATTEMPTS_EXCEEDED, AUTHENTICATION_CANCELLED, AUTHENTICATION_FAILED, ENCRYPTED, FAILED_TO_CONNECT_TO_AGENT, FAILED_TO_OPEN_SHELL, GENERAL, HOST_KEY_REJECTED, INCORRECT_PASSPHRASE, IO_ERROR, NO_AGENT, NOT_ENCRYPTED, NOT_OPEN, PASSPHRASE_REQUIRED, PRIVATE_KEY_FORMAT_NOT_SUPPORTED, UNSUPPORTED_FEATURE, UNSUPPORTED_PROTOCOL_VERSION

Constructor Summary

Constructors

Constructor and Description
SftpException(int serverErrorCode) Constructor
SftpException(int serverErrorCode, java.lang.String message) Constructor
SftpException(int serverErrorCode, java.lang.String message, java.lang.Throwable cause) Constructor
SftpException(SshException.Code code) Constructor

Method Summary

Modifier and Type	Method and Description
static SshException.Code	getCodeForServerCode(int serverCode) Get the native error code given an SFTP server error code.

Methods inherited from class net.sf.sshapi.SshException

getCode

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

SSH_FX_OK

public static final SshException.Code SSH_FX_OK

SSH_FX_OK

SSH_FX_EOF

public static final SshException.Code SSH_FX_EOF

SSH_FX_EOF

SSH_FX_NO_SUCH_FILE

public static final SshException.Code SSH_FX_NO_SUCH_FILE

SSH_FX_NO_SUCH_FILE

SSH_FX_PERMISSION_DENIED

public static final SshException.Code SSH_FX_PERMISSION_DENIED

SSH_FX_PERMISSION_DENIED

SSH_FX_FAILURE

public static final SshException.Code SSH_FX_FAILURE

SSH_FX_FAILURE

SSH_FX_BAD_MESSAGE

public static final SshException.Code SSH_FX_BAD_MESSAGE

SSH_FX_BAD_MESSAGE

SSH_FX_NO_CONNECTION

public static final SshException.Code SSH_FX_NO_CONNECTION

SSH_FX_BAD_MESSAGE

SSH_FX_CONNECTION_LOST

public static final SshException.Code SSH_FX_CONNECTION_LOST

SSH_FX_NO_CONNECTION

SSH_FX_OP_UNSUPPORTED

public static final SshException.Code SSH_FX_OP_UNSUPPORTED

SSH_FX_OP_UNSUPPORTED

SSH_FX_INVALID_HANDLE

public static final SshException.Code SSH_FX_INVALID_HANDLE

SSH_FX_NO_SUCH_PATH

SSH_FX_NO_SUCH_PATH

public static final SshException.Code SSH_FX_NO_SUCH_PATH

SSH_FX_NO_SUCH_PATH

SSH_FX_FILE_ALREADY_EXISTS

public static final SshException.Code SSH_FX_FILE_ALREADY_EXISTS

SSH_FX_FILE_ALREADY_EXISTS

SSH_FX_WRITE_PROTECT

public static final SshException.Code SSH_FX_WRITE_PROTECT

SSH_FX_WRITE_PROTECT

SSH_FX_NO_MEDIA

public static final SshException.Code SSH_FX_NO_MEDIA

SSH_FX_NO_MEDIA

SSH_FX_NO_SPACE_ON_FILESYSTEM

public static final SshException.Code SSH_FX_NO_SPACE_ON_FILESYSTEM

SSH_FX_NO_SPACE_ON_FILESYSTEM

SSH_FX_QUOTA_EXCEEDED

public static final SshException.Code SSH_FX_QUOTA_EXCEEDED

SSH_FX_QUOTA_EXCEEDED

SSH_FX_UNKNOWN_PRINCIPAL

public static final SshException.Code SSH_FX_UNKNOWN_PRINCIPAL

SSH_FX_UNKNOWN_PRINCIPAL

SSH_FX_LOCK_CONFLICT

public static final SshException.Code SSH_FX_LOCK_CONFLICT

SSH_FX_LOCK_CONFLICT

SSH_FX_DIR_NOT_EMPTY

public static final SshException.Code SSH_FX_DIR_NOT_EMPTY

SSH_FX_DIR_NOT_EMPTY

SSH_FX_NOT_A_DIRECTORY

public static final SshException.Code SSH_FX_NOT_A_DIRECTORY

SSH_FX_NOT_A_DIRECTORY

SSH_FX_INVALID_FILENAME

public static final SshException.Code SSH_FX_INVALID_FILENAME

SSH_FX_INVALID_FILENAME

SSH_FX_LINK_LOOP

public static final SshException.Code SSH_FX_LINK_LOOP

SSH_FX_LINK_LOOP

SSH_FX_CANNOT_DELETE

public static final SshException.Code SSH_FX_CANNOT_DELETE

SSH_FX_CANNOT_DELETE

SSH_FX_INVALID_PARAMETER

public static final SshException.Code SSH_FX_INVALID_PARAMETER

SSH_FX_INVALID_PARAMETER

SSH_FX_FILE_IS_A_DIRECTORY

public static final SshException.Code SSH_FX_FILE_IS_A_DIRECTORY

SSH_FX_FILE_IS_A_DIRECTORY

SSH_FX_BYTE_RANGE_LOCK_CONFLICT

public static final SshException.Code SSH_FX_BYTE_RANGE_LOCK_CONFLICT

SSH_FX_BYTE_RANGE_LOCK_CONFLICT

SSH_FX_BYTE_RANGE_LOCK_REFUSED

public static final SshException.Code SSH_FX_BYTE_RANGE_LOCK_REFUSED

SSH_FX_BYTE_RANGE_LOCK_REFUSED

SSH_FX_DELETE_PENDING

public static final SshException.Code SSH_FX_DELETE_PENDING

SSH_FX_DELETE_PENDING

SSH_FX_FILE_CORRUPT

public static final SshException.Code SSH_FX_FILE_CORRUPT

SSH_FX_FILE_CORRUPT

SSH_FX_OWNER_INVALID

public static final SshException.Code SSH_FX_OWNER_INVALID

SSH_FX_OWNER_INVALID

SSH_FX_GROUP_INVALID

public static final SshException.Code SSH_FX_GROUP_INVALID

SSH_FX_GROUP_INVALID

SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK

public static final SshException.Code SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK

SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK

Constructor Detail

SftpException

public SftpException(int serverErrorCode)

Constructor

Parameters:

serverErrorCode - server error code

SftpException

public SftpException(SshException.Code code)

Constructor

Parameters:

code - error code

SftpException

public SftpException(int serverErrorCode,
                     java.lang.String message)

Constructor

Parameters:

serverErrorCode - server error code

message - message

SftpException

public SftpException(int serverErrorCode,
                     java.lang.String message,
                     java.lang.Throwable cause)

Constructor

Parameters:

serverErrorCode - server error code

message - message

cause - cause

Method Detail

getCodeForServerCode

public static final SshException.Code getCodeForServerCode(int serverCode)

Get the native error code given an SFTP server error code.

Parameters:

serverCode - SFTP server error code

Returns:

native error code