[LOG4J2-341] Enable XInclude for XML configurations

• Type: New Feature
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.0-beta9
• Component/s: Configurators

Environment

Apache Maven 3.0.5 (r01de14724cdef164cd33c7c8c2fe155faf9602da; 2013-02-19 08:51:28-0500)
Maven home: C:\Java\apache-maven-3.0.5\bin\..
Java version: 1.7.0_25, vendor: Oracle Corporation
Java home: C:\Program Files\Java\jdk1.7.0_25\jre
Default locale: en_US, platform encoding: Cp1252
OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

• Assignee: Unassigned
• Reporter: Gary D. Gregory
• Created: 10/Aug/13 03:18
• Updated: 17/Dec/20 11:59
• Resolved: 10/Aug/13 15:31

Description

Enable XInclude for XML configurations.

See org.apache.logging.log4j.core.config.XMLConfigurationTest

For example:

<?xml version="1.0" encoding="UTF-8"?>
<configuration xmlns:xi="http://www.w3.org/2001/XInclude"
  status="warn" name="XMLConfigTest" packages="org.apache.logging.log4j.test">
  <properties>
    <property name="filename">target/test.log</property>
  </properties>
  <ThresholdFilter level="debug"/>
  <xi:include href="target/test-classes/log4j-xinclude-appenders.xml" />
  <xi:include href="target/test-classes/log4j-xinclude-loggers.xml" />
</configuration>

log4j-xinclude-appenders.xml

<?xml version="1.0" encoding="UTF-8"?>
<appenders>
  <Console name="STDOUT">
    <PatternLayout pattern="%m%n" />
  </Console>
  <File name="File" fileName="${filename}" bufferedIO="false">
    <PatternLayout>
      <pattern>%d %p %C{1.} [%t] %m%n</pattern>
    </PatternLayout>
  </File>
  <List name="List">
    <filters>
      <ThresholdFilter level="error" />
    </filters>
  </List>
</appenders>

log4j-xinclude-loggers.xml

<?xml version="1.0" encoding="UTF-8"?>
<loggers>
  <logger name="org.apache.logging.log4j.test1" level="debug" additivity="false">
    <ThreadContextMapFilter>
      <KeyValuePair key="test" value="123" />
    </ThreadContextMapFilter>
    <appender-ref ref="STDOUT" />
  </logger>

  <logger name="org.apache.logging.log4j.test2" level="debug" additivity="false">
    <appender-ref ref="File" />
  </logger>

  <root level="error">
    <appender-ref ref="STDOUT" />
  </root>
</loggers>

Issue Links

• is related to: LOG4J2-342 XML configurator logs errors when it sees xml:base attributes
• relates to: LOG4J2-816 XInclude feature should be documented on the site