org.waarp.ftp.core.command

Class AbstractCommand

java.lang.Object

org.waarp.ftp.core.command.AbstractCommand

All Implemented Interfaces:

CommandInterface

Direct Known Subclasses:

ABOR, ACCT, ALLO, APPE, AUTH, AUTHUPDATE, CCC, CDUP, ConnectionCommand, CWD, DELE, EPRT, EPSV, FEAT, HELP, IncorrectCommand, INTERNALSHUTDOWN, LIMITBANDWIDTH, LIST, MDTM, MKD, MLSD, MLST, MODE, NLST, NOOP, OPTS, PASS, PASV, PBSZ, PORT, PROT, PWD, QUIT, REIN, REST, RETR, RMD, RNFR, RNTO, SITE, SIZE, STAT, STOR, STOU, STRU, SYST, TYPE, UnimplementedCommand, UnknownCommand, USER, XCRC, XDIGEST, XMD5, XSHA1

public abstract class AbstractCommand
extends Object
implements CommandInterface

Abstract definition of an FTP Command

Constructor Summary

Constructors

Constructor and Description
AbstractCommand()

Method Summary

Modifier and Type	Method and Description
String	getArg()
String[]	getArgs()
FtpCommandCode	getCode()
String	getCommand()
FtpConfiguration	getConfiguration()
Object	getObject()
FtpSession	getSession()
int	getValue(String argx) Get an integer value from argument
boolean	hasArg() Does this command has an argument
void	invalidCurrentCommand() Set the previous command as the new current command (used after a incorrect sequence of commands or unknown command).
boolean	isNextCommandValid(CommandInterface newCommandArg) This function is called when a new command is received to check if this new command is positive according to the previous command and status.
void	setArgs(SessionInterface session, String command, String arg, Enum code) Set the Command from the args
void	setExtraNextCommand(Enum extraNextCommand) This function is intend to allow to force USER->PASS->ACCT->CDW for instance
void	setObject(Object object)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.waarp.common.command.CommandInterface

exec

Constructor Detail

AbstractCommand

public AbstractCommand()

Method Detail

setArgs

public final void setArgs(SessionInterface session,
                          String command,
                          String arg,
                          Enum code)

Description copied from interface: CommandInterface

Set the Command from the args

Specified by:

setArgs in interface CommandInterface

setExtraNextCommand

public final void setExtraNextCommand(Enum extraNextCommand)

Description copied from interface: CommandInterface

This function is intend to allow to force USER->PASS->ACCT->CDW for instance

Specified by:

setExtraNextCommand in interface CommandInterface

Parameters:

extraNextCommand - the extraNextCommand to set

isNextCommandValid

public final boolean isNextCommandValid(CommandInterface newCommandArg)

Description copied from interface: CommandInterface

This function is called when a new command is received to check if this new command is positive according to the previous command and status.

Specified by:

isNextCommandValid in interface CommandInterface

Returns:

True if this new command is OK, else False

getObject

public final Object getObject()

Specified by:

getObject in interface CommandInterface

Returns:

the object

setObject

public final void setObject(Object object)

Specified by:

setObject in interface CommandInterface

Parameters:

object - the object to set

getArg

public final String getArg()

Specified by:

getArg in interface CommandInterface

Returns:

the arg

getArgs

public final String[] getArgs()

Specified by:

getArgs in interface CommandInterface

Returns:

the list of arguments

getValue

public final int getValue(String argx)
                   throws InvalidArgumentException

Description copied from interface: CommandInterface

Get an integer value from argument

Specified by:

getValue in interface CommandInterface

Returns:

the integer

Throws:

InvalidArgumentException - if the argument is not an integer

getCommand

public final String getCommand()

Specified by:

getCommand in interface CommandInterface

Returns:

the command

hasArg

public final boolean hasArg()

Description copied from interface: CommandInterface

Does this command has an argument

Specified by:

hasArg in interface CommandInterface

Returns:

True if it has an argument

getSession

public final FtpSession getSession()

Specified by:

getSession in interface CommandInterface

Returns:

the current FtpSession

getConfiguration

public final FtpConfiguration getConfiguration()

Returns:

The current configuration object

invalidCurrentCommand

public final void invalidCurrentCommand()

Description copied from interface: CommandInterface

Set the previous command as the new current command (used after a incorrect sequence of commands or unknown command). Also clear the Restart object.

Specified by:

invalidCurrentCommand in interface CommandInterface

getCode

public final FtpCommandCode getCode()

Specified by:

getCode in interface CommandInterface

Returns:

The FtpCommandCode associated with this command