com.sshtools.client.sftp

Class SftpStatusException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.sshtools.client.sftp.SftpStatusException

All Implemented Interfaces:

Serializable

public class SftpStatusException
extends Exception

This exception is thrown by the SftpSubsystemChannel class whenever a status message is received that is not expected. This would normally indicate a failure of the operation, for example with a no such file status being returned.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATTRIBUTE_BITS_NOT_AVAILABLE
static int	BAD_API_USAGE
static int	INVALID_HANDLE The file handle provided was invalid
static int	INVALID_RESUME_STATE The file cannot be resumed
static int	INVALID_TEXT_MODE The server reported a canonical newline convention not supported by this API
static int	SSH_FX_BAD_MESSAGE The client sent a bad protocol message
static int	SSH_FX_BYTE_RANGE_LOCK_CONFLICT
static int	SSH_FX_BYTE_RANGE_LOCK_REFUSED
static int	SSH_FX_CANNOT_DELETE
static int	SSH_FX_CONNECTION_LOST The file system connection was lost
static int	SSH_FX_DELETE_PENDING
static int	SSH_FX_DIR_NOT_EMPTY
static int	SSH_FX_EOF The file or listing is EOF
static int	SSH_FX_FAILURE Generic failure code
static int	SSH_FX_FILE_ALREADY_EXISTS The path already exists
static int	SSH_FX_FILE_CORRUPT
static int	SSH_FX_FILE_IS_A_DIRECTORY
static int	SSH_FX_GROUP_INVALID
static int	SSH_FX_INVALID_FILENAME
static int	SSH_FX_INVALID_HANDLE The file handle provided was invalid
static int	SSH_FX_INVALID_PARAMETER
static int	SSH_FX_LINK_LOOP
static int	SSH_FX_LOCK_CONFLICT
static int	SSH_FX_NO_CONNECTION There is no connection to the file system
static int	SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK
static int	SSH_FX_NO_MEDIA There is no media available at the remote location
static int	SSH_FX_NO_SPACE_ON_FILESYSTEM
static int	SSH_FX_NO_SUCH_FILE No such file was found
static int	SSH_FX_NO_SUCH_PATH The path is invalid
static int	SSH_FX_NOT_A_DIRECTORY
static int	SSH_FX_OK Everything performed correctly
static int	SSH_FX_OP_UNSUPPORTED The operation requested is not supported
static int	SSH_FX_OWNER_INVALID
static int	SSH_FX_PERMISSION_DENIED The user does not have permission
static int	SSH_FX_QUOTA_EXCEEDED
static int	SSH_FX_UNKNOWN_PRINCIPAL
static int	SSH_FX_WRITE_PROTECT Cannot write to remote location

Constructor Summary

Constructors

Constructor and Description
SftpStatusException(int status)
SftpStatusException(int status, String msg)

Method Summary

Modifier and Type	Method and Description
int	getStatus() Get the status
static String	getStatusText(int status) Convert a SSH_FXP_STATUS code into a readable string

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 int SSH_FX_OK

Everything performed correctly

See Also:

Constant Field Values

SSH_FX_EOF

public static final int SSH_FX_EOF

The file or listing is EOF

See Also:

Constant Field Values

SSH_FX_NO_SUCH_FILE

public static final int SSH_FX_NO_SUCH_FILE

No such file was found

See Also:

Constant Field Values

SSH_FX_PERMISSION_DENIED

public static final int SSH_FX_PERMISSION_DENIED

The user does not have permission

See Also:

Constant Field Values

SSH_FX_FAILURE

public static final int SSH_FX_FAILURE

Generic failure code

See Also:

Constant Field Values

SSH_FX_BAD_MESSAGE

public static final int SSH_FX_BAD_MESSAGE

The client sent a bad protocol message

See Also:

Constant Field Values

SSH_FX_NO_CONNECTION

public static final int SSH_FX_NO_CONNECTION

There is no connection to the file system

See Also:

Constant Field Values

SSH_FX_CONNECTION_LOST

public static final int SSH_FX_CONNECTION_LOST

The file system connection was lost

See Also:

Constant Field Values

SSH_FX_OP_UNSUPPORTED

public static final int SSH_FX_OP_UNSUPPORTED

The operation requested is not supported

See Also:

Constant Field Values

SSH_FX_INVALID_HANDLE

public static final int SSH_FX_INVALID_HANDLE

