org.apache.log4j.receivers.xml

## Class UtilLoggingXMLDecoder

- java.lang.Object
- - org.apache.log4j.receivers.xml.UtilLoggingXMLDecoder

- All Implemented Interfaces:
    Decoder

      public class UtilLoggingXMLDecoder
      extends Object
      implements Decoder

  Decodes JDK 1.4's java.util.logging package events delivered via XML (using the logger.dtd).
  Author:
    Scott Deboy (sdeboy@apache.org), Paul Smith (psmith@apache.org)

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `UtilLoggingXMLDecoder()` Create new instance.
    `UtilLoggingXMLDecoder(Component o)` Create new instance.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `org.apache.log4j.spi.LoggingEvent` | `decode(String data)` Converts the string data into an XML Document, and then soaks out the relevant bits to form a new LoggingEvent instance which can be used by any Log4j element locally.
    `Vector` | `decode(URL url)` Decodes a File into a Vector of LoggingEvents.
    `Vector` | `decodeEvents(String document)` Decodes a String representing a number of events into a Vector of LoggingEvents.
    `void` | `setAdditionalProperties(Map properties)` Sets an additionalProperty map, where each Key/Value pair is automatically added to each LoggingEvent as it is decoded.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### UtilLoggingXMLDecoder

          public UtilLoggingXMLDecoder(Component o)

      Create new instance.
      Parameters:
        `o` - owner

    - #### UtilLoggingXMLDecoder

          public UtilLoggingXMLDecoder()

      Create new instance.

  - ### Method Detail

    - #### setAdditionalProperties

          public void setAdditionalProperties(Map properties)

      Sets an additionalProperty map, where each Key/Value pair is automatically added to each LoggingEvent as it is decoded. This is useful, say, to include the source file name of the Logging events
      Specified by:
        `setAdditionalProperties` in interface `Decoder`
      Parameters:
        `properties` - additional properties

    - #### decode

          public Vector decode(URL url)
                        throws IOException

      Decodes a File into a Vector of LoggingEvents.
      Specified by:
        `decode` in interface `Decoder`
      Parameters:
        `url` - the url of a file containing events to decode
      Returns:
        Vector of LoggingEvents
      Throws:
        `IOException` - if IO error during processing.

    - #### decodeEvents

          public Vector decodeEvents(String document)

      Decodes a String representing a number of events into a Vector of LoggingEvents.
      Specified by:
        `decodeEvents` in interface `Decoder`
      Parameters:
        `document` - to decode events from
      Returns:
        Vector of LoggingEvents

    - #### decode

          public org.apache.log4j.spi.LoggingEvent decode(String data)

      Converts the string data into an XML Document, and then soaks out the relevant bits to form a new LoggingEvent instance which can be used by any Log4j element locally.
      Specified by:
        `decode` in interface `Decoder`
      Parameters:
        `data` - XML fragment
      Returns:
        a single LoggingEvent or null

Copyright © 2013 The Apache Software Foundation. Licensed under the Apache License, Version 2.0

Apache Extras for Apache log4j, Apache log4j and Apache are trademarks of the Apache Software Foundation.