com.ssh.sft Class SftException | How This API Document Is Organized

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ssh.sft
Class SftException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.ssh.sft.SftException

All Implemented Interfaces:: Serializable, com.ssh.sft.SshSftError

Direct Known Subclasses:: AbortedException, NoSuchFileException, PermissionDeniedException, SftEOFException

public class SftException
extends Exception
implements com.ssh.sft.SshSftError

An exception that is thrown by the Secure File Transfer service. Each SftException is associated with an integer error code that provides more detailed information about the type of error than the object's class alone.

See Also:: Serialized Form

Field Summary
`static int`	`SSH_SFT_ERROR`
`static int`	`SSH_SFT_ERROR_AUTHENTICATION_FAILED`
`static int`	`SSH_SFT_ERROR_BAD_MESSAGE`
`static int`	`SSH_SFT_ERROR_BAD_MESSAGE_DST`
`static int`	`SSH_SFT_ERROR_BAD_MESSAGE_SRC`
`static int`	`SSH_SFT_ERROR_BROKER_FAILED`
`static int`	`SSH_SFT_ERROR_CHECKPOINT_DATABASE`
`static int`	`SSH_SFT_ERROR_CHECKPOINT_READ`
`static int`	`SSH_SFT_ERROR_CONNECTION_ABORTED`
`static int`	`SSH_SFT_ERROR_CONNECTION_LOST`
`static int`	`SSH_SFT_ERROR_CONNECTION_LOST_DST`
`static int`	`SSH_SFT_ERROR_CONNECTION_LOST_SRC`
`static int`	`SSH_SFT_ERROR_EOF`
`static int`	`SSH_SFT_ERROR_EOF_DST`
`static int`	`SSH_SFT_ERROR_EOF_SRC`
`static int`	`SSH_SFT_ERROR_FAILURE`
`static int`	`SSH_SFT_ERROR_FAILURE_DST`
`static int`	`SSH_SFT_ERROR_FAILURE_SRC`
`static int`	`SSH_SFT_ERROR_FILE_ALREADY_EXISTS`
`static int`	`SSH_SFT_ERROR_FILE_ALREADY_EXISTS_DST`
`static int`	`SSH_SFT_ERROR_FILE_ALREADY_EXISTS_SRC`
`static int`	`SSH_SFT_ERROR_ILLEGAL_PARAMETER`
`static int`	`SSH_SFT_ERROR_INTERNAL`
`static int`	`SSH_SFT_ERROR_INVALID_HANDLE`
`static int`	`SSH_SFT_ERROR_INVALID_HANDLE_DST`
`static int`	`SSH_SFT_ERROR_INVALID_HANDLE_SRC`
`static int`	`SSH_SFT_ERROR_LIB_UNINITIALIZED`
`static int`	`SSH_SFT_ERROR_LISTENER`
`static int`	`SSH_SFT_ERROR_LOCAL_STREAM_FAILED`
`static int`	`SSH_SFT_ERROR_NO_BROKER_CONNECTION`
`static int`	`SSH_SFT_ERROR_NO_CHECKPOINT_ENTRY`
`static int`	`SSH_SFT_ERROR_NO_CONNECTION`
`static int`	`SSH_SFT_ERROR_NO_CONNECTION_DST`
`static int`	`SSH_SFT_ERROR_NO_CONNECTION_SRC`
`static int`	`SSH_SFT_ERROR_NO_LICENSE`
`static int`	`SSH_SFT_ERROR_NO_MEDIA`
`static int`	`SSH_SFT_ERROR_NO_MEDIA_DST`
`static int`	`SSH_SFT_ERROR_NO_MEDIA_SRC`
`static int`	`SSH_SFT_ERROR_NO_SERVER_LICENSE`
`static int`	`SSH_SFT_ERROR_NO_SUCH_FILE`
`static int`	`SSH_SFT_ERROR_NO_SUCH_FILE_DST`
`static int`	`SSH_SFT_ERROR_NO_SUCH_FILE_SRC`
`static int`	`SSH_SFT_ERROR_NO_SUCH_PATH`
`static int`	`SSH_SFT_ERROR_NO_SUCH_PATH_DST`
`static int`	`SSH_SFT_ERROR_NO_SUCH_PATH_SRC`
`static int`	`SSH_SFT_ERROR_NOT_DIR`
`static int`	`SSH_SFT_ERROR_OP_UNSUPPORTED`
`static int`	`SSH_SFT_ERROR_OP_UNSUPPORTED_DST`
`static int`	`SSH_SFT_ERROR_OP_UNSUPPORTED_SRC`
`static int`	`SSH_SFT_ERROR_OUT_OF_MEMORY`
`static int`	`SSH_SFT_ERROR_PERMISSION_DENIED`
`static int`	`SSH_SFT_ERROR_PERMISSION_DENIED_DST`
`static int`	`SSH_SFT_ERROR_PERMISSION_DENIED_SRC`
`static int`	`SSH_SFT_ERROR_READ`
`static int`	`SSH_SFT_ERROR_UNABLE_TO_CONNECT_SERVER`
`static int`	`SSH_SFT_ERROR_WRITE`
`static int`	`SSH_SFT_ERROR_WRITE_PROTECT`
`static int`	`SSH_SFT_ERROR_WRITE_PROTECT_DST`
`static int`	`SSH_SFT_ERROR_WRITE_PROTECT_SRC`
`static int`	`SSH_SFT_OK`
`static int`	`SSH_SFT_OK_ABORT`
`static int`	`SSH_SFT_OK_HASH_MATCH`
`static int`	`SSH_SFT_OK_HASH_MATCH_DST_TRUNCATED`
`static int`	`SSH_SFT_OK_SKIP`
`static int`	`SSH_SFT_OK_WITH_ERRORS`

