Interface Configuration
- All Superinterfaces:
Filterable
,LifeCycle
- All Known Implementing Classes:
AbstractConfiguration
,BuiltConfiguration
,CompositeConfiguration
,DefaultConfiguration
,JsonConfiguration
,NullConfiguration
,PropertiesConfiguration
,XmlConfiguration
,YamlConfiguration
Custom implementations are recommended to extend AbstractConfiguration
.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle
LifeCycle.State
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAppender
(Appender appender) void
addComponent
(String name, Object object) void
addListener
(ConfigurationListener listener) void
addLogger
(String name, LoggerConfig loggerConfig) void
addLoggerAppender
(Logger logger, Appender appender) void
addLoggerFilter
(Logger logger, Filter filter) void
createConfiguration
(Node node, LogEvent event) <T extends Appender>
TgetAppender
(String name) Returns the Appender with the specified name.Returns a Map containing all the Appenders and their name.Returns theAsyncLoggerConfigDelegate
shared by allAsyncLoggerConfig
instances defined in this Configuration.Returns theAsyncWaitStrategyFactory
defined in this Configuration; this factory is used to create the LMAX disruptorWaitStrategy
used by the disruptor ringbuffer for Async Loggers.<T> T
getComponent
(String name) Returns the source of this configuration.default StrSubstitutor
Returns a list of descriptors of the custom levels defined in the current configuration.getLoggerConfig
(String name) Locates the appropriate LoggerConfig for a Logger name.Gets the logger context.getName()
Returns the configuration name.Returns theNanoClock
instance for this configuration.Returns the list of packages to scan for plugins for this Configuration.getReliabilityStrategy
(LoggerConfig loggerConfig) Returns the root Logger.long
Return the WatchManager.boolean
void
removeListener
(ConfigurationListener listener) void
removeLogger
(String name) void
setAdvertiser
(Advertiser advertiser) void
setLoggerAdditive
(Logger logger, boolean additive) void
setNanoClock
(NanoClock nanoClock) Sets theNanoClock
instance for this configuration.Methods inherited from interface org.apache.logging.log4j.core.filter.Filterable
addFilter, getFilter, hasFilter, isFiltered, removeFilter
-
Field Details
-
CONTEXT_PROPERTIES
Key for storing the Context properties.- See Also:
-
-
Method Details
-
getName
String getName()Returns the configuration name.- Returns:
- the name of the configuration.
-
getLoggerConfig
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.- Parameters:
name
- The Logger name.- Returns:
- The located LoggerConfig.
-
getAppender
Returns the Appender with the specified name.- Type Parameters:
T
- The expected Appender type.- Parameters:
name
- The name of the Appender.- Returns:
- the Appender with the specified name or null if the Appender cannot be located.
-
getAppenders
Returns a Map containing all the Appenders and their name.- Returns:
- A Map containing each Appender's name and the Appender object.
-
addAppender
-
getLoggers
Map<String,LoggerConfig> getLoggers() -
addLoggerAppender
-
addLoggerFilter
-
setLoggerAdditive
-
addLogger
-
removeLogger
-
getPluginPackages
Returns the list of packages to scan for plugins for this Configuration.- Returns:
- the list of plugin packages.
- Since:
- 2.1
-
getProperties
-
getRootLogger
LoggerConfig getRootLogger()Returns the root Logger.- Returns:
- the root Logger.
-
addListener
-
removeListener
-
getStrSubstitutor
StrSubstitutor getStrSubstitutor() -
getConfigurationStrSubstitutor
-
createConfiguration
-
getComponent
-
addComponent
-
setAdvertiser
-
getAdvertiser
Advertiser getAdvertiser() -
isShutdownHookEnabled
boolean isShutdownHookEnabled() -
getShutdownTimeoutMillis
long getShutdownTimeoutMillis() -
getScheduler
ConfigurationScheduler getScheduler() -
getConfigurationSource
ConfigurationSource getConfigurationSource()Returns the source of this configuration.- Returns:
- the source of this configuration, never
null
, but may beConfigurationSource.NULL_SOURCE
orConfigurationSource.COMPOSITE_SOURCE
-
getCustomLevels
List<CustomLevelConfig> getCustomLevels()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}.- Returns:
- the custom levels defined in the current configuration
-
getScriptManager
ScriptManager getScriptManager() -
getAsyncLoggerConfigDelegate
AsyncLoggerConfigDelegate getAsyncLoggerConfigDelegate()Returns theAsyncLoggerConfigDelegate
shared by allAsyncLoggerConfig
instances defined in this Configuration.- Returns:
- the
AsyncLoggerConfigDelegate
-
getAsyncWaitStrategyFactory
AsyncWaitStrategyFactory getAsyncWaitStrategyFactory()Returns theAsyncWaitStrategyFactory
defined in this Configuration; this factory is used to create the LMAX disruptorWaitStrategy
used by the disruptor ringbuffer for Async Loggers.- Returns:
- the
AsyncWaitStrategyFactory
- Since:
- 2.17.3
-
getWatchManager
WatchManager getWatchManager()Return the WatchManager.- Returns:
- the WatchManager.
-
getReliabilityStrategy
-
getNanoClock
NanoClock getNanoClock()Returns theNanoClock
instance for this configuration.- Returns:
- the nano clock
-
setNanoClock
Sets theNanoClock
instance for this configuration.- Parameters:
nanoClock
- the new nano clock for this configuration. Must be non-null.
-
getLoggerContext
LoggerContext getLoggerContext()Gets the logger context.- Returns:
- the logger context.
-