FTPException.java

/*
 *  This file is part of the Heritrix web crawler (crawler.archive.org).
 *
 *  Licensed to the Internet Archive (IA) by one or more individual 
 *  contributors. 
 *
 *  The IA licenses this file to You 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.archive.net;

import java.io.IOException;

/**
 * Indicates that a FTP operation failed due to a protocol violation.
 * For instance, if authentication fails.
 * 
 * @author pjack
 */
public class FTPException extends IOException {
    private static final long serialVersionUID = 1L;
    
    /**
     * The reply code from the FTP server.
     */
    private int code;
    
    /**
     * Constructs a new <code>FTPException</code>.
     * 
     * @param code  the error code from the FTP server
     */
    public FTPException(int code) {
        super("FTP error code: " + code);
        this.code = code;
    }


    /**
     * Returns the error code from the FTP server.
     * 
     * @return  the error code from the FTP server
     */
    public int getReplyCode() {
        return code;
    }
}