org.apache.logging.log4j.core.config

Class AbstractConfiguration

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

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

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

All Implemented Interfaces:

Configuration, Filterable, LifeCycle, LifeCycle2

Direct Known Subclasses:

BuiltConfiguration, CompositeConfiguration, DefaultConfiguration, JsonConfiguration, NullConfiguration, XmlConfiguration

public abstract class AbstractConfiguration
extends AbstractFilterable
implements Configuration

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

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable

AbstractFilterable.Builder<B extends AbstractFilterable.Builder<B>>

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object	advertisement
private Advertiser	advertiser The Advertiser which exposes appender configurations to external systems.
private Node	advertiserNode
private java.util.concurrent.ConcurrentMap<java.lang.String,Appender>	appenders
private AsyncLoggerConfigDisruptor	asyncLoggerConfigDisruptor
private static int	BUF_SIZE
private java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.Object>	componentMap
private ConfigurationScheduler	configurationScheduler
private ConfigurationSource	configurationSource
private java.util.List<CustomLevelConfig>	customLevels
protected boolean	isShutdownHookEnabled Shutdown hook is enabled by default.
protected java.util.List<ConfigurationListener>	listeners Listeners for configuration changes.
private java.util.concurrent.ConcurrentMap<java.lang.String,LoggerConfig>	loggerConfigs
private java.lang.ref.WeakReference<LoggerContext>	loggerContext
private java.lang.String	name
private NanoClock	nanoClock
protected PluginManager	pluginManager The plugin manager.
protected java.util.List<java.lang.String>	pluginPackages Packages found in configuration "packages" attribute.
private java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String>	properties
private LoggerConfig	root
protected Node	rootNode The root node of the configuration.
protected ScriptManager	scriptManager The Script manager.
protected long	shutdownTimeoutMillis Shutdown timeout in milliseconds.
private StrSubstitutor	subst
private StrLookup	tempLookup
private WatchManager	watchManager

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

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

CONTEXT_PROPERTIES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConfiguration(LoggerContext loggerContext, ConfigurationSource configurationSource) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAppender(Appender appender) Adds an Appender to the configuration.
void	addComponent(java.lang.String componentName, java.lang.Object obj)
void	addListener(ConfigurationListener listener) Add a listener for changes on the configuration.
void	addLogger(java.lang.String loggerName, LoggerConfig loggerConfig) Add a loggerConfig.
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(java.lang.String advertiserString, ConfigurationSource configSource, byte[] buffer, java.lang.String contentType)
void	createConfiguration(Node node, LogEvent event)
private static java.util.Collection<?>	createPluginCollection(Node node)
private static java.util.Map<java.lang.String,?>	createPluginMap(Node node)
private java.lang.Object	createPluginObject(PluginType<?> type, Node node, LogEvent event) Invokes a static factory method to either create the desired object or to create a builder object that creates the desired object.
protected void	doConfigure()
Advertiser	getAdvertiser()
<T extends Appender> T	getAppender(java.lang.String appenderName) Returns the Appender with the specified name.
java.util.Map<java.lang.String,Appender>	getAppenders() Returns a Map containing all the Appenders and their name.
private java.util.List<Appender>	getAsyncAppenders(Appender[] all)
AsyncLoggerConfigDelegate	getAsyncLoggerConfigDelegate() Returns the AsyncLoggerConfigDelegate shared by all AsyncLoggerConfig instances defined in this Configuration.
<T> T	getComponent(java.lang.String componentName)
ConfigurationSource	getConfigurationSource() Returns the source of this configuration.
java.util.List<CustomLevelConfig>	getCustomLevels() Returns a list of descriptors of the custom levels defined in the current configuration.
protected Level	getDefaultStatus()
LoggerConfig	getLogger(java.lang.String loggerName) Returns the LoggerConfig with the specified name.
LoggerConfig	getLoggerConfig(java.lang.String loggerName) Locates the appropriate LoggerConfig for a Logger name.
LoggerContext	getLoggerContext() Gets the logger context.
java.util.Map<java.lang.String,LoggerConfig>	getLoggers() Returns a Map of all the LoggerConfigs.
java.lang.String	getName() Returns the name of the configuration.
NanoClock	getNanoClock() Returns the NanoClock instance for this configuration.
PluginManager	getPluginManager()
java.util.List<java.lang.String>	getPluginPackages() Returns the list of packages to scan for plugins for this Configuration.
java.util.Map<java.lang.String,java.lang.String>	getProperties()
ReliabilityStrategy	getReliabilityStrategy(LoggerConfig loggerConfig)
LoggerConfig	getRootLogger() Returns the root Logger.
Node	getRootNode()
ConfigurationScheduler	getScheduler()
ScriptManager	getScriptManager()
long	getShutdownTimeoutMillis()
StrSubstitutor	getStrSubstitutor()
WatchManager	getWatchManager() Return the WatchManager.
private boolean	hasAsyncLoggers()
void	initialize() Initialize the configuration.
boolean	isShutdownHookEnabled()
protected void	preConfigure(Node node)
void	removeAppender(java.lang.String appenderName) Remove an Appender.
void	removeListener(ConfigurationListener listener) Remove a ConfigurationListener.
void	removeLogger(java.lang.String loggerName) Remove a LoggerConfig.
void	setAdvertiser(Advertiser advertiser)
void	setLoggerAdditive(Logger logger, boolean additive) Marks a LoggerConfig as additive.
void	setName(java.lang.String name) Set the name of the configuration.
void	setNanoClock(NanoClock nanoClock) Sets the NanoClock instance for this configuration.
private void	setParents()
void	setPluginManager(PluginManager pluginManager)
void	setScriptManager(ScriptManager scriptManager)
protected void	setToDefault()
void	setup()
private void	setupAdvertisement()
void	start() Start the configuration.
boolean	stop(long timeout, java.util.concurrent.TimeUnit timeUnit) Tear down the configuration.
protected static byte[]	toByteArray(java.io.InputStream is) Reads an InputStream using buffered reads into a byte array buffer.

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

