org.mockftpserver.core.command

Class StaticReplyCommandHandler

java.lang.Object

org.mockftpserver.core.command.AbstractCommandHandler

org.mockftpserver.core.command.AbstractTrackingCommandHandler

org.mockftpserver.core.command.AbstractStaticReplyCommandHandler

org.mockftpserver.core.command.StaticReplyCommandHandler

All Implemented Interfaces:

CommandHandler, InvocationHistory, ReplyTextBundleAware

public final class StaticReplyCommandHandler
extends AbstractStaticReplyCommandHandler

CommandHandler that sends back the configured reply code and text. You can customize the returned reply code by setting the required replyCode property. If only the replyCode property is set, then the default reply text corresponding to that reply code is used in the response. You can optionally configure the reply text by setting the replyMessageKey or replyText property.

Each invocation record stored by this CommandHandler contains no data elements.

Field Summary

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

replyCode, replyMessageKey, replyText

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

LOG

Constructor Summary

Constructors

Constructor and Description
StaticReplyCommandHandler() Create a new uninitialized instance
StaticReplyCommandHandler(int replyCode) Create a new instance with the specified replyCode
StaticReplyCommandHandler(int replyCode, java.lang.String replyText) Create a new instance with the specified replyCode and replyText

Method Summary

Modifier and Type	Method and Description
void	handleCommand(Command command, Session session, InvocationRecord invocationRecord) Handle the specified command for the session.

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

sendReply, sendReply, setReplyCode, setReplyMessageKey, setReplyText

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

Constructor Detail

StaticReplyCommandHandler

public StaticReplyCommandHandler()

Create a new uninitialized instance

StaticReplyCommandHandler

public StaticReplyCommandHandler(int replyCode)

Create a new instance with the specified replyCode

Parameters:

replyCode - - the replyCode to use

Throws:

AssertFailedException - - if the replyCode is null

StaticReplyCommandHandler

public StaticReplyCommandHandler(int replyCode,
                                 java.lang.String replyText)

Create a new instance with the specified replyCode and replyText

Parameters:

replyCode - - the replyCode to use

replyText - - the replyText

Throws:

AssertFailedException - - if the replyCode is null

Method Detail

handleCommand

public void handleCommand(Command command,
                          Session session,
                          InvocationRecord invocationRecord)

Description copied from class: AbstractTrackingCommandHandler

Handle the specified command for the session. This method is declared to throw Exception, allowing CommandHandler implementations to avoid unnecessary exception-handling. All checked exceptions are expected to be wrapped and handled by the caller.

Specified by:

handleCommand in class AbstractTrackingCommandHandler

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:

AbstractTrackingCommandHandler.handleCommand(Command, org.mockftpserver.core.session.Session, InvocationRecord)