org.apache.ftpserver.ftplet.FtpException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ftplet-api Show documentation

Ftplets are, similar to servlets, an API to plug into the request lifecycle of FtpServer. Ftplets are called on session connect and disconnect as well as before and after each command within a user session.

There is a newer version: 1.2.0

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.apache.ftpserver.ftplet;


/**
 * Ftplet exception class.
 *
 * @author Apache MINA Project
 */
public class FtpException extends Exception {

    private static final long serialVersionUID = -1328383839915898987L;

    /**
     * Default constructor.
     */
    public FtpException() {
        super();
    }

    /**
     * Constructs a FtpException object with a message.
     * 
     * @param msg
     *            a description of the exception
     */
    public FtpException(String msg) {
        super(msg);
    }

    /**
     * Constructs a FtpException object with a
     * Throwable cause.
     * 
     * @param th
     *            the original cause
     */
    public FtpException(Throwable th) {
        super(th.getMessage());
    }

    /**
     * Constructs a BaseException object with a
     * Throwable cause.
     * @param msg A description of the exception
     * 
     * @param th
     *            The original cause
     */
    public FtpException(String msg, Throwable th) {
        super(msg);
    }

    /**
     * Get the root cause.
     * @return The root cause
     * @deprecated Use {@link Exception#getCause()} instead
     */
    public Throwable getRootCause() {
        return getCause();
    }
}