addFilter, getFilter, hasFilter, isFiltered, removeFilter, stop

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

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

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

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

getState, isStarted, isStopped, stop

Field Detail

BUF_SIZE

private static final int BUF_SIZE

See Also:

Constant Field Values

rootNode

protected Node rootNode

The root node of the configuration.

listeners

protected final java.util.List<ConfigurationListener> listeners

Listeners for configuration changes.

pluginPackages

protected final java.util.List<java.lang.String> pluginPackages

Packages found in configuration "packages" attribute.

pluginManager

protected PluginManager pluginManager

The plugin manager.

isShutdownHookEnabled

protected boolean isShutdownHookEnabled

Shutdown hook is enabled by default.

shutdownTimeoutMillis

protected long shutdownTimeoutMillis

Shutdown timeout in milliseconds.

scriptManager

protected ScriptManager scriptManager

The Script manager.

advertiser

private Advertiser advertiser

The Advertiser which exposes appender configurations to external systems.

advertiserNode

private Node advertiserNode

advertisement

private java.lang.Object advertisement

name

private java.lang.String name

appenders

private java.util.concurrent.ConcurrentMap<java.lang.String,Appender> appenders

loggerConfigs

private java.util.concurrent.ConcurrentMap<java.lang.String,LoggerConfig> loggerConfigs

customLevels

private java.util.List<CustomLevelConfig> customLevels

properties

private final java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String> properties

tempLookup

private final StrLookup tempLookup

subst

private final StrSubstitutor subst

root

private LoggerConfig root

componentMap

private final java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.Object> componentMap

configurationSource

private final ConfigurationSource configurationSource

configurationScheduler

private final ConfigurationScheduler configurationScheduler

watchManager

private final WatchManager watchManager

asyncLoggerConfigDisruptor

private AsyncLoggerConfigDisruptor asyncLoggerConfigDisruptor

nanoClock

private NanoClock nanoClock

loggerContext

private final java.lang.ref.WeakReference<LoggerContext> loggerContext

Constructor Detail

AbstractConfiguration

protected AbstractConfiguration(LoggerContext loggerContext,
                                ConfigurationSource configurationSource)

Constructor.

Method Detail

getConfigurationSource

public ConfigurationSource getConfigurationSource()

Description copied from interface: Configuration

Returns the source of this configuration.

Specified by:

getConfigurationSource in interface Configuration

Returns:

the source of this configuration

getPluginPackages

public java.util.List<java.lang.String> getPluginPackages()

Description copied from interface: Configuration