Method Summary
`int`	`getErrorCode()` Returns the error code of this exception.
`String`	`getMessage()` Returns the message of this exception.
`String`	`toString()` Returns a String with the class, error code and the message of the exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SSH_SFT_OK

public static final int SSH_SFT_OK

See Also:: Constant Field Values

SSH_SFT_OK_HASH_MATCH

public static final int SSH_SFT_OK_HASH_MATCH

See Also:: Constant Field Values

SSH_SFT_OK_HASH_MATCH_DST_TRUNCATED

public static final int SSH_SFT_OK_HASH_MATCH_DST_TRUNCATED

See Also:: Constant Field Values

SSH_SFT_OK_SKIP

public static final int SSH_SFT_OK_SKIP

See Also:: Constant Field Values

SSH_SFT_OK_ABORT

public static final int SSH_SFT_OK_ABORT

See Also:: Constant Field Values

SSH_SFT_OK_WITH_ERRORS

public static final int SSH_SFT_OK_WITH_ERRORS

See Also:: Constant Field Values

SSH_SFT_ERROR

public static final int SSH_SFT_ERROR

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_LICENSE

public static final int SSH_SFT_ERROR_NO_LICENSE

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_SERVER_LICENSE

public static final int SSH_SFT_ERROR_NO_SERVER_LICENSE

See Also:: Constant Field Values

SSH_SFT_ERROR_NOT_DIR

public static final int SSH_SFT_ERROR_NOT_DIR

See Also:: Constant Field Values

SSH_SFT_ERROR_EOF

public static final int SSH_SFT_ERROR_EOF

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_SUCH_FILE

public static final int SSH_SFT_ERROR_NO_SUCH_FILE

See Also:: Constant Field Values

SSH_SFT_ERROR_PERMISSION_DENIED

public static final int SSH_SFT_ERROR_PERMISSION_DENIED

See Also:: Constant Field Values

SSH_SFT_ERROR_FAILURE

public static final int SSH_SFT_ERROR_FAILURE

See Also:: Constant Field Values

SSH_SFT_ERROR_BAD_MESSAGE

public static final int SSH_SFT_ERROR_BAD_MESSAGE

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_CONNECTION

public static final int SSH_SFT_ERROR_NO_CONNECTION

See Also:: Constant Field Values

SSH_SFT_ERROR_CONNECTION_LOST

