Package adams.scripting.requesthandler

Class CommandDumperHandler

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.scripting.requesthandler.AbstractRequestHandler

adams.scripting.requesthandler.CommandDumperHandler

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, RemoteCommandProcessorHandler, RequestHandler, Serializable

public class CommandDumperHandler
extends AbstractRequestHandler
implements RemoteCommandProcessorHandler

Saves requests as command files.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected RemoteCommandProcessor	m_CommandProcessor	the command processor.
protected PlaceholderDirectory	m_FailedDir	the output directory for failed requests.
protected PlaceholderDirectory	m_RejectedDir	the output directory for rejected requests.
protected PlaceholderDirectory	m_SuccessfulDir	the output directory for successful requests.

Fields inherited from class adams.scripting.requesthandler.AbstractRequestHandler

m_Enabled, m_Owner

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
CommandDumperHandler()

Method Summary

Modifier and Type	Method	Description
String	commandProcessorTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
String	failedDirTipText()	Returns the tip text for this property.
RemoteCommandProcessor	getCommandProcessor()	Returns the command processor in use.
PlaceholderDirectory	getFailedDir()	Returns the directory for failed commands.
PlaceholderDirectory	getRejectedDir()	Returns the directory for rejected commands.
PlaceholderDirectory	getSuccessfulDir()	Returns the directory for successful commands.
String	globalInfo()	Returns a string describing the object.
String	rejectedDirTipText()	Returns the tip text for this property.
void	requestFailed(RemoteCommand cmd, String msg)	Handles failed requests.
void	requestRejected(RemoteCommand cmd, String msg)	Handles rejected requests.
void	requestSuccessful(RemoteCommand cmd)	Handles successfuly requests.
void	setCommandProcessor(RemoteCommandProcessor value)	Sets the command processor to use.
void	setFailedDir(PlaceholderDirectory value)	Sets the directory for failed commands.
void	setRejectedDir(PlaceholderDirectory value)	Sets the directory for rejected commands.
void	setSuccessfulDir(PlaceholderDirectory value)	Sets the directory for successful commands.
String	successfulDirTipText()	Returns the tip text for this property.

Methods inherited from class adams.scripting.requesthandler.AbstractRequestHandler

enabledTipText, getEnabled, getOwner, insertHandler, setEnabled, setOwner

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_SuccessfulDir

protected PlaceholderDirectory m_SuccessfulDir

the output directory for successful requests.

m_FailedDir

protected PlaceholderDirectory m_FailedDir

the output directory for failed requests.

m_RejectedDir

protected PlaceholderDirectory m_RejectedDir

the output directory for rejected requests.

m_CommandProcessor

protected RemoteCommandProcessor m_CommandProcessor

the command processor.

Constructor Detail

CommandDumperHandler

public CommandDumperHandler()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractRequestHandler

setSuccessfulDir

public void setSuccessfulDir(PlaceholderDirectory value)

Sets the directory for successful commands.

Parameters:

value - the dir

getSuccessfulDir

public PlaceholderDirectory getSuccessfulDir()

Returns the directory for successful commands.

Returns:

the dir

successfulDirTipText

public String successfulDirTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setFailedDir

public void setFailedDir(PlaceholderDirectory value)

Sets the directory for failed commands.

Parameters:

value - the dir

getFailedDir

public PlaceholderDirectory getFailedDir()

Returns the directory for failed commands.

Returns:

the dir

failedDirTipText

public String failedDirTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setRejectedDir

public void setRejectedDir(PlaceholderDirectory value)

Sets the directory for rejected commands.

Parameters:

value - the dir

getRejectedDir

public PlaceholderDirectory getRejectedDir()

Returns the directory for rejected commands.

Returns:

the dir

rejectedDirTipText

public String rejectedDirTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setCommandProcessor

public void setCommandProcessor(RemoteCommandProcessor value)

Sets the command processor to use.

Specified by:

setCommandProcessor in interface RemoteCommandProcessorHandler

Parameters:

value - the processor

getCommandProcessor

public RemoteCommandProcessor getCommandProcessor()

Returns the command processor in use.

Specified by:

getCommandProcessor in interface RemoteCommandProcessorHandler

Returns:

the processor

commandProcessorTipText

public String commandProcessorTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

requestSuccessful

public void requestSuccessful(RemoteCommand cmd)

Handles successfuly requests.

Specified by:

requestSuccessful in interface RequestHandler

Parameters:

cmd - the command with the request

requestFailed

public void requestFailed(RemoteCommand cmd,
                          String msg)

Handles failed requests.

Specified by:

requestFailed in interface RequestHandler

Parameters:

cmd - the command with the request

msg - the optional error message, can be null

requestRejected

public void requestRejected(RemoteCommand cmd,
                            String msg)

Handles rejected requests.

Specified by:

requestRejected in interface RequestHandler

Parameters:

cmd - the command with the request

msg - the optional error message, can be null