Returns the list of packages to scan for plugins for this Configuration.

Specified by:

getPluginPackages in interface Configuration

Returns:

the list of plugin packages.

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Specified by:

getProperties in interface Configuration

getScriptManager

public ScriptManager getScriptManager()

Specified by:

getScriptManager in interface Configuration

setScriptManager

public void setScriptManager(ScriptManager scriptManager)

getPluginManager

public PluginManager getPluginManager()

setPluginManager

public void setPluginManager(PluginManager pluginManager)

getWatchManager

public WatchManager getWatchManager()

Description copied from interface: Configuration

Return the WatchManager.

Specified by:

getWatchManager in interface Configuration

Returns:

the WatchManager.

getScheduler

public ConfigurationScheduler getScheduler()

Specified by:

getScheduler in interface Configuration

getRootNode

public Node getRootNode()

getAsyncLoggerConfigDelegate

public AsyncLoggerConfigDelegate getAsyncLoggerConfigDelegate()

Description copied from interface: Configuration

Returns the AsyncLoggerConfigDelegate shared by all AsyncLoggerConfig instances defined in this Configuration.

Specified by:

getAsyncLoggerConfigDelegate in interface Configuration

Returns:

the AsyncLoggerConfigDelegate

initialize

public void initialize()

Initialize the configuration.

Specified by:

initialize in interface LifeCycle

Overrides:

initialize in class AbstractLifeCycle

start

public void start()

Start the configuration.

Specified by:

start in interface LifeCycle

Overrides:

start in class AbstractFilterable

hasAsyncLoggers

private boolean hasAsyncLoggers()

stop

public boolean stop(long timeout,
                    java.util.concurrent.TimeUnit timeUnit)

Tear down the configuration.

Specified by:

stop in interface LifeCycle2

Overrides:

stop in class AbstractFilterable

Parameters:

timeout - the maximum time to wait

timeUnit - the time unit of the timeout argument

Returns:

true if the receiver was stopped cleanly and normally, false otherwise.

getAsyncAppenders

private java.util.List<Appender> getAsyncAppenders(Appender[] all)

isShutdownHookEnabled

public boolean isShutdownHookEnabled()

Specified by:

isShutdownHookEnabled in interface Configuration

getShutdownTimeoutMillis

public long getShutdownTimeoutMillis()

Specified by:

getShutdownTimeoutMillis in interface Configuration

setup

public void setup()

getDefaultStatus

protected Level getDefaultStatus()

createAdvertiser

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

setupAdvertisement

private void setupAdvertisement()

getComponent

public <T> T getComponent(java.lang.String componentName)

Specified by:

getComponent in interface Configuration

addComponent

public void addComponent(java.lang.String componentName,
                         java.lang.Object obj)

Specified by:

addComponent in interface Configuration

preConfigure

protected void preConfigure(Node node)

doConfigure

protected void doConfigure()

setToDefault

protected void setToDefault()

setName

public void setName(java.lang.String name)

Set the name of the configuration.

Parameters:

name - The name.

getName

public java.lang.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 <T extends Appender> T getAppender(java.lang.String appenderName)

Returns the Appender with the specified name.

Specified by:

getAppender in interface Configuration

Type Parameters:

T - The expected Appender type.

Parameters:

appenderName - The name of the Appender.

Returns:

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

getAppenders

public java.util.Map<java.lang.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.

Specified by:

addAppender in interface Configuration

Parameters:

appender - The Appender to add.

getStrSubstitutor

public StrSubstitutor getStrSubstitutor()

Specified by:

getStrSubstitutor 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

getReliabilityStrategy

public ReliabilityStrategy getReliabilityStrategy(LoggerConfig loggerConfig)

Specified by:

getReliabilityStrategy 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 Footer 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(java.lang.String appenderName)

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:

appenderName - the name of the appender to remove.

getCustomLevels

public java.util.List<CustomLevelConfig> getCustomLevels()

Description copied from interface: Configuration

Returns a list of descriptors of the custom levels defined in the current configuration. The returned list does not include custom levels that are defined in code with direct calls to Level.forName(String, int).

Note that the list does not include levels of previous configurations. For example, suppose a configuration contains custom levels A, B and C. The configuration is then modified to contain custom levels B, C and D. For the new configuration, this method will return only {B, C, D}, that is, only the custom levels defined in this configuration. The previously defined level A still exists (and can be obtained with Level.getLevel(String)), it is just not in the current configuration. Level.values() will return {A, B, C, D and the built-in levels}.