public static final int SSH_SFT_ERROR_CONNECTION_LOST

See Also:: Constant Field Values

SSH_SFT_ERROR_OP_UNSUPPORTED

public static final int SSH_SFT_ERROR_OP_UNSUPPORTED

See Also:: Constant Field Values

SSH_SFT_ERROR_INVALID_HANDLE

public static final int SSH_SFT_ERROR_INVALID_HANDLE

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_SUCH_PATH

public static final int SSH_SFT_ERROR_NO_SUCH_PATH

See Also:: Constant Field Values

SSH_SFT_ERROR_FILE_ALREADY_EXISTS

public static final int SSH_SFT_ERROR_FILE_ALREADY_EXISTS

See Also:: Constant Field Values

SSH_SFT_ERROR_WRITE_PROTECT

public static final int SSH_SFT_ERROR_WRITE_PROTECT

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_MEDIA

public static final int SSH_SFT_ERROR_NO_MEDIA

See Also:: Constant Field Values

SSH_SFT_ERROR_EOF_SRC

public static final int SSH_SFT_ERROR_EOF_SRC

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_SUCH_FILE_SRC

public static final int SSH_SFT_ERROR_NO_SUCH_FILE_SRC

See Also:: Constant Field Values

SSH_SFT_ERROR_PERMISSION_DENIED_SRC

public static final int SSH_SFT_ERROR_PERMISSION_DENIED_SRC

See Also:: Constant Field Values

SSH_SFT_ERROR_FAILURE_SRC

public static final int SSH_SFT_ERROR_FAILURE_SRC

See Also:: Constant Field Values

SSH_SFT_ERROR_BAD_MESSAGE_SRC

public static final int SSH_SFT_ERROR_BAD_MESSAGE_SRC

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_CONNECTION_SRC

public static final int SSH_SFT_ERROR_NO_CONNECTION_SRC

See Also:: Constant Field Values

SSH_SFT_ERROR_CONNECTION_LOST_SRC

public static final int SSH_SFT_ERROR_CONNECTION_LOST_SRC

See Also:: Constant Field Values

SSH_SFT_ERROR_OP_UNSUPPORTED_SRC

public static final int SSH_SFT_ERROR_OP_UNSUPPORTED_SRC

See Also:: Constant Field Values

SSH_SFT_ERROR_INVALID_HANDLE_SRC

public static final int SSH_SFT_ERROR_INVALID_HANDLE_SRC

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_SUCH_PATH_SRC

public static final int SSH_SFT_ERROR_NO_SUCH_PATH_SRC

See Also:: Constant Field Values

SSH_SFT_ERROR_FILE_ALREADY_EXISTS_SRC

public static final int SSH_SFT_ERROR_FILE_ALREADY_EXISTS_SRC

See Also:: Constant Field Values

SSH_SFT_ERROR_WRITE_PROTECT_SRC

public static final int SSH_SFT_ERROR_WRITE_PROTECT_SRC

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_MEDIA_SRC

public static final int SSH_SFT_ERROR_NO_MEDIA_SRC

See Also:: Constant Field Values

SSH_SFT_ERROR_EOF_DST

public static final int SSH_SFT_ERROR_EOF_DST

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_SUCH_FILE_DST

public static final int SSH_SFT_ERROR_NO_SUCH_FILE_DST

See Also:: Constant Field Values

SSH_SFT_ERROR_PERMISSION_DENIED_DST

public static final int SSH_SFT_ERROR_PERMISSION_DENIED_DST

See Also:: Constant Field Values

SSH_SFT_ERROR_FAILURE_DST

public static final int SSH_SFT_ERROR_FAILURE_DST

See Also:: Constant Field Values

SSH_SFT_ERROR_BAD_MESSAGE_DST

public static final int SSH_SFT_ERROR_BAD_MESSAGE_DST

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_CONNECTION_DST

public static final int SSH_SFT_ERROR_NO_CONNECTION_DST

See Also:: Constant Field Values

SSH_SFT_ERROR_CONNECTION_LOST_DST

