org.apache.ftpserver.impl

Class LocalizedDataTransferFtpReply

java.lang.Object

org.apache.ftpserver.ftplet.DefaultFtpReply

org.apache.ftpserver.impl.LocalizedFtpReply

org.apache.ftpserver.impl.LocalizedDataTransferFtpReply

All Implemented Interfaces:

DataTransferFtpReply, FileActionFtpReply, FtpReply

public class LocalizedDataTransferFtpReply
extends LocalizedFtpReply
implements DataTransferFtpReply

An implementation of DataTransferReply.

Author:

Apache MINA Project

Field Summary

Fields inherited from interface org.apache.ftpserver.ftplet.FtpReply

REPLY_110_RESTART_MARKER_REPLY, REPLY_120_SERVICE_READY_IN_NNN_MINUTES, REPLY_125_DATA_CONNECTION_ALREADY_OPEN, REPLY_150_FILE_STATUS_OKAY, REPLY_200_COMMAND_OKAY, REPLY_202_COMMAND_NOT_IMPLEMENTED, REPLY_211_SYSTEM_STATUS_REPLY, REPLY_212_DIRECTORY_STATUS, REPLY_213_FILE_STATUS, REPLY_214_HELP_MESSAGE, REPLY_215_NAME_SYSTEM_TYPE, REPLY_220_SERVICE_READY, REPLY_221_CLOSING_CONTROL_CONNECTION, REPLY_225_DATA_CONNECTION_OPEN_NO_TRANSFER_IN_PROGRESS, REPLY_226_CLOSING_DATA_CONNECTION, REPLY_227_ENTERING_PASSIVE_MODE, REPLY_230_USER_LOGGED_IN, REPLY_250_REQUESTED_FILE_ACTION_OKAY, REPLY_257_PATHNAME_CREATED, REPLY_331_USER_NAME_OKAY_NEED_PASSWORD, REPLY_332_NEED_ACCOUNT_FOR_LOGIN, REPLY_350_REQUESTED_FILE_ACTION_PENDING_FURTHER_INFORMATION, REPLY_421_SERVICE_NOT_AVAILABLE_CLOSING_CONTROL_CONNECTION, REPLY_425_CANT_OPEN_DATA_CONNECTION, REPLY_426_CONNECTION_CLOSED_TRANSFER_ABORTED, REPLY_450_REQUESTED_FILE_ACTION_NOT_TAKEN, REPLY_451_REQUESTED_ACTION_ABORTED, REPLY_452_REQUESTED_ACTION_NOT_TAKEN, REPLY_500_SYNTAX_ERROR_COMMAND_UNRECOGNIZED, REPLY_501_SYNTAX_ERROR_IN_PARAMETERS_OR_ARGUMENTS, REPLY_502_COMMAND_NOT_IMPLEMENTED, REPLY_503_BAD_SEQUENCE_OF_COMMANDS, REPLY_504_COMMAND_NOT_IMPLEMENTED_FOR_THAT_PARAMETER, REPLY_530_NOT_LOGGED_IN, REPLY_532_NEED_ACCOUNT_FOR_STORING_FILES, REPLY_550_REQUESTED_ACTION_NOT_TAKEN, REPLY_551_REQUESTED_ACTION_ABORTED_PAGE_TYPE_UNKNOWN, REPLY_552_REQUESTED_FILE_ACTION_ABORTED_EXCEEDED_STORAGE, REPLY_553_REQUESTED_ACTION_NOT_TAKEN_FILE_NAME_NOT_ALLOWED

Constructor Summary

Constructors

Constructor and Description
LocalizedDataTransferFtpReply(int code, String message, FtpFile file, long bytesTransferred) Creates a new instance of LocalizedFileTransferReply.

Method Summary

Modifier and Type	Method and Description
long	getBytesTransferred() Returns the number of bytes transferred.
FtpFile	getFile() Returns the file (or directory) on which the action was taken (e.g.
static LocalizedDataTransferFtpReply	translate(FtpIoSession session, FtpRequest request, FtpServerContext context, int code, String subId, String basicMsg, FtpFile file) Returns the localized reply that contains all details about the data transfer.
static LocalizedDataTransferFtpReply	translate(FtpIoSession session, FtpRequest request, FtpServerContext context, int code, String subId, String basicMsg, FtpFile file, long bytesTransferred) Returns the localized reply that contains all details about the data transfer.

Methods inherited from class org.apache.ftpserver.impl.LocalizedFtpReply

translate

Methods inherited from class org.apache.ftpserver.ftplet.DefaultFtpReply

getCode, getMessage, getSentTime, isPositive, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.ftpserver.ftplet.FtpReply

getCode, getMessage, getSentTime, isPositive, toString

Constructor Detail

LocalizedDataTransferFtpReply

public LocalizedDataTransferFtpReply(int code,
                                     String message,
                                     FtpFile file,
                                     long bytesTransferred)

Creates a new instance of LocalizedFileTransferReply.

Parameters:

code - the reply code

message - the detailed message

file - the file or directory the data transfer is related to

bytesTransferred - the number of bytes transferred

Method Detail

getFile

public FtpFile getFile()

Description copied from interface: FileActionFtpReply

Returns the file (or directory) on which the action was taken (e.g. uploaded, created, listed)

Specified by:

getFile in interface FileActionFtpReply

Returns:

the file on which the action was taken. May return null, if the file information is not available.

getBytesTransferred

public long getBytesTransferred()

Description copied from interface: DataTransferFtpReply

Returns the number of bytes transferred.

Specified by:

getBytesTransferred in interface DataTransferFtpReply

Returns:

the number of bytes transferred.

translate

public static LocalizedDataTransferFtpReply translate(FtpIoSession session,
                                                      FtpRequest request,
                                                      FtpServerContext context,
                                                      int code,
                                                      String subId,
                                                      String basicMsg,
                                                      FtpFile file)

Returns the localized reply that contains all details about the data transfer.

Parameters:

session - the FTP session

request - the FTP request

context - the FTP server context

code - the reply code

subId - the sub message ID

basicMsg - the basic message

file - the file or directory that was transferred

Returns:

the localized reply

translate

public static LocalizedDataTransferFtpReply translate(FtpIoSession session,
                                                      FtpRequest request,
                                                      FtpServerContext context,
                                                      int code,
                                                      String subId,
                                                      String basicMsg,
                                                      FtpFile file,
                                                      long bytesTransferred)

Returns the localized reply that contains all details about the data transfer.

Parameters:

session - the FTP session

request - the FTP request

context - the FTP server context

code - the reply code

subId - the sub message ID

basicMsg - the basic message

file - the file or directory that was transferred

bytesTransferred - total number of bytes transferred

Returns:

the localized reply