ch.ethz.ssh2
Class SFTPException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.io.IOException
              extended by ch.ethz.ssh2.SFTPException
All Implemented Interfaces:
java.io.Serializable

public class SFTPException
extends java.io.IOException

Used in combination with the SFTPv3Client. This exception wraps error messages sent by the SFTP server.

Version:
2.50, 03/15/10
Author:
Christian Plattner
See Also:
Serialized Form

Field Summary
private static long serialVersionUID
           
private  int sftpErrorCode
           
private  java.lang.String sftpErrorMessage
           
 
Constructor Summary
SFTPException(java.lang.String msg, int errorCode)
           
 
Method Summary
private static java.lang.String constructMessage(java.lang.String s, int errorCode)
           
 int getServerErrorCode()
          Get the error code sent by the server.
 java.lang.String getServerErrorCodeSymbol()
          Get the symbolic name of the error code as given in the SFTP specs.
 java.lang.String getServerErrorCodeVerbose()
          Get the description of the error code as given in the SFTP specs.
 java.lang.String getServerErrorMessage()
          Get the error message sent by the server.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, 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

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

sftpErrorMessage

private final java.lang.String sftpErrorMessage

sftpErrorCode

private final int sftpErrorCode
Constructor Detail

SFTPException

SFTPException(java.lang.String msg,
              int errorCode)
Method Detail

constructMessage

private static java.lang.String constructMessage(java.lang.String s,
                                                 int errorCode)

getServerErrorMessage

public java.lang.String 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

public java.lang.String getServerErrorCodeSymbol()
Get the symbolic name of the error code as given in the SFTP specs.

Returns:
e.g., "SSH_FX_INVALID_FILENAME".

getServerErrorCodeVerbose

public java.lang.String getServerErrorCodeVerbose()
Get the description of the error code as given in the SFTP specs.

Returns:
e.g., "The filename is not valid."