/*
 * Copyright 1999-2006 University of Chicago
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.dcache.ftp.client.exception;

/**
 * Indicates that operation failed because of conditions
 * on the server, independent from the client. For instance,
 * the server did not understand command, or could not read file.
 * Note that here "server" can mean either a remote server,
 * or the local internal server (FTPServerFacade).
 **/
public class ServerException extends FTPException
{
    private static final long serialVersionUID = 5580992642770614098L;

    /**
     * Server refused performing the request
     **/
    public static final int SERVER_REFUSED = 1;
    /**
     * The communication from the server was not understood,
     * possibly because of incompatible protocol.
     **/
    public static final int WRONG_PROTOCOL = 2;
    public static final int UNSUPPORTED_FEATURE = 3;
    public static final int REPLY_TIMEOUT = 4;
    public static final int PREVIOUS_TRANSFER_ACTIVE = 5;

    private static final String[] codeExplained;

    static {
        codeExplained = new String[]
                {"Unspecified category.",
                        "Server refused performing the request.",
                        "The server uses unknown communication protool.",
                        "Server does not support feature.",
                        "Reply wait timeout.",
                        "Refusing to start transfer before previous transfer completes"};
    }

    @Override
    public String getCodeExplanation(int code)
    {
        if (codeExplained.length > code)
            return codeExplained[code];
        else return "";
    }


    protected int code = UNSPECIFIED;

    //this message is not just explanation of the code.
    //it is a custom message informing of particular 
    //conditions of the error.
    protected String customMessage;

    public ServerException(int code, String message)
    {
        super(code, message);
        customMessage = message;
    }

    public ServerException(int code)
    {
        super(code);
    }

    /**
     * Constructs server exception with FTPReplyParseException
     * nested in it.
     **/
    public static ServerException embedFTPReplyParseException(
            FTPReplyParseException rpe,
            String message)
    {
        ServerException se = new ServerException(
                WRONG_PROTOCOL,
                message);
        se.setRootCause(rpe);
        return se;
    }

    public static ServerException embedFTPReplyParseException(
            FTPReplyParseException rpe)
    {
        return embedFTPReplyParseException(rpe, "");
    }


    /**
     * Constructs server exception with UnexpectedReplyCodeException
     * nested in it.
     **/
    public static ServerException embedUnexpectedReplyCodeException(
            UnexpectedReplyCodeException urce,
            String message)
    {
        ServerException se = new ServerException(
                SERVER_REFUSED,
                message);
        se.setRootCause(urce);
        return se;
    }

    public static ServerException embedUnexpectedReplyCodeException(
            UnexpectedReplyCodeException urce)
    {
        return embedUnexpectedReplyCodeException(urce, "");
    }
}