Class XmlConfiguration

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.filter.AbstractFilterable

org.apache.logging.log4j.core.config.AbstractConfiguration

org.apache.logging.log4j.core.config.xml.XmlConfiguration

All Implemented Interfaces:

Configuration, Reconfigurable, Filterable, LifeCycle, LifeCycle2

public class XmlConfiguration
extends AbstractConfiguration
implements Reconfigurable

Creates a Node hierarchy from an XML file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	XmlConfiguration.ErrorType	The error that occurred.
private static class	XmlConfiguration.Status	Status for recording errors.

Nested classes/interfaces inherited from class AbstractFilterable

AbstractFilterable.Builder<B>

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	LOG4J_XSD
private Element	rootElement
private String	schemaResource
private final List<XmlConfiguration.Status>	status
private boolean	strict
private static final String[]	VERBOSE_CLASSES
private static final String	XINCLUDE_FIXUP_BASE_URIS
private static final String	XINCLUDE_FIXUP_LANGUAGE

Fields inherited from class AbstractConfiguration

isShutdownHookEnabled, listeners, pluginManager, pluginPackages, rootNode, scriptManager, shutdownTimeoutMillis

Fields inherited from class AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface Configuration

CONTEXT_PROPERTIES

Constructor Summary

Constructors

Constructor	Description
XmlConfiguration(LoggerContext loggerContext, ConfigurationSource configSource)

Method Summary

Modifier and Type	Method	Description
private void	constructHierarchy(Node node, Element element)
private static void	disableDtdProcessing(DocumentBuilderFactory factory)
private static void	enableXInclude(DocumentBuilderFactory factory)	Enables XInclude for the given DocumentBuilderFactory
private String	getType(Element element)
(package private) static DocumentBuilder	newDocumentBuilder(boolean xIncludeAware)	Creates a new DocumentBuilder suitable for parsing a configuration file.
private Map<String,String>	processAttributes(Node node, Element element)
Configuration	reconfigure()
private static void	setFeature(DocumentBuilderFactory factory, String featureName, boolean value)
void	setup()
String	toString()

Methods inherited from class AbstractConfiguration

addAppender, addComponent, addListener, addLogger, addLoggerAppender, addLoggerFilter, createAdvertiser, createConfiguration, createPluginObject, doConfigure, getAdvertiser, getAppender, getAppenders, getAsyncLoggerConfigDelegate, getAsyncWaitStrategyFactory, getComponent, getConfigurationSource, getConfigurationStrSubstitutor, getCustomLevels, getDefaultLevel, getDefaultStatus, getLogger, getLoggerConfig, getLoggerContext, getLoggers, getName, getNanoClock, getPluginManager, getPluginPackages, getProperties, getReliabilityStrategy, getRootLogger, getRootNode, getScheduler, getScriptManager, getShutdownTimeoutMillis, getStrSubstitutor, getWatchManager, initialize, initializeWatchers, isShutdownHookEnabled, preConfigure, processConditionals, processSelect, removeAppender, removeListener, removeLogger, setAdvertiser, setLoggerAdditive, setName, setNanoClock, setPluginManager, setScriptManager, setToDefault, start, stop, toByteArray

Methods inherited from class AbstractFilterable

addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter, stop

Methods inherited from class AbstractLifeCycle

equalsImpl, getState, getStatusLogger, hashCodeImpl, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop

Methods inherited from class Object

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

Methods inherited from interface Filterable

addFilter, getFilter, hasFilter, isFiltered, removeFilter

Methods inherited from interface LifeCycle

getState, isStarted, isStopped, stop

Field Details

XINCLUDE_FIXUP_LANGUAGE

private static final String XINCLUDE_FIXUP_LANGUAGE

See Also:

• Constant Field Values

XINCLUDE_FIXUP_BASE_URIS

private static final String XINCLUDE_FIXUP_BASE_URIS

See Also:

• Constant Field Values

VERBOSE_CLASSES

private static final String[] VERBOSE_CLASSES

LOG4J_XSD

private static final String LOG4J_XSD

See Also:

• Constant Field Values

status

private final List<XmlConfiguration.Status> status

rootElement

private Element rootElement

strict

private boolean strict

schemaResource

private String schemaResource

Constructor Details

XmlConfiguration

public XmlConfiguration(LoggerContext loggerContext,
 ConfigurationSource configSource)

Method Details

newDocumentBuilder

static DocumentBuilder newDocumentBuilder(boolean xIncludeAware)
                                   throws ParserConfigurationException

Creates a new DocumentBuilder suitable for parsing a configuration file.

Parameters:

xIncludeAware - enabled XInclude

Returns:

a new DocumentBuilder

Throws:

ParserConfigurationException

disableDtdProcessing

private static void disableDtdProcessing(DocumentBuilderFactory factory)

setFeature

private static void setFeature(DocumentBuilderFactory factory,
 String featureName,
 boolean value)

enableXInclude

private static void enableXInclude(DocumentBuilderFactory factory)

Enables XInclude for the given DocumentBuilderFactory

Parameters:

factory - a DocumentBuilderFactory

setup

public void setup()

Overrides:

setup in class AbstractConfiguration

reconfigure

public Configuration reconfigure()

Specified by:

reconfigure in interface Reconfigurable

constructHierarchy

private void constructHierarchy(Node node,
 Element element)

getType

private String getType(Element element)

processAttributes

private Map<String,String> processAttributes(Node node,
 Element element)

toString

public String toString()

Overrides:

toString in class Object