org.apache.logging.log4j.core.config

Class BaseConfiguration

java.lang.Object

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

org.apache.logging.log4j.core.config.BaseConfiguration

All Implemented Interfaces:

Configuration, Filterable

Direct Known Subclasses:

DefaultConfiguration, JSONConfiguration, NullConfiguration, XMLConfiguration

public class BaseConfiguration
extends AbstractFilterable
implements Configuration

The Base Configuration. Many configuration implementations will extend this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	advertisedConfiguration
protected boolean	isShutdownHookEnabled
protected List<ConfigurationListener>	listeners Listeners for configuration changes.
protected static Logger	LOGGER Allow subclasses access to the status logger without creating another instance.
protected ConfigurationMonitor	monitor The ConfigurationMonitor that checks for configuration changes.
protected PluginManager	pluginManager
protected Node	rootNode The root node of the configuration.

Fields inherited from interface org.apache.logging.log4j.core.config.Configuration

CONTEXT_PROPERTIES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseConfiguration() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAppender(Appender appender) Adds an Appender to the configuration.
void	addComponent(String name, Object obj)
void	addListener(ConfigurationListener listener) Add a listener for changes on the configuration.
void	addLogger(String name, LoggerConfig loggerConfig) Adding a logger cannot be done atomically so is not allowed in an active configuration.
void	addLoggerAppender(Logger logger, Appender appender) Associates an Appender with a LoggerConfig.
void	addLoggerFilter(Logger logger, Filter filter) Associates a Filter with a LoggerConfig.
protected void	createAdvertiser(String advertiserString, ConfigurationFactory.ConfigurationSource configSource, byte[] buffer, String contentType)
void	createConfiguration(Node node, LogEvent event)
protected void	doConfigure()
Advertiser	getAdvertiser()
Appender	getAppender(String name) Returns the Appender with the specified name.
Map<String,Appender>	getAppenders() Returns a Map containing all the Appenders and their name.
Object	getComponent(String name)
ConfigurationMonitor	getConfigurationMonitor()
protected Level	getDefaultStatus()
LoggerConfig	getLogger(String name) Returns the LoggerConfig with the specified name.
LoggerConfig	getLoggerConfig(String name) Locates the appropriate LoggerConfig for a Logger name.
Map<String,LoggerConfig>	getLoggers() Returns a Map of all the LoggerConfigs.
String	getName() Returns the name of the configuration.
Map<String,String>	getProperties()
LoggerConfig	getRootLogger() Returns the root Logger.
StrSubstitutor	getStrSubstitutor()
boolean	isShutdownHookEnabled()
void	removeAppender(String name) Remove an Appender.
void	removeListener(ConfigurationListener listener) Remove a ConfigurationListener.
void	removeLogger(String name) Removing a logger cannot be done atomically so is not allowed in an active configuration.
void	setAdvertiser(Advertiser advertiser)
void	setConfigurationMonitor(ConfigurationMonitor monitor)
void	setLoggerAdditive(Logger logger, boolean additive) Marks a LoggerConfig as additive.
void	setName(String name) Set the name of the configuration.
protected void	setup()
void	start() Initialize the configuration.
void	stop() Tear down the configuration.

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable

addFilter, getFilter, hasFilter, isFiltered, removeFilter, startFilter, stopFilter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.filter.Filterable

addFilter, getFilter, hasFilter, isFiltered, removeFilter

Field Detail

LOGGER

protected static final Logger LOGGER

Allow subclasses access to the status logger without creating another instance.

rootNode

protected Node rootNode

The root node of the configuration.

listeners

protected final List<ConfigurationListener> listeners

Listeners for configuration changes.

monitor

protected ConfigurationMonitor monitor

The ConfigurationMonitor that checks for configuration changes.

advertisedConfiguration

protected Map<String,String> advertisedConfiguration

isShutdownHookEnabled

protected boolean isShutdownHookEnabled

pluginManager

protected PluginManager pluginManager

Constructor Detail

BaseConfiguration

protected BaseConfiguration()

Constructor.

Method Detail

getProperties

public Map<String,String> getProperties()

Specified by:

getProperties in interface Configuration

start

public void start()

Initialize the configuration.

Specified by:

start in interface Configuration

stop

public void stop()

Tear down the configuration.

Specified by:

stop in interface Configuration

isShutdownHookEnabled

public boolean isShutdownHookEnabled()

Specified by:

isShutdownHookEnabled in interface Configuration

setup

protected void setup()

getDefaultStatus

protected Level getDefaultStatus()

createAdvertiser

protected void createAdvertiser(String advertiserString,
                    ConfigurationFactory.ConfigurationSource configSource,
                    byte[] buffer,
                    String contentType)

getComponent

public Object getComponent(String name)

Specified by:

getComponent in interface Configuration

addComponent

public void addComponent(String name,
                Object obj)

Specified by:

addComponent in interface Configuration

doConfigure

protected void doConfigure()

