/*
 * Copyright (c) 2006-2011 Christian Plattner. All rights reserved.
 * Please refer to the LICENSE.txt for licensing details.
 */
package ch.ethz.ssh2.sftp;

/**
 * SFTP Error Codes
 *
 * @author Christian Plattner
 * @version 2.50, 03/15/10
 */
public final class ErrorCodes {
    private ErrorCodes() {
    }

    public static final int SSH_FX_OK = 0;
    public static final int SSH_FX_EOF = 1;
    public static final int SSH_FX_NO_SUCH_FILE = 2;
    public static final int SSH_FX_PERMISSION_DENIED = 3;
    public static final int SSH_FX_FAILURE = 4;
    public static final int SSH_FX_BAD_MESSAGE = 5;
    public static final int SSH_FX_NO_CONNECTION = 6;
    public static final int SSH_FX_CONNECTION_LOST = 7;
    /**
     * The server MUST respond with SSH_FXP_STATUS(SSH_FX_OP_UNSUPPORTED) if
     * it receives a packet it does not recognize.
     */
    public static final int SSH_FX_OP_UNSUPPORTED = 8;
    public static final int SSH_FX_INVALID_HANDLE = 9;
    public static final int SSH_FX_NO_SUCH_PATH = 10;
    public static final int SSH_FX_FILE_ALREADY_EXISTS = 11;
    public static final int SSH_FX_WRITE_PROTECT = 12;
    public static final int SSH_FX_NO_MEDIA = 13;
    public static final int SSH_FX_NO_SPACE_ON_FILESYSTEM = 14;
    public static final int SSH_FX_QUOTA_EXCEEDED = 15;
    public static final int SSH_FX_UNKNOWN_PRINCIPAL = 16;
    public static final int SSH_FX_LOCK_CONFLICT = 17;
    public static final int SSH_FX_DIR_NOT_EMPTY = 18;
    public static final int SSH_FX_NOT_A_DIRECTORY = 19;
    public static final int SSH_FX_INVALID_FILENAME = 20;
    public static final int SSH_FX_LINK_LOOP = 21;
    public static final int SSH_FX_CANNOT_DELETE = 22;
    public static final int SSH_FX_INVALID_PARAMETER = 23;
    public static final int SSH_FX_FILE_IS_A_DIRECTORY = 24;
    public static final int SSH_FX_BYTE_RANGE_LOCK_CONFLICT = 25;
    public static final int SSH_FX_BYTE_RANGE_LOCK_REFUSED = 26;
    public static final int SSH_FX_DELETE_PENDING = 27;
    public static final int SSH_FX_FILE_CORRUPT = 28;
    public static final int SSH_FX_OWNER_INVALID = 29;
    public static final int SSH_FX_GROUP_INVALID = 30;
    public static final int SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK = 31;

    private static final String[][] messages = {

            {"SSH_FX_OK", "Indicates successful completion of the operation."},
            {"SSH_FX_EOF",
                    "An attempt to read past the end-of-file was made; or, there are no more directory entries to return."},
            {"SSH_FX_NO_SUCH_FILE", "A reference was made to a file which does not exist."},
            {"SSH_FX_PERMISSION_DENIED", "The user does not have sufficient permissions to perform the operation."},
            {"SSH_FX_FAILURE", "An error occurred, but no specific error code exists to describe the failure."},
            {"SSH_FX_BAD_MESSAGE", "A badly formatted packet or other SFTP protocol incompatibility was detected."},
            {"SSH_FX_NO_CONNECTION", "There is no connection to the server."},
            {"SSH_FX_CONNECTION_LOST", "The connection to the server was lost."},
            {"SSH_FX_OP_UNSUPPORTED",
                    "An attempted operation could not be completed by the server because the server does not support the operation."},
            {"SSH_FX_INVALID_HANDLE", "The handle value was invalid."},
            {"SSH_FX_NO_SUCH_PATH", "The file path does not exist or is invalid."},
            {"SSH_FX_FILE_ALREADY_EXISTS", "The file already exists."},
            {"SSH_FX_WRITE_PROTECT", "The file is on read-only media, or the media is write protected."},
            {"SSH_FX_NO_MEDIA",
                    "The requested operation cannot be completed because there is no media available in the drive."},
            {"SSH_FX_NO_SPACE_ON_FILESYSTEM",
                    "The requested operation cannot be completed because there is insufficient free space on the filesystem."},
            {"SSH_FX_QUOTA_EXCEEDED",
                    "The operation cannot be completed because it would exceed the user's storage quota."},
            {
                    "SSH_FX_UNKNOWN_PRINCIPAL",
                    "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."},
            {"SSH_FX_LOCK_CONFLICT", "The file could not be opened because it is locked by another process."},
            {"SSH_FX_DIR_NOT_EMPTY", "The directory is not empty."},
            {"SSH_FX_NOT_A_DIRECTORY", "The specified file is not a directory."},
            {"SSH_FX_INVALID_FILENAME", "The filename is not valid."},
            {"SSH_FX_LINK_LOOP",
                    "Too many symbolic links encountered or, an SSH_FXF_NOFOLLOW open encountered a symbolic link as the final component."},
            {"SSH_FX_CANNOT_DELETE",
                    "The file cannot be deleted. One possible reason is that the advisory READONLY attribute-bit is set."},
            {"SSH_FX_INVALID_PARAMETER",
                    "One of the parameters was out of range, or the parameters specified cannot be used together."},
            {"SSH_FX_FILE_IS_A_DIRECTORY",
                    "The specified file was a directory in a context where a directory cannot be used."},
            {"SSH_FX_BYTE_RANGE_LOCK_CONFLICT",
                    " A read or write operation failed because another process's mandatory byte-range lock overlaps with the request."},
            {"SSH_FX_BYTE_RANGE_LOCK_REFUSED", "A request for a byte range lock was refused."},
            {"SSH_FX_DELETE_PENDING", "An operation was attempted on a file for which a delete operation is pending."},
            {"SSH_FX_FILE_CORRUPT", "The file is corrupt; an filesystem integrity check should be run."},
            {"SSH_FX_OWNER_INVALID", "The principal specified can not be assigned as an owner of a file."},
            {"SSH_FX_GROUP_INVALID", "The principal specified can not be assigned as the primary group of a file."},
            {"SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK",
                    "The requested operation could not be completed because the	specifed byte range lock has not been granted."},

    };

    public static final String[] getDescription(int errorCode) {
        if((errorCode < 0) || (errorCode >= messages.length)) {
            return null;
        }

        return messages[errorCode];
    }
}