org.mockftpserver.stub.command
Class StatCommandHandler

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.StatCommandHandler

All Implemented Interfaces:

CommandHandler, InvocationHistory, ReplyTextBundleAware

public class StatCommandHandler
extends AbstractStubCommandHandler
implements CommandHandler

CommandHandler for the STAT (Status) command. By default, return empty status information, along with a reply code of 211 if no pathname parameter is specified or 213 if a pathname is specified. You can customize the returned status information by setting the status property.

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

• PATHNAME_KEY ("pathname") - the pathname of the directory (or file) submitted on the invocation (the first command parameter); this parameter is optional, so the value may be null.

Version:

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

Author:

Chris Mair

See Also:

SystCommandHandler

Field Summary

static String

PATHNAME_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

StatCommandHandler()
Constructor.

Method Summary

void	handleCommand(Command command, Session session, InvocationRecord invocationRecord) Handle the specified command for the session.
void	setStatus(String status) Set the contents of the status to send back as the reply text for 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

PATHNAME_KEY

public static final String PATHNAME_KEY

See Also:

Constant Field Values

Constructor Detail

StatCommandHandler

public StatCommandHandler()

Constructor.

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

setStatus

public void setStatus(String status)

Set the contents of the status to send back as the reply text for this command

Parameters:

status - - the status