Package adams.scripting.requesthandler

Class LoggingHandler

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.scripting.requesthandler.AbstractRequestHandler

adams.scripting.requesthandler.LoggingHandler

All Implemented Interfaces:

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

public class LoggingHandler
extends AbstractRequestHandler

Outputs request using the logger.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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
LoggingHandler()

Method Summary

Modifier and Type	Method	Description
protected LoggingLevel	getDefaultLoggingLevel()	Returns the default logging level to use.
String	globalInfo()	Returns a string describing the object.
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.

Methods inherited from class adams.scripting.requesthandler.AbstractRequestHandler

defineOptions, enabledTipText, getEnabled, getOwner, insertHandler, setEnabled, setOwner

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, 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

Constructor Detail

LoggingHandler

public LoggingHandler()

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

getDefaultLoggingLevel

protected LoggingLevel getDefaultLoggingLevel()

Returns the default logging level to use.

Overrides:

getDefaultLoggingLevel in class AbstractOptionHandler

Returns:

the logging level

requestSuccessful

public void requestSuccessful(RemoteCommand cmd)

Handles successfuly requests.

Parameters:

cmd - the command with the request

requestFailed

public void requestFailed(RemoteCommand cmd,
                          String msg)

Handles failed requests.

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.

Parameters:

cmd - the command with the request

msg - the optional error message, can be null