org.apache.ftpserver.ftplet.DataConnection 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;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

/**
 *
 * @author Apache MINA Project
 */
public interface DataConnection {

    /**
     * Transfer data from the client (e.g. STOR).
     * @param session The current {@link FtpSession}
     * @param out
     *            The {@link OutputStream} containing the destination of the
     *            data from the client.
     * @return The length of the transferred data
     * @throws IOException
     */
    long transferFromClient(FtpSession session, OutputStream out)
            throws IOException;

    /**
     * Transfer data to the client (e.g. RETR).
     * @param session The current {@link FtpSession}
     * @param in
     *            Data to be transfered to the client
     * @return The length of the transferred data
     * @throws IOException
     */
    long transferToClient(FtpSession session, InputStream in)
            throws IOException;

    /**
     * Transfer a string to the client, e.g. during LIST
     * @param session The current {@link FtpSession}
     * @param str
     *            The string to transfer
     * @throws IOException
     */
    void transferToClient(FtpSession session, String str) throws IOException;

}