The file handle provided was invalid

See Also:

Constant Field Values

SSH_FX_NO_SUCH_PATH

public static final int SSH_FX_NO_SUCH_PATH

The path is invalid

See Also:

Constant Field Values

SSH_FX_FILE_ALREADY_EXISTS

public static final int SSH_FX_FILE_ALREADY_EXISTS

The path already exists

See Also:

Constant Field Values

SSH_FX_WRITE_PROTECT

public static final int SSH_FX_WRITE_PROTECT

Cannot write to remote location

See Also:

Constant Field Values

SSH_FX_NO_MEDIA

public static final int SSH_FX_NO_MEDIA

There is no media available at the remote location

See Also:

Constant Field Values

SSH_FX_NO_SPACE_ON_FILESYSTEM

public static final int SSH_FX_NO_SPACE_ON_FILESYSTEM

See Also:

Constant Field Values

SSH_FX_QUOTA_EXCEEDED

public static final int SSH_FX_QUOTA_EXCEEDED

See Also:

Constant Field Values

SSH_FX_UNKNOWN_PRINCIPAL

public static final int SSH_FX_UNKNOWN_PRINCIPAL

See Also:

Constant Field Values

SSH_FX_LOCK_CONFLICT

public static final int SSH_FX_LOCK_CONFLICT

See Also:

Constant Field Values

SSH_FX_DIR_NOT_EMPTY

public static final int SSH_FX_DIR_NOT_EMPTY

See Also:

Constant Field Values

SSH_FX_NOT_A_DIRECTORY

public static final int SSH_FX_NOT_A_DIRECTORY

See Also:

Constant Field Values

SSH_FX_INVALID_FILENAME

public static final int SSH_FX_INVALID_FILENAME

See Also:

Constant Field Values

SSH_FX_LINK_LOOP

public static final int SSH_FX_LINK_LOOP

See Also:

Constant Field Values

SSH_FX_CANNOT_DELETE

public static final int SSH_FX_CANNOT_DELETE

See Also:

Constant Field Values

SSH_FX_INVALID_PARAMETER

public static final int SSH_FX_INVALID_PARAMETER

See Also:

Constant Field Values

SSH_FX_FILE_IS_A_DIRECTORY

public static final int SSH_FX_FILE_IS_A_DIRECTORY

See Also:

Constant Field Values

SSH_FX_BYTE_RANGE_LOCK_CONFLICT

public static final int SSH_FX_BYTE_RANGE_LOCK_CONFLICT

See Also:

Constant Field Values

SSH_FX_BYTE_RANGE_LOCK_REFUSED

public static final int SSH_FX_BYTE_RANGE_LOCK_REFUSED

See Also:

Constant Field Values

SSH_FX_DELETE_PENDING

public static final int SSH_FX_DELETE_PENDING

See Also:

Constant Field Values

SSH_FX_FILE_CORRUPT

public static final int SSH_FX_FILE_CORRUPT

See Also:

Constant Field Values

SSH_FX_OWNER_INVALID

public static final int SSH_FX_OWNER_INVALID

See Also:

Constant Field Values

SSH_FX_GROUP_INVALID

public static final int SSH_FX_GROUP_INVALID

See Also:

Constant Field Values

SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK

public static final int SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK

See Also:

Constant Field Values

INVALID_HANDLE

public static final int INVALID_HANDLE

The file handle provided was invalid

See Also:

Constant Field Values

INVALID_RESUME_STATE

public static final int INVALID_RESUME_STATE

The file cannot be resumed

See Also:

Constant Field Values

INVALID_TEXT_MODE

public static final int INVALID_TEXT_MODE

The server reported a canonical newline convention not supported by this API

See Also:

Constant Field Values

ATTRIBUTE_BITS_NOT_AVAILABLE

public static final int ATTRIBUTE_BITS_NOT_AVAILABLE

See Also:

Constant Field Values

BAD_API_USAGE

public static final int BAD_API_USAGE

See Also:

Constant Field Values

Constructor Detail

SftpStatusException

public SftpStatusException(int status,
                           String msg)

SftpStatusException

public SftpStatusException(int status)

Method Detail

getStatus

public int getStatus()

Get the status

Returns:

int

getStatusText

public static String getStatusText(int status)

Convert a SSH_FXP_STATUS code into a readable string

Parameters:

status -

Returns: