Class MappingLogEventWriter

java.lang.Object

org.jpos.util.BaseLogEventWriter

org.jpos.util.MappingLogEventWriter

All Implemented Interfaces:

XmlConfigurable, LogEventWriter

public class MappingLogEventWriter
extends BaseLogEventWriter
implements XmlConfigurable

LogEventWriter that can be configured with event and output mappers to modify the events before writing to output stream and modify the output stream before writing to the final destination respectfully. Example configuration:

        <writer class="org.jpos.util.MappingLogEventWriter">
            <event-mapper class="...">
                <property....  />
            </event-mapper>
            <event-mapper class="..."/>
            <output-mapper class="...">
                <property.... />
            </output-mapper>
            <output-mapper class="..."/>
        </writer>
    

Since:

2.1.4

Constructor Summary

Constructors

Constructor	Description
MappingLogEventWriter()	Creates a writer with no mappers configured; mappers are wired by setConfiguration(Element).

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the writer and releases any underlying resources.
protected void	configureCaptureStreams()	Lazily allocates the capture stream pair when at least one output mapper is configured.
protected void	configureEventMappers(org.jdom2.Element e)	Reads <event-mapper> children from e and instantiates each.
protected void	configureOutputMappers(org.jdom2.Element e)	Reads <output-mapper> children from e and instantiates each.
protected void	delegateWriteToSuper(LogEvent ev)	This method exists and is used so that we can verify the order of instructions during a call to write in unit tests.
protected LogEvent	mapEvents(LogEvent ev)	Applies every registered event mapper, in order, to ev.
protected byte[]	mapOutput(byte[] output)	Applies every registered output mapper, in order, to the captured output bytes.
void	setConfiguration(org.jdom2.Element e)	Configures this object from an XML element.
void	setPrintStream(PrintStream p)	Sets the print stream used for output.
void	write(LogEvent ev)	Writes a log event to the underlying output.
protected void	writeToCaptureStream(LogEvent ev)	Write to capture print stream when defined.

Methods inherited from class Object

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

Constructor Details

MappingLogEventWriter

public MappingLogEventWriter()

Creates a writer with no mappers configured; mappers are wired by setConfiguration(Element).

Method Details

setPrintStream

public void setPrintStream(PrintStream p)

Description copied from interface: LogEventWriter

Sets the print stream used for output.

Specified by:

setPrintStream in interface LogEventWriter

Overrides:

setPrintStream in class BaseLogEventWriter

Parameters:

p - the destination stream

close

public void close()

Description copied from interface: LogEventWriter

Closes the writer and releases any underlying resources.

Specified by:

close in interface LogEventWriter

Overrides:

close in class BaseLogEventWriter

write

public void write(LogEvent ev)

Description copied from interface: LogEventWriter

Writes a log event to the underlying output.

Specified by:

write in interface LogEventWriter

Overrides:

write in class BaseLogEventWriter

Parameters:

ev - the log event to write

setConfiguration

public void setConfiguration(org.jdom2.Element e)
                      throws ConfigurationException

Description copied from interface: XmlConfigurable

Configures this object from an XML element.

Specified by:

setConfiguration in interface XmlConfigurable

Parameters:

e - Configuration element

Throws:

ConfigurationException - on error

configureCaptureStreams

protected void configureCaptureStreams()

Lazily allocates the capture stream pair when at least one output mapper is configured.

configureEventMappers

protected void configureEventMappers(org.jdom2.Element e)
                              throws ConfigurationException

Reads <event-mapper> children from e and instantiates each.

Parameters:

e - XML configuration element

Throws:

ConfigurationException - if any mapper class cannot be instantiated or configured

configureOutputMappers

protected void configureOutputMappers(org.jdom2.Element e)
                               throws ConfigurationException

Reads <output-mapper> children from e and instantiates each.

Parameters:

e - XML configuration element

Throws:

ConfigurationException - if any mapper class cannot be instantiated or configured

mapEvents

protected LogEvent mapEvents(LogEvent ev)

Applies every registered event mapper, in order, to ev.

Parameters:

ev - event to transform

Returns:

the transformed event

mapOutput

protected byte[] mapOutput(byte[] output)

Applies every registered output mapper, in order, to the captured output bytes.

Parameters:

output - bytes captured from writeToCaptureStream(LogEvent)

Returns:

the transformed output bytes

delegateWriteToSuper

protected void delegateWriteToSuper(LogEvent ev)

This method exists and is used so that we can verify the order of instructions during a call to write in unit tests.

Parameters:

ev - LogEvent to write.

writeToCaptureStream

protected void writeToCaptureStream(LogEvent ev)

Write to capture print stream when defined.

Parameters:

ev - LogEvent to write.