org.subethamail.smtp.server
Class BaseCommand

java.lang.Object
  extended by org.subethamail.smtp.server.BaseCommand
All Implemented Interfaces:
Command
Direct Known Subclasses:
AuthCommand, DataCommand, EhloCommand, HelloCommand, HelpCommand, MailCommand, NoopCommand, QuitCommand, ReceiptCommand, ResetCommand, StartTLSCommand, VerifyCommand

public abstract class BaseCommand
extends java.lang.Object
implements Command

Author:
Ian McFarland <ian@neo.com>, Jon Stevens, Jeff Schnitzer, Scott Hernandez

Constructor Summary
protected BaseCommand(java.lang.String name, java.lang.String help)
           
protected BaseCommand(java.lang.String name, java.lang.String help, java.lang.String argumentDescription)
           
 
Method Summary
abstract  void execute(java.lang.String commandString, Session context)
          This is the main method that you need to override in order to implement a command.
protected  java.lang.String getArgPredicate(java.lang.String commandString)
           
protected  java.lang.String[] getArgs(java.lang.String commandString)
           
 HelpMessage getHelp()
           
 java.lang.String getName()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseCommand

protected BaseCommand(java.lang.String name,
                      java.lang.String help)

BaseCommand

protected BaseCommand(java.lang.String name,
                      java.lang.String help,
                      java.lang.String argumentDescription)
Method Detail

execute

public abstract void execute(java.lang.String commandString,
                             Session context)
                      throws java.io.IOException
This is the main method that you need to override in order to implement a command.

Specified by:
execute in interface Command
Throws:
java.io.IOException

getHelp

public HelpMessage getHelp()
Specified by:
getHelp in interface Command

getName

public java.lang.String getName()
Specified by:
getName in interface Command

getArgPredicate

protected java.lang.String getArgPredicate(java.lang.String commandString)

getArgs

protected java.lang.String[] getArgs(java.lang.String commandString)


Copyright © 2009 SubEthaSMTP. All Rights Reserved. Build version: UNVERSIONED