org.mockftpserver.stub.command

Class RetrCommandHandler

java.lang.Object

org.mockftpserver.core.command.AbstractCommandHandler

org.mockftpserver.core.command.AbstractTrackingCommandHandler

org.mockftpserver.stub.command.AbstractStubDataCommandHandler

org.mockftpserver.stub.command.RetrCommandHandler

All Implemented Interfaces:

CommandHandler, InvocationHistory, ReplyTextBundleAware

public class RetrCommandHandler
extends AbstractStubDataCommandHandler
implements CommandHandler

CommandHandler for the RETR (Retrieve) command. Return the configured file contents on the data connection, along with two replies on the control connection: a reply code of 150 and another of 226. By default, return an empty file (i.e., a zero-length byte[]). You can customize the returned file contents by setting the fileContents property, specified either as a String or as a byte array.

Each invocation record stored by this CommandHandler includes the following data element key/values:

• PATHNAME_KEY ("pathname") - the pathname of the file submitted on the invocation (the first command parameter)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PATHNAME_KEY

Fields inherited from class org.mockftpserver.stub.command.AbstractStubDataCommandHandler

finalReplyCode, finalReplyMessageKey, finalReplyText, preliminaryReplyCode, preliminaryReplyMessageKey, preliminaryReplyText

Fields inherited from class org.mockftpserver.core.command.AbstractCommandHandler

LOG

Constructor Summary

Constructors

Constructor and Description
RetrCommandHandler() Create new uninitialized instance
RetrCommandHandler(byte[] fileContents) Create new instance using the specified fileContents
RetrCommandHandler(java.lang.String fileContents) Create new instance using the specified fileContents

Method Summary

Modifier and Type	Method and Description
protected void	beforeProcessData(Command command, Session session, InvocationRecord invocationRecord) Perform any necessary logic before transferring data across the data connection.
protected void	processData(Command command, Session session, InvocationRecord invocationRecord) Abstract method placeholder for subclass transfer of data across the data connection.
void	setFileContents(byte[] fileContents) Set the file contents to return from subsequent command invocations
void	setFileContents(java.lang.String fileContents) Set the file contents to return from subsequent command invocations

Methods inherited from class org.mockftpserver.stub.command.AbstractStubDataCommandHandler

afterProcessData, handleCommand, sendFinalReply, setFinalReplyCode, setFinalReplyMessageKey, setFinalReplyText, setPreliminaryReplyCode, setPreliminaryReplyMessageKey, setPreliminaryReplyText

Methods inherited from class org.mockftpserver.core.command.AbstractTrackingCommandHandler

clearInvocations, getInvocation, handleCommand, numberOfInvocations, sendReply

Methods inherited from class org.mockftpserver.core.command.AbstractCommandHandler

assertValidReplyCode, getReplyTextBundle, quotes, setReplyTextBundle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mockftpserver.core.command.CommandHandler

handleCommand

Field Detail

PATHNAME_KEY

public static final java.lang.String PATHNAME_KEY

See Also:

Constant Field Values

Constructor Detail

RetrCommandHandler

public RetrCommandHandler()

Create new uninitialized instance

RetrCommandHandler

public RetrCommandHandler(java.lang.String fileContents)

Create new instance using the specified fileContents

Parameters:

fileContents - - the file contents

Throws:

AssertFailedException - - if the fileContents is null

RetrCommandHandler

public RetrCommandHandler(byte[] fileContents)

Create new instance using the specified fileContents

Parameters:

fileContents - - the file contents

Throws:

AssertFailedException - - if the fileContents is null

Method Detail

beforeProcessData

protected void beforeProcessData(Command command,
                                 Session session,
                                 InvocationRecord invocationRecord)
                          throws java.lang.Exception

Description copied from class: AbstractStubDataCommandHandler

Perform any necessary logic before transferring data across the data connection. Do nothing by default. Subclasses should override to validate command parameters and store information in the InvocationRecord.

Overrides:

beforeProcessData in class AbstractStubDataCommandHandler

Parameters:

command - - the Command to be handled

session - - the session on which the Command was submitted

invocationRecord - - the InvocationRecord; CommandHandlers are expected to add handler-specific data to the InvocationRecord, as appropriate

Throws:

java.lang.Exception - - if an error occurs

See Also:

AbstractStubDataCommandHandler.beforeProcessData(org.mockftpserver.core.command.Command, org.mockftpserver.core.session.Session, org.mockftpserver.core.command.InvocationRecord)

processData

protected void processData(Command command,
                           Session session,
                           InvocationRecord invocationRecord)

Description copied from class: AbstractStubDataCommandHandler

Abstract method placeholder for subclass transfer of data across the data connection. Subclasses must override. The data connection is opened before this method and is closed after this method completes.

Specified by:

processData in class AbstractStubDataCommandHandler

Parameters:

command - - the Command to be handled

session - - the session on which the Command was submitted

invocationRecord - - the InvocationRecord; CommandHandlers are expected to add handler-specific data to the InvocationRecord, as appropriate

See Also:

AbstractStubDataCommandHandler.processData(org.mockftpserver.core.command.Command, org.mockftpserver.core.session.Session, org.mockftpserver.core.command.InvocationRecord)

setFileContents

public void setFileContents(java.lang.String fileContents)

Set the file contents to return from subsequent command invocations

Parameters:

fileContents - - the fileContents to set

Throws:

AssertFailedException - - if the fileContents is null

setFileContents

public void setFileContents(byte[] fileContents)

Set the file contents to return from subsequent command invocations

Parameters:

fileContents - - the file contents

Throws:

AssertFailedException - - if the fileContents is null