Home | History | Annotate | Download | only in sftp
      1 /*
      2  * Copyright (c) 2006-2011 Christian Plattner. All rights reserved.
      3  * Please refer to the LICENSE.txt for licensing details.
      4  */
      5 package ch.ethz.ssh2.sftp;
      6 
      7 /**
      8  *
      9  * SFTP Error Codes
     10  *
     11  * @author Christian Plattner
     12  * @version 2.50, 03/15/10
     13  *
     14  */
     15 public class ErrorCodes
     16 {
     17 	public static final int SSH_FX_OK = 0;
     18 	public static final int SSH_FX_EOF = 1;
     19 	public static final int SSH_FX_NO_SUCH_FILE = 2;
     20 	public static final int SSH_FX_PERMISSION_DENIED = 3;
     21 	public static final int SSH_FX_FAILURE = 4;
     22 	public static final int SSH_FX_BAD_MESSAGE = 5;
     23 	public static final int SSH_FX_NO_CONNECTION = 6;
     24 	public static final int SSH_FX_CONNECTION_LOST = 7;
     25 	public static final int SSH_FX_OP_UNSUPPORTED = 8;
     26 	public static final int SSH_FX_INVALID_HANDLE = 9;
     27 	public static final int SSH_FX_NO_SUCH_PATH = 10;
     28 	public static final int SSH_FX_FILE_ALREADY_EXISTS = 11;
     29 	public static final int SSH_FX_WRITE_PROTECT = 12;
     30 	public static final int SSH_FX_NO_MEDIA = 13;
     31 	public static final int SSH_FX_NO_SPACE_ON_FILESYSTEM = 14;
     32 	public static final int SSH_FX_QUOTA_EXCEEDED = 15;
     33 	public static final int SSH_FX_UNKNOWN_PRINCIPAL = 16;
     34 	public static final int SSH_FX_LOCK_CONFLICT = 17;
     35 	public static final int SSH_FX_DIR_NOT_EMPTY = 18;
     36 	public static final int SSH_FX_NOT_A_DIRECTORY = 19;
     37 	public static final int SSH_FX_INVALID_FILENAME = 20;
     38 	public static final int SSH_FX_LINK_LOOP = 21;
     39 	public static final int SSH_FX_CANNOT_DELETE = 22;
     40 	public static final int SSH_FX_INVALID_PARAMETER = 23;
     41 	public static final int SSH_FX_FILE_IS_A_DIRECTORY = 24;
     42 	public static final int SSH_FX_BYTE_RANGE_LOCK_CONFLICT = 25;
     43 	public static final int SSH_FX_BYTE_RANGE_LOCK_REFUSED = 26;
     44 	public static final int SSH_FX_DELETE_PENDING = 27;
     45 	public static final int SSH_FX_FILE_CORRUPT = 28;
     46 	public static final int SSH_FX_OWNER_INVALID = 29;
     47 	public static final int SSH_FX_GROUP_INVALID = 30;
     48 	public static final int SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK = 31;
     49 
     50 	private static final String[][] messages = {
     51 
     52 			{ "SSH_FX_OK", "Indicates successful completion of the operation." },
     53 			{ "SSH_FX_EOF",
     54 					"An attempt to read past the end-of-file was made; or, there are no more directory entries to return." },
     55 			{ "SSH_FX_NO_SUCH_FILE", "A reference was made to a file which does not exist." },
     56 			{ "SSH_FX_PERMISSION_DENIED", "The user does not have sufficient permissions to perform the operation." },
     57 			{ "SSH_FX_FAILURE", "An error occurred, but no specific error code exists to describe the failure." },
     58 			{ "SSH_FX_BAD_MESSAGE", "A badly formatted packet or other SFTP protocol incompatibility was detected." },
     59 			{ "SSH_FX_NO_CONNECTION", "There is no connection to the server." },
     60 			{ "SSH_FX_CONNECTION_LOST", "The connection to the server was lost." },
     61 			{ "SSH_FX_OP_UNSUPPORTED",
     62 					"An attempted operation could not be completed by the server because the server does not support the operation." },
     63 			{ "SSH_FX_INVALID_HANDLE", "The handle value was invalid." },
     64 			{ "SSH_FX_NO_SUCH_PATH", "The file path does not exist or is invalid." },
     65 			{ "SSH_FX_FILE_ALREADY_EXISTS", "The file already exists." },
     66 			{ "SSH_FX_WRITE_PROTECT", "The file is on read-only media, or the media is write protected." },
     67 			{ "SSH_FX_NO_MEDIA",
     68 					"The requested operation cannot be completed because there is no media available in the drive." },
     69 			{ "SSH_FX_NO_SPACE_ON_FILESYSTEM",
     70 					"The requested operation cannot be completed because there is insufficient free space on the filesystem." },
     71 			{ "SSH_FX_QUOTA_EXCEEDED",
     72 					"The operation cannot be completed because it would exceed the user's storage quota." },
     73 			{
     74 					"SSH_FX_UNKNOWN_PRINCIPAL",
     75 					"A principal referenced by the request (either the 'owner', 'group', or 'who' field of an ACL), was unknown. The error specific data contains the problematic names." },
     76 			{ "SSH_FX_LOCK_CONFLICT", "The file could not be opened because it is locked by another process." },
     77 			{ "SSH_FX_DIR_NOT_EMPTY", "The directory is not empty." },
     78 			{ "SSH_FX_NOT_A_DIRECTORY", "The specified file is not a directory." },
     79 			{ "SSH_FX_INVALID_FILENAME", "The filename is not valid." },
     80 			{ "SSH_FX_LINK_LOOP",
     81 					"Too many symbolic links encountered or, an SSH_FXF_NOFOLLOW open encountered a symbolic link as the final component." },
     82 			{ "SSH_FX_CANNOT_DELETE",
     83 					"The file cannot be deleted. One possible reason is that the advisory READONLY attribute-bit is set." },
     84 			{ "SSH_FX_INVALID_PARAMETER",
     85 					"One of the parameters was out of range, or the parameters specified cannot be used together." },
     86 			{ "SSH_FX_FILE_IS_A_DIRECTORY",
     87 					"The specified file was a directory in a context where a directory cannot be used." },
     88 			{ "SSH_FX_BYTE_RANGE_LOCK_CONFLICT",
     89 					" A read or write operation failed because another process's mandatory byte-range lock overlaps with the request." },
     90 			{ "SSH_FX_BYTE_RANGE_LOCK_REFUSED", "A request for a byte range lock was refused." },
     91 			{ "SSH_FX_DELETE_PENDING", "An operation was attempted on a file for which a delete operation is pending." },
     92 			{ "SSH_FX_FILE_CORRUPT", "The file is corrupt; an filesystem integrity check should be run." },
     93 			{ "SSH_FX_OWNER_INVALID", "The principal specified can not be assigned as an owner of a file." },
     94 			{ "SSH_FX_GROUP_INVALID", "The principal specified can not be assigned as the primary group of a file." },
     95 			{ "SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK",
     96 					"The requested operation could not be completed because the	specifed byte range lock has not been granted." },
     97 
     98 	};
     99 
    100 	public static final String[] getDescription(int errorCode)
    101 	{
    102 		if ((errorCode < 0) || (errorCode >= messages.length))
    103 			return null;
    104 
    105 		return messages[errorCode];
    106 	}
    107 }
    108