setName

public void setName(String name)

Set the name of the configuration.

Parameters:

name - The name.

getName

public String getName()

Returns the name of the configuration.

Specified by:

getName in interface Configuration

Returns:

the name of the configuration.

addListener

public void addListener(ConfigurationListener listener)

Add a listener for changes on the configuration.

Specified by:

addListener in interface Configuration

Parameters:

listener - The ConfigurationListener to add.

removeListener

public void removeListener(ConfigurationListener listener)

Remove a ConfigurationListener.

Specified by:

removeListener in interface Configuration

Parameters:

listener - The ConfigurationListener to remove.

getAppender

public Appender getAppender(String name)

Returns the Appender with the specified name.

Parameters:

name - The name of the Appender.

Returns:

the Appender with the specified name or null if the Appender cannot be located.

getAppenders

public Map<String,Appender> getAppenders()

Returns a Map containing all the Appenders and their name.

Specified by:

getAppenders in interface Configuration

Returns:

A Map containing each Appender's name and the Appender object.

addAppender

public void addAppender(Appender appender)

Adds an Appender to the configuration.

Parameters:

appender - The Appender to add.

getStrSubstitutor

public StrSubstitutor getStrSubstitutor()

Specified by:

getStrSubstitutor in interface Configuration

setConfigurationMonitor

public void setConfigurationMonitor(ConfigurationMonitor monitor)

Specified by:

setConfigurationMonitor in interface Configuration

getConfigurationMonitor

public ConfigurationMonitor getConfigurationMonitor()

Specified by:

getConfigurationMonitor in interface Configuration

setAdvertiser

public void setAdvertiser(Advertiser advertiser)

Specified by:

setAdvertiser in interface Configuration

getAdvertiser

public Advertiser getAdvertiser()

Specified by:

getAdvertiser in interface Configuration

addLoggerAppender

public void addLoggerAppender(Logger logger,
                     Appender appender)

Associates an Appender with a LoggerConfig. This method is synchronized in case a Logger with the same name is being updated at the same time. Note: This method is not used when configuring via configuration. It is primarily used by unit tests.

Specified by:

addLoggerAppender in interface Configuration

Parameters:

logger - The Logger the Appender will be associated with.

appender - The Appender.

addLoggerFilter

public void addLoggerFilter(Logger logger,
                   Filter filter)

Associates a Filter with a LoggerConfig. This method is synchronized in case a Logger with the same name is being updated at the same time. Note: This method is not used when configuring via configuration. It is primarily used by unit tests.

Specified by:

addLoggerFilter in interface Configuration

Parameters:

logger - The Logger the Fo;ter will be associated with.

filter - The Filter.

setLoggerAdditive

public void setLoggerAdditive(Logger logger,
                     boolean additive)

Marks a LoggerConfig as additive. This method is synchronized in case a Logger with the same name is being updated at the same time. Note: This method is not used when configuring via configuration. It is primarily used by unit tests.

Specified by:

setLoggerAdditive in interface Configuration

Parameters:

logger - The Logger the Appender will be associated with.

additive - True if the LoggerConfig should be additive, false otherwise.

removeAppender

public void removeAppender(String name)

Remove an Appender. First removes any associations between LoggerConfigs and the Appender, removes the Appender from this appender list and then stops the appender. This method is synchronized in case an Appender with the same name is being added during the removal.

Parameters:

name - the name of the appender to remove.

getLoggerConfig

public LoggerConfig getLoggerConfig(String name)

Locates the appropriate LoggerConfig for a Logger name. This will remove tokens from the package name as necessary or return the root LoggerConfig if no other matches were found.

Specified by:

getLoggerConfig in interface Configuration

Parameters:

name - The Logger name.

Returns:

The located LoggerConfig.

getRootLogger

public LoggerConfig getRootLogger()

Returns the root Logger.

Returns:

the root Logger.

getLoggers

public Map<String,LoggerConfig> getLoggers()

Returns a Map of all the LoggerConfigs.

Specified by:

getLoggers in interface Configuration

Returns:

a Map with each entry containing the name of the Logger and the LoggerConfig.

getLogger

public LoggerConfig getLogger(String name)

Returns the LoggerConfig with the specified name.

Parameters:

name - The Logger name.

Returns:

The LoggerConfig or null if no match was found.

addLogger

public void addLogger(String name,
             LoggerConfig loggerConfig)

Adding a logger cannot be done atomically so is not allowed in an active configuration. Adding or removing a Logger requires creating a new configuration and then switching.

Parameters:

name - The name of the Logger.

loggerConfig - The LoggerConfig.

removeLogger

public void removeLogger(String name)

Removing a logger cannot be done atomically so is not allowed in an active configuration. Adding or removing a Logger requires creating a new configuration and then switching.

Parameters:

name - The name of the Logger.

createConfiguration

public void createConfiguration(Node node,
                       LogEvent event)

Specified by:

createConfiguration in interface Configuration