Specified by:

getCustomLevels in interface Configuration

Returns:

the custom levels defined in the current configuration

getLoggerConfig

public LoggerConfig getLoggerConfig(java.lang.String loggerName)

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:

loggerName - The Logger name.

Returns:

The located LoggerConfig.

getLoggerContext

public LoggerContext getLoggerContext()

Description copied from interface: Configuration

Gets the logger context.

Specified by:

getLoggerContext in interface Configuration

Returns:

the logger context.

getRootLogger

public LoggerConfig getRootLogger()

Returns the root Logger.

Specified by:

getRootLogger in interface Configuration

Returns:

the root Logger.

getLoggers

public java.util.Map<java.lang.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(java.lang.String loggerName)

Returns the LoggerConfig with the specified name.

Parameters:

loggerName - The Logger name.

Returns:

The LoggerConfig or null if no match was found.

addLogger

public void addLogger(java.lang.String loggerName,
                      LoggerConfig loggerConfig)

Add a loggerConfig. The LoggerConfig must already be configured with Appenders, Filters, etc. After addLogger is called LoggerContext.updateLoggers must be called.

Specified by:

addLogger in interface Configuration

Parameters:

loggerName - The name of the Logger.

loggerConfig - The LoggerConfig.

removeLogger

public void removeLogger(java.lang.String loggerName)

Remove a LoggerConfig.

Specified by:

removeLogger in interface Configuration

Parameters:

loggerName - The name of the Logger.

createConfiguration

public void createConfiguration(Node node,
                                LogEvent event)

Specified by:

createConfiguration in interface Configuration

createPluginObject

private java.lang.Object createPluginObject(PluginType<?> type,
                                            Node node,
                                            LogEvent event)

Invokes a static factory method to either create the desired object or to create a builder object that creates the desired object. In the case of a factory method, it should be annotated with PluginFactory, and each parameter should be annotated with an appropriate plugin annotation depending on what that parameter describes. Parameters annotated with PluginAttribute must be a type that can be converted from a string using one of the TypeConverters . Parameters with PluginElement may be any plugin class or an array of a plugin class. Collections and Maps are currently not supported, although the factory method that is called can create these from an array. Plugins can also be created using a builder class that implements Builder. In that case, a static method annotated with PluginBuilderAttribute should create the builder class, and the various fields in the builder class should be annotated similarly to the method parameters. However, instead of using PluginAttribute, one should use PluginBuilderAttribute where the default value can be specified as the default field value instead of as an additional annotation parameter. In either case, there are also annotations for specifying a Configuration ( PluginConfiguration) or a Node ( PluginNode). Although the happy path works, more work still needs to be done to log incorrect parameters. These will generally result in unhelpful InvocationTargetExceptions.

Parameters:

type - the type of plugin to create.

node - the corresponding configuration node for this plugin to create.

event - the LogEvent that spurred the creation of this plugin

Returns:

the created plugin object or null if there was an error setting it up.

See Also:

PluginBuilder, PluginVisitor, TypeConverter

createPluginMap

private static java.util.Map<java.lang.String,?> createPluginMap(Node node)

createPluginCollection

private static java.util.Collection<?> createPluginCollection(Node node)

setParents

private void setParents()

toByteArray

protected static byte[] toByteArray(java.io.InputStream is)
                             throws java.io.IOException

Reads an InputStream using buffered reads into a byte array buffer. The given InputStream will remain open after invocation of this method.

Parameters:

is - the InputStream to read into a byte array buffer.

Returns:

a byte array of the InputStream contents.

Throws:

java.io.IOException - if the read method of the provided InputStream throws this exception.

getNanoClock

public NanoClock getNanoClock()

Description copied from interface: Configuration

Returns the NanoClock instance for this configuration.

Specified by:

getNanoClock in interface Configuration

Returns:

the nano clock

setNanoClock

public void setNanoClock(NanoClock nanoClock)

Description copied from interface: Configuration

Sets the NanoClock instance for this configuration.

Specified by:

setNanoClock in interface Configuration

Parameters:

nanoClock - the new nano clock for this configuration. Must be non-null.