Save This Page
Home » slf4j-1.5.5 » org.apache » log4j » xml » [javadoc | source]
org.apache.log4j.xml
public class: XMLLayout [javadoc | source]
java.lang.Object
   org.apache.log4j.Layout
      org.apache.log4j.xml.XMLLayout

All Implemented Interfaces:
    OptionHandler

The output of the XMLLayout consists of a series of log4j:event elements as defined in the log4j.dtd. It does not output a complete well-formed XML file. The output is designed to be included as an external entity in a separate file to form a correct XML file.

For example, if abc is the name of the file where the XMLLayout ouput goes, then a well-formed XML file would be:

<?xml version="1.0" ?>

<!DOCTYPE log4j:eventSet SYSTEM "log4j.dtd" [<!ENTITY data SYSTEM "abc">]>

<log4j:eventSet version="1.2" xmlns:log4j="http://jakarta.apache.org/log4j/">
  &data;
</log4j:eventSet>

This approach enforces the independence of the XMLLayout and the appender where it is embedded.

The version attribute helps components to correctly intrepret output generated by XMLLayout. The value of this attribute should be "1.1" for output generated by log4j versions prior to log4j 1.2 (final release) and "1.2" for relase 1.2 and later. Appenders using this layout should have their encoding set to UTF-8 or UTF-16, otherwise events containing non ASCII characters could result in corrupted log files.

Fields inherited from org.apache.log4j.Layout:
LINE_SEP,  LINE_SEP_LEN
Method from org.apache.log4j.xml.XMLLayout Summary:
activateOptions,   format,   getLocationInfo,   getProperties,   ignoresThrowable,   setLocationInfo,   setProperties
Methods from org.apache.log4j.Layout:
format,   getContentType,   getFooter,   getHeader,   ignoresThrowable
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.log4j.xml.XMLLayout Detail:
 public  void activateOptions() 
    No options to activate.
 public String format(LoggingEvent event) 
 public boolean getLocationInfo() 
    Returns the current value of the LocationInfo option.
 public boolean getProperties() 
    Gets whether MDC key-value pairs should be output.
 public boolean ignoresThrowable() 
    The XMLLayout prints and does not ignore exceptions. Hence the return value false.
 public  void setLocationInfo(boolean flag) 
    The LocationInfo option takes a boolean value. By default, it is set to false which means there will be no location information output by this layout. If the the option is set to true, then the file name and line number of the statement at the origin of the log statement will be output.

    If you are embedding this layout within an org.apache.log4j.net.SMTPAppender then make sure to set the LocationInfo option of that appender as well.

 public  void setProperties(boolean flag) 
    Sets whether MDC key-value pairs should be output, default false.