Package adams.flow.webservice.interceptor.outgoing

Class XMLLoggingGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.webservice.interceptor.outgoing.AbstractOutInterceptorGenerator<XMLLoggingOutInterceptor>

adams.flow.webservice.interceptor.outgoing.XMLLoggingGenerator

All Implemented Interfaces:

adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.io.FileWriter, adams.core.io.PrettyPrintingSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

public class XMLLoggingGenerator
extends AbstractOutInterceptorGenerator<XMLLoggingOutInterceptor>
implements adams.core.io.PrettyPrintingSupporter, adams.core.io.FileWriter

Generator for XMLLoggingOutInterceptor.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.core.io.PlaceholderFile	m_OutputFile	the optional output file to write the XML messages to.
protected boolean	m_PrettyPrinting	whether to use pretty-printing.

Fields inherited from class adams.flow.webservice.interceptor.outgoing.AbstractOutInterceptorGenerator

m_Enabled, m_LastInterceptor

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected XMLLoggingOutInterceptor	doGenerate()	Generates the actual interceptor for incoming messages.
protected adams.core.logging.LoggingLevel	getDefaultLoggingLevel()	Returns the default logging level to use.
adams.core.io.PlaceholderFile	getOutputFile()	Returns the output file in use.
boolean	getPrettyPrinting()	Returns whether pretty-printing is used or not.
String	globalInfo()	Returns a string describing the object.
String	outputFileTipText()	Returns the tip text for this property.
String	prettyPrintingTipText()	Returns the tip text for this property.
void	setOutputFile(adams.core.io.PlaceholderFile value)	Sets the output file in use.
void	setPrettyPrinting(boolean value)	Sets whether to use pretty-printing or not.

Methods inherited from class adams.flow.webservice.interceptor.outgoing.AbstractOutInterceptorGenerator

check, cleanUp, enabledTipText, generate, getEnabled, getLastInterceptor, hasLastInterceptor, setEnabled

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

Field Detail

m_PrettyPrinting

protected boolean m_PrettyPrinting

whether to use pretty-printing.

m_OutputFile

protected adams.core.io.PlaceholderFile m_OutputFile

the optional output file to write the XML messages to.

Constructor Detail

XMLLoggingGenerator

public XMLLoggingGenerator()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.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 adams.core.option.OptionHandler

Overrides:

defineOptions in class AbstractOutInterceptorGenerator<XMLLoggingOutInterceptor>

getDefaultLoggingLevel

protected adams.core.logging.LoggingLevel getDefaultLoggingLevel()

Returns the default logging level to use.

Overrides:

getDefaultLoggingLevel in class adams.core.option.AbstractOptionHandler

Returns:

the logging level

setPrettyPrinting

public void setPrettyPrinting(boolean value)

Sets whether to use pretty-printing or not.

Specified by:

setPrettyPrinting in interface adams.core.io.PrettyPrintingSupporter

Parameters:

value - true if to use pretty-printing

getPrettyPrinting

public boolean getPrettyPrinting()

Returns whether pretty-printing is used or not.

Specified by:

getPrettyPrinting in interface adams.core.io.PrettyPrintingSupporter

Returns:

true if to use pretty-printing

prettyPrintingTipText

public String prettyPrintingTipText()

Returns the tip text for this property.

Specified by:

prettyPrintingTipText in interface adams.core.io.PrettyPrintingSupporter

Returns:

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

setOutputFile

public void setOutputFile(adams.core.io.PlaceholderFile value)

Sets the output file in use. Ignored if pointing to a directory.

Specified by:

setOutputFile in interface adams.core.io.FileWriter

Parameters:

value - the output file

getOutputFile

public adams.core.io.PlaceholderFile getOutputFile()

Returns the output file in use. Ignored if pointing to a directory.

Specified by:

getOutputFile in interface adams.core.io.FileWriter

Returns:

the output file

outputFileTipText

public String outputFileTipText()

Returns the tip text for this property.

Specified by:

outputFileTipText in interface adams.core.io.FileWriter

Returns:

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

doGenerate

protected XMLLoggingOutInterceptor doGenerate()

Generates the actual interceptor for incoming messages.

Specified by:

doGenerate in class AbstractOutInterceptorGenerator<XMLLoggingOutInterceptor>

Returns:

the interceptor