aboutsummaryrefslogtreecommitdiffstats
path: root/src/com/trilead/ssh2/SFTPException.java
diff options
context:
space:
mode:
authorKenny Root <kenny@the-b.org>2007-11-17 05:58:42 +0000
committerKenny Root <kenny@the-b.org>2007-11-17 05:58:42 +0000
commitdfa41d090260eed63f3d8510571a2f6236a5ff45 (patch)
tree1eaca308ba9bb913161edf83bfef5f9295784e56 /src/com/trilead/ssh2/SFTPException.java
parentedfccaafe3e754ed124afa67465b6044eacd3987 (diff)
downloadconnectbot-dfa41d090260eed63f3d8510571a2f6236a5ff45.tar.gz
connectbot-dfa41d090260eed63f3d8510571a2f6236a5ff45.tar.bz2
connectbot-dfa41d090260eed63f3d8510571a2f6236a5ff45.zip
Initial import.
Diffstat (limited to 'src/com/trilead/ssh2/SFTPException.java')
-rw-r--r--src/com/trilead/ssh2/SFTPException.java91
1 files changed, 91 insertions, 0 deletions
diff --git a/src/com/trilead/ssh2/SFTPException.java b/src/com/trilead/ssh2/SFTPException.java
new file mode 100644
index 0000000..f3b6d3e
--- /dev/null
+++ b/src/com/trilead/ssh2/SFTPException.java
@@ -0,0 +1,91 @@
+
+package com.trilead.ssh2;
+
+import java.io.IOException;
+
+import com.trilead.ssh2.sftp.ErrorCodes;
+
+
+/**
+ * Used in combination with the SFTPv3Client. This exception wraps
+ * error messages sent by the SFTP server.
+ *
+ * @author Christian Plattner, plattner@trilead.com
+ * @version $Id: SFTPException.java,v 1.1 2007/10/15 12:49:56 cplattne Exp $
+ */
+
+public class SFTPException extends IOException
+{
+ private static final long serialVersionUID = 578654644222421811L;
+
+ private final String sftpErrorMessage;
+ private final int sftpErrorCode;
+
+ private static String constructMessage(String s, int errorCode)
+ {
+ String[] detail = ErrorCodes.getDescription(errorCode);
+
+ if (detail == null)
+ return s + " (UNKNOW SFTP ERROR CODE)";
+
+ return s + " (" + detail[0] + ": " + detail[1] + ")";
+ }
+
+ SFTPException(String msg, int errorCode)
+ {
+ super(constructMessage(msg, errorCode));
+ sftpErrorMessage = msg;
+ sftpErrorCode = errorCode;
+ }
+
+ /**
+ * Get the error message sent by the server. Often, this
+ * message does not help a lot (e.g., "failure").
+ *
+ * @return the plain string as sent by the server.
+ */
+ public String getServerErrorMessage()
+ {
+ return sftpErrorMessage;
+ }
+
+ /**
+ * Get the error code sent by the server.
+ *
+ * @return an error code as defined in the SFTP specs.
+ */
+ public int getServerErrorCode()
+ {
+ return sftpErrorCode;
+ }
+
+ /**
+ * Get the symbolic name of the error code as given in the SFTP specs.
+ *
+ * @return e.g., "SSH_FX_INVALID_FILENAME".
+ */
+ public String getServerErrorCodeSymbol()
+ {
+ String[] detail = ErrorCodes.getDescription(sftpErrorCode);
+
+ if (detail == null)
+ return "UNKNOW SFTP ERROR CODE " + sftpErrorCode;
+
+ return detail[0];
+ }
+
+ /**
+ * Get the description of the error code as given in the SFTP specs.
+ *
+ * @return e.g., "The filename is not valid."
+ */
+ public String getServerErrorCodeVerbose()
+ {
+ String[] detail = ErrorCodes.getDescription(sftpErrorCode);
+
+ if (detail == null)
+ return "The error code " + sftpErrorCode + " is unknown.";
+
+ return detail[1];
+ }
+}