Package com.trilead.ssh2
Class SFTPException
java.lang.Object
java.lang.Throwable
java.lang.Exception
java.io.IOException
com.trilead.ssh2.SFTPException
- All Implemented Interfaces:
Serializable
Used in combination with the SFTPv3Client. This exception wraps
error messages sent by the SFTP server.
- Version:
- $Id: SFTPException.java,v 1.1 2007/10/15 12:49:56 cplattne Exp $
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final long
private final int
private final String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate static String
constructMessage
(String s, int errorCode) int
Get the error code sent by the server.Get the symbolic name of the error code as given in the SFTP specs.Get the description of the error code as given in the SFTP specs.Get the error message sent by the server.Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
sftpErrorMessage
-
sftpErrorCode
private final int sftpErrorCode
-
-
Constructor Details
-
SFTPException
SFTPException(String msg, int errorCode)
-
-
Method Details
-
constructMessage
-
getServerErrorMessage
Get the error message sent by the server. Often, this message does not help a lot (e.g., "failure").- Returns:
- the plain string as sent by the server.
-
getServerErrorCode
public int getServerErrorCode()Get the error code sent by the server.- Returns:
- an error code as defined in the SFTP specs.
-
getServerErrorCodeSymbol
Get the symbolic name of the error code as given in the SFTP specs.- Returns:
- e.g., "SSH_FX_INVALID_FILENAME".
-
getServerErrorCodeVerbose
Get the description of the error code as given in the SFTP specs.- Returns:
- e.g., "The filename is not valid."
-