com.jcraft.jsch

Class SftpException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.jcraft.jsch.SftpException

All Implemented Interfaces:

Serializable

public class SftpException
extends Exception

This exception will be thrown if anything goes wrong while using the SFTP protocol. The exception contains an error identifier, which corresponds to the status codes used in the SFTP protocol for error messages. The following values are used directly in the source code:

SSH_FX_FAILURE

a general failure message.

SSH_FX_NO_SUCH_FILE

some file or directory was non-existant

SSH_FX_OP_UNSUPPORTED

some operation is not supported by the server

But in general every SSH_FXP_STATUS status value can be thrown.

See Also:

ChannelSftp, Internet Draft "SSH File Transfer Protocol" (version 02 describing version 3 of the protocol), section 7: Responses from the Server to the Client, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	id The status code which caused the exception to be thrown.

Constructor Summary

Constructors

Constructor and Description
SftpException(int id, String message) Creates a new SftpException.
SftpException(int id, String message, Throwable e) Creates a new SftpException.

Method Summary

Modifier and Type	Method and Description
Throwable	getCause() Returns the cause of the exception.
String	toString() returns a String representation of this exception.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

id

public int id

The status code which caused the exception to be thrown.

Constructor Detail

SftpException

public SftpException(int id,
                     String message)

Creates a new SftpException.

Parameters:

id - the status code identifying the type of error.

message - the error message sent by the server or generated by the client.

SftpException

public SftpException(int id,
                     String message,
                     Throwable e)

Creates a new SftpException.

Parameters:

id - the status code identifying the type of error.

message - the error message sent by the server or generated by the client.

e - a throwable which was the cause of this exception. May be null if there was no thrown cause.

Method Detail

toString

public String toString()

returns a String representation of this exception. It contains of the id and message.

Overrides:

toString in class Throwable

getCause

public Throwable getCause()

Returns the cause of the exception.

Overrides:

getCause in class Throwable