org.apache.log4j.receivers.spi

Interface Decoder

All Known Implementing Classes:

UtilLoggingXMLDecoder, XMLDecoder

public interface Decoder

Allow LoggingEvents to be reconstructed from a different format (usually XML).

Author:

Scott Deboy (sdeboy@apache.org)

Method Summary

Modifier and Type	Method and Description
org.apache.log4j.spi.LoggingEvent	decode(java.lang.String event) Decode event from string.
java.util.Vector	decode(java.net.URL url) Decode event from document retreived from URL.
java.util.Vector	decodeEvents(java.lang.String document) Decode events from document.
void	setAdditionalProperties(java.util.Map additionalProperties) Sets additional properties.

Method Detail

decodeEvents

java.util.Vector decodeEvents(java.lang.String document)

Decode events from document.

Parameters:

document - document to decode.

Returns:

list of LoggingEvent instances.

decode

org.apache.log4j.spi.LoggingEvent decode(java.lang.String event)

Decode event from string.

Parameters:

event - string representation of event

Returns:

event

decode

java.util.Vector decode(java.net.URL url)
                 throws java.io.IOException

Decode event from document retreived from URL.

Parameters:

url - url of document

Returns:

list of LoggingEvent instances.

Throws:

java.io.IOException - if IO error resolving document.

setAdditionalProperties

void setAdditionalProperties(java.util.Map additionalProperties)

Sets additional properties.

Parameters:

additionalProperties - map of additional properties.