net.sf.sshapi

Class SshException

java.lang.Object

java.lang.Throwable

java.lang.Exception

net.sf.sshapi.SshException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SftpException

public class SshException
extends java.lang.Exception

Exception thrown during various SSH operations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SshException.Code Error code.

Field Summary

Fields

Modifier and Type	Field and Description
static SshException.Code	ALREADY_OPEN An attempt was made to 'open' a resource, an SshPortForward for example, but the resource was already open.
static SshException.Code	AUTHENTICATION_ATTEMPTS_EXCEEDED Too many authentication attempts
static SshException.Code	AUTHENTICATION_CANCELLED Authentication was cancelled by user when being prompted for something (password, passphrase etc)
static SshException.Code	AUTHENTICATION_FAILED Authentication failed.
static SshException.Code	ENCRYPTED Attempt to perform an operation that required a decrypted key failed because the key was still encrypted.
static SshException.Code	FAILED_TO_CONNECT_TO_AGENT There is an agent, but failed to connect to it.
static SshException.Code	FAILED_TO_OPEN_SHELL Failed to open shell.
static SshException.Code	GENERAL General error.
static SshException.Code	HOST_KEY_REJECTED Host key was rejected.
static SshException.Code	INCORRECT_PASSPHRASE The provided passphrase is incorrect.
static SshException.Code	IO_ERROR General I/O error.
static SshException.Code	NO_AGENT No agent could be found.
static SshException.Code	NOT_ENCRYPTED An attempt was made to decrypt a key that was not encrypted.
static SshException.Code	NOT_OPEN An attempt was made to 'close' a resource, an SshPortForward for example, but the resource was already closed.
static SshException.Code	PASSPHRASE_REQUIRED A passphrase is required to perform an operation, but was not supplied.
static SshException.Code	PRIVATE_KEY_FORMAT_NOT_SUPPORTED An attempt was made to write to a private key format that is not supported.
static SshException.Code	UNSUPPORTED_FEATURE The SshConfiguration requested use of a feature not supported by the provider in use.
static SshException.Code	UNSUPPORTED_PROTOCOL_VERSION The implementation does not support the protocol version request by SshConfiguration.getProtocolVersion().

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SshException.Code	getCode() Get the error code.

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

GENERAL

public static final SshException.Code GENERAL

General error. The provider did not or could not provide additional information with an error code. The actual exception will most likely be available through Throwable.getCause().

UNSUPPORTED_PROTOCOL_VERSION

public static final SshException.Code UNSUPPORTED_PROTOCOL_VERSION

The implementation does not support the protocol version request by SshConfiguration.getProtocolVersion().

ALREADY_OPEN

public static final SshException.Code ALREADY_OPEN

An attempt was made to 'open' a resource, an SshPortForward for example, but the resource was already open.

NOT_OPEN

public static final SshException.Code NOT_OPEN

An attempt was made to 'close' a resource, an SshPortForward for example, but the resource was already closed.

UNSUPPORTED_FEATURE

public static final SshException.Code UNSUPPORTED_FEATURE

The SshConfiguration requested use of a feature not supported by the provider in use.

IO_ERROR

public static final SshException.Code IO_ERROR

General I/O error. Actual exception will be available through Throwable.getCause().

INCORRECT_PASSPHRASE

public static final SshException.Code INCORRECT_PASSPHRASE

The provided passphrase is incorrect.

NOT_ENCRYPTED

public static final SshException.Code NOT_ENCRYPTED

An attempt was made to decrypt a key that was not encrypted.

PRIVATE_KEY_FORMAT_NOT_SUPPORTED

public static final SshException.Code PRIVATE_KEY_FORMAT_NOT_SUPPORTED

An attempt was made to write to a private key format that is not supported.

PASSPHRASE_REQUIRED

public static final SshException.Code PASSPHRASE_REQUIRED

A passphrase is required to perform an operation, but was not supplied. For example, changing the password on an encrypted private key.

AUTHENTICATION_FAILED

public static final SshException.Code AUTHENTICATION_FAILED

Authentication failed. The provided credentials were not acceptable.

AUTHENTICATION_CANCELLED

public static final SshException.Code AUTHENTICATION_CANCELLED

Authentication was cancelled by user when being prompted for something (password, passphrase etc)

AUTHENTICATION_ATTEMPTS_EXCEEDED

public static final SshException.Code AUTHENTICATION_ATTEMPTS_EXCEEDED

Too many authentication attempts

HOST_KEY_REJECTED

public static final SshException.Code HOST_KEY_REJECTED

Host key was rejected. Connection will be closed.

ENCRYPTED

public static final SshException.Code ENCRYPTED

Attempt to perform an operation that required a decrypted key failed because the key was still encrypted.

FAILED_TO_OPEN_SHELL

public static final SshException.Code FAILED_TO_OPEN_SHELL

Failed to open shell.

NO_AGENT

public static final SshException.Code NO_AGENT

No agent could be found.

FAILED_TO_CONNECT_TO_AGENT

public static final SshException.Code FAILED_TO_CONNECT_TO_AGENT

There is an agent, but failed to connect to it.

Constructor Detail

SshException

public SshException()

Constructor.

SshException

public SshException(java.lang.String message,
                    java.lang.Throwable cause)

Constructor.

Parameters:

message - message

cause - cause

SshException

public SshException(java.lang.String message)

Constructor.

Parameters:

message - message

SshException

public SshException(java.lang.Throwable cause)

Constructor.

Parameters:

cause - cause

SshException

public SshException(SshException.Code code)

Constructor.

Parameters:

code - code

SshException

public SshException(SshException.Code code,
                    java.lang.String message,
                    java.lang.Throwable cause)

Constructor.

Parameters:

code - code

message - message

cause - cause

SshException

public SshException(SshException.Code code,
                    java.lang.String message)

Constructor.

Parameters:

code - code

message - message

SshException

public SshException(SshException.Code code,
                    java.lang.Throwable cause)

Constructor.

Parameters:

code - code

cause - cause

Method Detail

getCode

public SshException.Code getCode()

Get the error code. For some operations, the SSH provider implementation will be expected to throw exceptions with appropriate code. For all other operations, general codes such as IO_ERROR may be thrown, or the provide may add its own codes.

Returns:

code