Package org.apache.logging.log4j.core.config

Class LoggerConfig

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

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

org.apache.logging.log4j.core.config.LoggerConfig

All Implemented Interfaces:

Filterable, LifeCycle, LifeCycle2

Direct Known Subclasses:

AsyncLoggerConfig, AsyncLoggerConfig.RootLogger, LoggerConfig.RootLogger

@Plugin(name="logger",
        category="Core",
        printObject=true)
public class LoggerConfig
extends AbstractFilterable

Logger object that is created via configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LoggerConfig.RootLogger	The root Logger.

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	Description
static String	ROOT

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

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Constructor Summary

Constructors

Modifier	Constructor	Description
	LoggerConfig()	Default constructor.
protected	LoggerConfig(String name, List<AppenderRef> appenders, Filter filter, Level level, boolean additive, Property[] properties, Configuration config, boolean includeLocation)
	LoggerConfig(String name, Level level, boolean additive)	Constructor that sets the name, level and additive values.

Method Summary

Modifier and Type	Method	Description
void	addAppender(Appender appender, Level level, Filter filter)	Adds an Appender to the LoggerConfig.
protected void	callAppenders(LogEvent event)
protected void	clearAppenders()	Removes all Appenders.
static LoggerConfig	createLogger(boolean additivity, Level level, String loggerName, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter)	Factory method to create a LoggerConfig.
static LoggerConfig	createLogger(String additivity, Level level, String loggerName, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter)	Deprecated. Deprecated in 2.7; use createLogger(boolean, Level, String, String, AppenderRef[], Property[], Configuration, Filter)
List<AppenderRef>	getAppenderRefs()	Returns the Appender references.
Map<String,Appender>	getAppenders()	Returns all Appenders as a Map.
Filter	getFilter()	Returns the Filter.
Level	getLevel()	Returns the logging Level.
LogEventFactory	getLogEventFactory()	Returns the LogEventFactory.
String	getName()	Returns the name of the LoggerConfig.
LoggerConfig	getParent()	Returns the parent of this LoggerConfig.
Map<Property,Boolean>	getProperties()	Deprecated. use getPropertyList() instead
List<Property>	getPropertyList()	Returns an unmodifiable list with the configuration properties, or null if this LoggerConfig does not have any configuration properties.
ReliabilityStrategy	getReliabilityStrategy()	Returns the object responsible for ensuring log events are delivered to a working appender, even during or after a reconfiguration.
protected static boolean	includeLocation(String includeLocationConfigValue)
boolean	isAdditive()	Returns the valid of the additive flag.
boolean	isIncludeLocation()	Returns the value of logger configuration attribute includeLocation, or, if no such attribute was configured, true if logging is synchronous or false if logging is asynchronous.
boolean	isPropertiesRequireLookup()
void	log(String loggerName, String fqcn, Marker marker, Level level, Message data, Throwable t)	Logs an event.
void	log(LogEvent event)	Logs an event.
void	removeAppender(String name)	Removes the Appender with the specific name.
void	setAdditive(boolean additive)	Sets the additive setting.
void	setLevel(Level level)	Sets the logging Level.
void	setLogEventFactory(LogEventFactory logEventFactory)	Sets the LogEventFactory.
void	setParent(LoggerConfig parent)	Sets the parent of this LoggerConfig.
String	toString()

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

addFilter, hasFilter, isFiltered, removeFilter, start, stop, stop

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

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

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

getState, initialize, isStarted, isStopped, stop

Methods inherited from class java.lang.Object

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

Field Detail

ROOT

public static final String ROOT

See Also:

Constant Field Values

Constructor Detail

LoggerConfig

public LoggerConfig()

Default constructor.

LoggerConfig

public LoggerConfig(String name,
                    Level level,
                    boolean additive)

Constructor that sets the name, level and additive values.

Parameters:

name - The Logger name.

level - The Level.

additive - true if the Logger is additive, false otherwise.

LoggerConfig

protected LoggerConfig(String name,
                       List<AppenderRef> appenders,
                       Filter filter,
                       Level level,
                       boolean additive,
                       Property[] properties,
                       Configuration config,
                       boolean includeLocation)

Method Detail

getFilter

public Filter getFilter()

Description copied from class: AbstractFilterable

Returns the Filter.

Specified by:

getFilter in interface Filterable

Overrides:

getFilter in class AbstractFilterable

Returns:

the Filter or null.

getName

public String getName()

Returns the name of the LoggerConfig.

Returns:

the name of the LoggerConfig.

setParent

public void setParent(LoggerConfig parent)

Sets the parent of this LoggerConfig.

Parameters:

parent - the parent LoggerConfig.

getParent

public LoggerConfig getParent()

Returns the parent of this LoggerConfig.

Returns:

the LoggerConfig that is the parent of this one.

addAppender

public void addAppender(Appender appender,
                        Level level,
                        Filter filter)

Adds an Appender to the LoggerConfig.

Parameters:

appender - The Appender to add.

level - The Level to use.

filter - A Filter for the Appender reference.

removeAppender

public void removeAppender(String name)

Removes the Appender with the specific name.

Parameters:

name - The name of the Appender.

