org.mockftpserver.stub.command

Class HelpCommandHandler

java.lang.Object

org.mockftpserver.core.command.AbstractCommandHandler

org.mockftpserver.core.command.AbstractTrackingCommandHandler

org.mockftpserver.core.command.AbstractStaticReplyCommandHandler

org.mockftpserver.stub.command.AbstractStubCommandHandler

org.mockftpserver.stub.command.HelpCommandHandler

All Implemented Interfaces:

CommandHandler, InvocationHistory, ReplyTextBundleAware

public final class HelpCommandHandler
extends AbstractStubCommandHandler
implements CommandHandler

CommandHandler for the HELP command. By default, return an empty help message, along with a reply code of 214. You can customize the returned help message by setting the helpMessage property.

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

• COMMAND_NAME_KEY ("commandName") - the command name optionally submitted on the invocation (the first command parameter). May be null.

Version:

$Revision: 194 $ - $Date: 2008-12-07 08:53:58 -0500 (Sun, 07 Dec 2008) $

Author:

Chris Mair

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMAND_NAME_KEY

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
HelpCommandHandler() Constructor.

Method Summary

Modifier and Type	Method and Description
void	handleCommand(Command command, Session session, InvocationRecord invocationRecord) Handle the specified command for the session.
void	setHelpMessage(String helpMessage) Set the help message String to be returned by this command

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

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

handleCommand

Field Detail

COMMAND_NAME_KEY

public static final String COMMAND_NAME_KEY

See Also:

Constant Field Values

Constructor Detail

HelpCommandHandler

public HelpCommandHandler()

Constructor. Initialize the replyCode.

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(org.mockftpserver.core.command.Command, org.mockftpserver.core.session.Session, org.mockftpserver.core.command.InvocationRecord)

setHelpMessage

public void setHelpMessage(String helpMessage)

Set the help message String to be returned by this command

Parameters:

helpMessage - - the help message