ftplet-api/src/main/java/org/apache/ftpserver/ftplet/DataTransferFtpReply.java

/*
 * 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;

/**
 * A more specific type of FTP reply that is sent by the commands that transfer
 * data over the data connection. These commands include LIST, RETR, STOR, STOU
 * etc.
 * 
 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
 * 
 */

public interface DataTransferFtpReply extends FtpReply {

	/**
	 * Returns the file that was transferred (uploaded, downloaded or the
	 * directory that was listed).
	 * 
	 * @return the file that was transferred (uploaded, downloaded or the
	 *         directory that was listed). May return <code>null</code>, if
	 *         the file information is not available because the request was bad
	 *         or any other reason.
	 */
	FtpFile getFile();

	/**
	 * Returns the number of bytes transferred.
	 * 
	 * @return the number of bytes transferred.
	 */
	long getBytesTransferred();

}