getAppenders

public Map<String,Appender> getAppenders()

Returns all Appenders as a Map.

Returns:

a Map with the Appender name as the key and the Appender as the value.

clearAppenders

protected void clearAppenders()

Removes all Appenders.

getAppenderRefs

public List<AppenderRef> getAppenderRefs()

Returns the Appender references.

Returns:

a List of all the Appender names attached to this LoggerConfig.

setLevel

public void setLevel(Level level)

Sets the logging Level.

Parameters:

level - The logging Level.

getLevel

public Level getLevel()

Returns the logging Level.

Returns:

the logging Level.

getLogEventFactory

public LogEventFactory getLogEventFactory()

Returns the LogEventFactory.

Returns:

the LogEventFactory.

setLogEventFactory

public void setLogEventFactory(LogEventFactory logEventFactory)

Sets the LogEventFactory. Usually the LogEventFactory will be this LoggerConfig.

Parameters:

logEventFactory - the LogEventFactory.

isAdditive

public boolean isAdditive()

Returns the valid of the additive flag.

Returns:

true if the LoggerConfig is additive, false otherwise.

setAdditive

public void setAdditive(boolean additive)

Sets the additive setting.

Parameters:

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

isIncludeLocation

public boolean isIncludeLocation()

Returns the value of logger configuration attribute includeLocation, or, if no such attribute was configured, true if logging is synchronous or false if logging is asynchronous.

Returns:

whether location should be passed downstream

getProperties

@Deprecated
public Map<Property,Boolean> getProperties()

Deprecated. use getPropertyList() instead

Returns an unmodifiable map with the configuration properties, or null if this LoggerConfig does not have any configuration properties.

For each Property key in the map, the value is true if the property value has a variable that needs to be substituted.

Returns:

an unmodifiable map with the configuration properties, or null

See Also:

Configuration.getStrSubstitutor(), StrSubstitutor

getPropertyList

public List<Property> getPropertyList()

Returns an unmodifiable list with the configuration properties, or null if this LoggerConfig does not have any configuration properties.

Each Property in the list has an attribute valueNeedsLookup that is true if the property value has a variable that needs to be substituted.

Returns:

an unmodifiable list with the configuration properties, or null

Since:

2.7

See Also:

Configuration.getStrSubstitutor(), StrSubstitutor

isPropertiesRequireLookup

public boolean isPropertiesRequireLookup()

log

public void log(String loggerName,
                String fqcn,
                Marker marker,
                Level level,
                Message data,
                Throwable t)

Logs an event.

Parameters:

loggerName - The name of the Logger.

fqcn - The fully qualified class name of the caller.

marker - A Marker or null if none is present.

level - The event Level.

data - The Message.

t - A Throwable or null.

log

public void log(LogEvent event)

Logs an event.

Parameters:

event - The log event.

getReliabilityStrategy

public ReliabilityStrategy getReliabilityStrategy()

Returns the object responsible for ensuring log events are delivered to a working appender, even during or after a reconfiguration.

Returns:

the object responsible for delivery of log events to the appender

callAppenders

protected void callAppenders(LogEvent event)

toString

public String toString()

Overrides:

toString in class Object

createLogger

@Deprecated
public static LoggerConfig createLogger(String additivity,
                                        Level level,
                                        @PluginAttribute("name")
                                        String loggerName,
                                        String includeLocation,
                                        AppenderRef[] refs,
                                        Property[] properties,
                                        @PluginConfiguration
                                        Configuration config,
                                        Filter filter)

Deprecated. Deprecated in 2.7; use createLogger(boolean, Level, String, String, AppenderRef[], Property[], Configuration, Filter)

Factory method to create a LoggerConfig.

Parameters:

additivity - True if additive, false otherwise.

level - The Level to be associated with the Logger.

loggerName - The name of the Logger.

includeLocation - whether location should be passed downstream

refs - An array of Appender names.

properties - Properties to pass to the Logger.

config - The Configuration.

filter - A Filter.

Returns:

A new LoggerConfig.

createLogger

@PluginFactory
public static LoggerConfig createLogger(@PluginAttribute(value="additivity",defaultBoolean=true)
                                        boolean additivity,
                                        @PluginAttribute("level")
                                        Level level,
                                        @Required(message="Loggers cannot be configured without a name") @PluginAttribute("name")
                                        String loggerName,
                                        @PluginAttribute("includeLocation")
                                        String includeLocation,
                                        @PluginElement("AppenderRef")
                                        AppenderRef[] refs,
                                        @PluginElement("Properties")
                                        Property[] properties,
                                        @PluginConfiguration
                                        Configuration config,
                                        @PluginElement("Filter")
                                        Filter filter)

Factory method to create a LoggerConfig.

Parameters:

additivity - true if additive, false otherwise.

level - The Level to be associated with the Logger.

loggerName - The name of the Logger.

includeLocation - whether location should be passed downstream

refs - An array of Appender names.

properties - Properties to pass to the Logger.

config - The Configuration.

filter - A Filter.

Returns:

A new LoggerConfig.

Since:

2.6

includeLocation

protected static boolean includeLocation(String includeLocationConfigValue)