Home | History | Annotate | Download | only in ftp
      1 /*
      2  * Copyright (c) 1994, 2009, Oracle and/or its affiliates. All rights reserved.
      3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
      4  *
      5  * This code is free software; you can redistribute it and/or modify it
      6  * under the terms of the GNU General Public License version 2 only, as
      7  * published by the Free Software Foundation.  Oracle designates this
      8  * particular file as subject to the "Classpath" exception as provided
      9  * by Oracle in the LICENSE file that accompanied this code.
     10  *
     11  * This code is distributed in the hope that it will be useful, but WITHOUT
     12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
     13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
     14  * version 2 for more details (a copy is included in the LICENSE file that
     15  * accompanied this code).
     16  *
     17  * You should have received a copy of the GNU General Public License version
     18  * 2 along with this work; if not, write to the Free Software Foundation,
     19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
     20  *
     21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
     22  * or visit www.oracle.com if you need additional information or have any
     23  * questions.
     24  */
     25 package sun.net.ftp;
     26 
     27 /**
     28  * Thrown to indicate that the FTP server reported an error.
     29  * For instance that the requested file doesn't exist or
     30  * that a command isn't supported.
     31  * <p>The specific error code can be retreived with {@link #getReplyCode() }.</p>
     32  * @author      Jonathan Payne
     33  */
     34 public class FtpProtocolException extends Exception {
     35     private static final long serialVersionUID = 5978077070276545054L;
     36     private final FtpReplyCode code;
     37 
     38     /**
     39      * Constructs a new {@code FtpProtocolException} from the
     40      * specified detail message. The reply code is set to unknow error.
     41      *
     42      * @param   detail   the detail message.
     43      */
     44     public FtpProtocolException(String detail) {
     45             super(detail);
     46             code = FtpReplyCode.UNKNOWN_ERROR;
     47     }
     48 
     49     /**
     50      * Constructs a new {@code FtpProtocolException} from the
     51      * specified response code and exception detail message
     52      *
     53      * @param   detail   the detail message.
     54      * @param   code The {@code FtpRelyCode} received from server.
     55      */
     56       public FtpProtocolException(String detail, FtpReplyCode code) {
     57         super(detail);
     58         this.code = code;
     59     }
     60 
     61     /**
     62      * Gets the reply code sent by the server that led to this exception
     63      * being thrown.
     64      *
     65      * @return The {@link FtpReplyCode} associated with that exception.
     66      */
     67     public FtpReplyCode getReplyCode() {
     68         return code;
     69     }
     70 }
     71