public static final int SSH_SFT_ERROR_CONNECTION_LOST_DST

See Also:: Constant Field Values

SSH_SFT_ERROR_OP_UNSUPPORTED_DST

public static final int SSH_SFT_ERROR_OP_UNSUPPORTED_DST

See Also:: Constant Field Values

SSH_SFT_ERROR_INVALID_HANDLE_DST

public static final int SSH_SFT_ERROR_INVALID_HANDLE_DST

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_SUCH_PATH_DST

public static final int SSH_SFT_ERROR_NO_SUCH_PATH_DST

See Also:: Constant Field Values

SSH_SFT_ERROR_FILE_ALREADY_EXISTS_DST

public static final int SSH_SFT_ERROR_FILE_ALREADY_EXISTS_DST

See Also:: Constant Field Values

SSH_SFT_ERROR_WRITE_PROTECT_DST

public static final int SSH_SFT_ERROR_WRITE_PROTECT_DST

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_MEDIA_DST

public static final int SSH_SFT_ERROR_NO_MEDIA_DST

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_BROKER_CONNECTION

public static final int SSH_SFT_ERROR_NO_BROKER_CONNECTION

See Also:: Constant Field Values

SSH_SFT_ERROR_AUTHENTICATION_FAILED

public static final int SSH_SFT_ERROR_AUTHENTICATION_FAILED

See Also:: Constant Field Values

SSH_SFT_ERROR_UNABLE_TO_CONNECT_SERVER

public static final int SSH_SFT_ERROR_UNABLE_TO_CONNECT_SERVER

See Also:: Constant Field Values

SSH_SFT_ERROR_BROKER_FAILED

public static final int SSH_SFT_ERROR_BROKER_FAILED

See Also:: Constant Field Values

SSH_SFT_ERROR_LOCAL_STREAM_FAILED

public static final int SSH_SFT_ERROR_LOCAL_STREAM_FAILED

See Also:: Constant Field Values

SSH_SFT_ERROR_CONNECTION_ABORTED

public static final int SSH_SFT_ERROR_CONNECTION_ABORTED

See Also:: Constant Field Values

SSH_SFT_ERROR_READ

public static final int SSH_SFT_ERROR_READ

See Also:: Constant Field Values

SSH_SFT_ERROR_WRITE

public static final int SSH_SFT_ERROR_WRITE

See Also:: Constant Field Values

SSH_SFT_ERROR_OUT_OF_MEMORY

public static final int SSH_SFT_ERROR_OUT_OF_MEMORY

See Also:: Constant Field Values

SSH_SFT_ERROR_LISTENER

public static final int SSH_SFT_ERROR_LISTENER

See Also:: Constant Field Values

SSH_SFT_ERROR_LIB_UNINITIALIZED

public static final int SSH_SFT_ERROR_LIB_UNINITIALIZED

See Also:: Constant Field Values

SSH_SFT_ERROR_ILLEGAL_PARAMETER

public static final int SSH_SFT_ERROR_ILLEGAL_PARAMETER

See Also:: Constant Field Values

SSH_SFT_ERROR_NO_CHECKPOINT_ENTRY

public static final int SSH_SFT_ERROR_NO_CHECKPOINT_ENTRY

See Also:: Constant Field Values

SSH_SFT_ERROR_CHECKPOINT_DATABASE

public static final int SSH_SFT_ERROR_CHECKPOINT_DATABASE

See Also:: Constant Field Values

SSH_SFT_ERROR_CHECKPOINT_READ

public static final int SSH_SFT_ERROR_CHECKPOINT_READ

See Also:: Constant Field Values

SSH_SFT_ERROR_INTERNAL

public static final int SSH_SFT_ERROR_INTERNAL

See Also:: Constant Field Values

Method Detail

getMessage

public String getMessage()

Returns the message of this exception.

Returns:: the message of this exception.

getErrorCode

public int getErrorCode()

Returns the error code of this exception.

Returns:: the error code of this exception.

toString

public String toString()

Returns a String with the class, error code and the message of the exception.

Returns:: The exception converted into string.