Package adams.scripting.command.basic

Class StopRemoteLogging

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.scripting.command.AbstractCommand

adams.scripting.command.AbstractCommandWithResponse

adams.scripting.command.basic.StopRemoteLogging

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, RemoteCommand, RemoteCommandWithErrorMessage, RemoteCommandWithResponse, Serializable

public class StopRemoteLogging
extends AbstractCommandWithResponse

Stops remote logging.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseHostname	m_LoggingHost	the logging host.
protected String	m_Message	the message (empty is successful, otherwise error message).

Fields inherited from class adams.scripting.command.AbstractCommandWithResponse

m_ErrorMessage, m_ResponseConnection

Fields inherited from class adams.scripting.command.AbstractCommand

m_RemoteScriptingEngineHandler, m_Request

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.scripting.command.RemoteCommand

KEY_COMMAND, KEY_TYPE, VALUE_REQUEST, VALUE_RESPONSE

Constructor Summary

Constructors

Constructor	Description
StopRemoteLogging()

Method Summary

Modifier and Type	Method	Description
void	afterSendRequest(String error)	Hook method after sending the request.
void	defineOptions()	Adds options to the internal list of options.
BaseHostname	getLoggingHost()	Returns the logging host.
byte[]	getRequestPayload()	Always zero-length array.
Object[]	getRequestPayloadObjects()	Returns the objects that represent the request payload.
byte[]	getResponsePayload()	Returns the payload of the response, if any.
Object[]	getResponsePayloadObjects()	Returns the objects that represent the response payload.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
String	loggingHostTipText()	Returns the tip text for this property.
protected void	prepareResponsePayload()	Hook method for preparing the response payload,
void	setLoggingHost(BaseHostname value)	Sets logging host.
void	setRequestPayload(byte[] value)	Ignored.
void	setResponsePayload(byte[] value)	Sets the payload for the response.

Methods inherited from class adams.scripting.command.AbstractCommandWithResponse

afterSendResponse, assembleResponse, assembleResponseHeader, beforeSendResponse, doHandleRequest, getDefaultResponseConnection, getErrorMessage, getResponseConnection, handleResponse, hasErrorMessage, parse, responseConnectionTipText, setResponseConnection, toString

Methods inherited from class adams.scripting.command.AbstractCommand

assembleRequest, assembleRequestHeader, beforeSendRequest, getRemoteScriptingEngineHandler, handleRequest, isRequest, prepareRequestPayload, setRemoteScriptingEngineHandler, setRequest

Methods inherited from class adams.core.option.AbstractOptionHandler

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

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

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.scripting.command.RemoteCommand

assembleRequest, beforeSendRequest, getRemoteScriptingEngineHandler, handleRequest, isRequest, setRemoteScriptingEngineHandler, setRequest

Field Detail

m_LoggingHost

protected BaseHostname m_LoggingHost

the logging host.

m_Message

protected String m_Message

the message (empty is successful, otherwise error message).

Constructor Detail

StopRemoteLogging

public StopRemoteLogging()

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 AbstractCommandWithResponse

setLoggingHost

public void setLoggingHost(BaseHostname value)

Sets logging host.

Parameters:

value - host/port

getLoggingHost

public BaseHostname getLoggingHost()

Returns the logging host.

Returns:

host/port

loggingHostTipText

public String loggingHostTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractCommand

setRequestPayload

public void setRequestPayload(byte[] value)

Ignored.

Parameters:

value - the payload

getRequestPayload

public byte[] getRequestPayload()

Always zero-length array.

Returns:

the payload

getRequestPayloadObjects

public Object[] getRequestPayloadObjects()

Returns the objects that represent the request payload.

Returns:

the objects

afterSendRequest

public void afterSendRequest(String error)

Hook method after sending the request.

Specified by:

afterSendRequest in interface RemoteCommand

Overrides:

afterSendRequest in class AbstractCommand

Parameters:

error - null if successful, otherwise error message

setResponsePayload

public void setResponsePayload(byte[] value)

Sets the payload for the response.

Parameters:

value - the payload

getResponsePayload

public byte[] getResponsePayload()

Returns the payload of the response, if any.

Returns:

the payload

prepareResponsePayload

protected void prepareResponsePayload()

Hook method for preparing the response payload,

Overrides:

prepareResponsePayload in class AbstractCommandWithResponse

getResponsePayloadObjects

public Object[] getResponsePayloadObjects()

Returns the objects that represent the response payload.

Returns:

the objects