Package org.apache.logging.log4j.core

Class Logger

java.lang.Object

org.apache.logging.log4j.kit.logger.AbstractLogger

org.apache.logging.log4j.core.Logger

All Implemented Interfaces:

Supplier<LoggerConfig>, org.apache.logging.log4j.Logger, org.apache.logging.log4j.spi.ExtendedLogger, org.apache.logging.log4j.util.Supplier<LoggerConfig>

@NullMarked
public class Logger
extends AbstractLogger
implements org.apache.logging.log4j.util.Supplier<LoggerConfig>

The core implementation of the Logger interface. Besides providing an implementation of all the Logger methods, this class also provides some convenience methods for Log4j 1.x compatibility as well as access to the Filters and Appenders associated with this Logger. Note that access to these underlying objects is provided primarily for use in unit tests or bridging legacy Log4j 1.x code. Future versions of this class may or may not include the various methods that are noted as not being part of the public API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Logger.Builder
protected class	Logger.PrivateConfig	The binding between a Logger and its configuration.

Field Summary

Fields

Modifier and Type	Field	Description
protected Logger.PrivateConfig	privateConfig	Config should be consistent across threads.

Fields inherited from class org.apache.logging.log4j.kit.logger.AbstractLogger

CATCHING_MARKER, ENTRY_MARKER, EXCEPTION_MARKER, EXIT_MARKER, FLOW_MARKER, THROWING_MARKER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Logger(LoggerContext context, String name, org.apache.logging.log4j.message.MessageFactory messageFactory, org.apache.logging.log4j.message.FlowMessageFactory flowMessageFactory, RecyclerFactory recyclerFactory, org.apache.logging.log4j.Logger statusLogger)	The constructor.

Method Summary

Modifier and Type	Method	Description
void	addAppender(Appender appender)	This method is not exposed through the public API and is used primarily for unit testing.
void	addFilter(Filter filter)	This method is not exposed through the public API and is used primarily for unit testing.
org.apache.logging.log4j.LogBuilder	atLevel(org.apache.logging.log4j.Level level)
protected void	doLog(String fqcn, @Nullable StackTraceElement location, org.apache.logging.log4j.Level level, @Nullable org.apache.logging.log4j.Marker marker, @Nullable org.apache.logging.log4j.message.Message message, @Nullable Throwable throwable)
boolean	equals(Object o)
int	filterCount()	This method is not exposed through the public API and is used primarily for unit testing.
LoggerConfig	get()
Map<String,Appender>	getAppenders()	This method is not exposed through the public API and is used primarily for unit testing.
LoggerContext	getContext()	Returns the LoggerContext this Logger is associated with.
Iterator<Filter>	getFilters()	This method is not exposed through the public API and is used primarily for unit testing.
org.apache.logging.log4j.Level	getLevel()	Gets the Level associated with the Logger.
Logger	getParent()	This method is only used for 1.x compatibility.
int	hashCode()
boolean	isAdditive()	This method is not exposed through the public API and is present only to support the Log4j 1.2 compatibility bridge.
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, CharSequence message, Throwable t)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, Object message, Throwable t)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object... params)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2, Object p3)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8, Object p9)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Throwable t)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, org.apache.logging.log4j.message.Message message, Throwable t)
void	removeAppender(Appender appender)	This method is not exposed through the public API and is used primarily for unit testing.
protected boolean	requiresLocation()
void	setAdditive(boolean additive)	This method is not exposed through the public API and is present only to support the Log4j 1.2 compatibility bridge.
void	setLevel(org.apache.logging.log4j.Level level)	This method is not exposed through the public API and is provided primarily for unit testing.
String	toString()	Returns a String representation of this instance in the form "name:level[ in context_name]".
protected void	updateConfiguration(Configuration newConfig)	Associates this Logger with a new Configuration.

Methods inherited from class org.apache.logging.log4j.kit.logger.AbstractLogger

always, atDebug, atError, atFatal, atInfo, atTrace, atWarn, catching, catching, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, entry, entry, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, exit, exit, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, getFlowMessageFactory, getLogBuilder, getMessageFactory, getName, getRecursionDepth, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, isDebugEnabled, isDebugEnabled, isEnabled, isErrorEnabled, isErrorEnabled, isFatalEnabled, isFatalEnabled, isInfoEnabled, isInfoEnabled, isTraceEnabled, isTraceEnabled, isWarnEnabled, isWarnEnabled, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, logCatchingMessage, logEnterMessage, logEnterMessage, logExitMessage, logExitMessage, logExitMessage, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logPrintfMessage, logThrowingMessage, printf, printf, throwing, throwing, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, traceEntry, traceEntry, traceEntry, traceEntry, traceEntry, traceExit, traceExit, traceExit, traceExit, traceExit, traceExit, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

privateConfig

protected volatile Logger.PrivateConfig privateConfig

Config should be consistent across threads.

Constructor Details

Logger

protected Logger(LoggerContext context,
 String name,
 org.apache.logging.log4j.message.MessageFactory messageFactory,
 org.apache.logging.log4j.message.FlowMessageFactory flowMessageFactory,
 RecyclerFactory recyclerFactory,
 org.apache.logging.log4j.Logger statusLogger)

The constructor.

Parameters:

context - The LoggerContext this Logger is associated with.

name - The name of the Logger.

messageFactory - The message factory to use for logging methods.

flowMessageFactory - The flow message factory to use for flow logging methods.

recyclerFactory - The recycler to use for log builder instances.

Method Details

getParent

public Logger getParent()

This method is only used for 1.x compatibility. Returns the parent of this Logger. If it doesn't already exist return a temporary Logger.

Returns:

The parent Logger.

getContext

public LoggerContext getContext()

Returns the LoggerContext this Logger is associated with.

Returns:

the LoggerContext.

setLevel

public void setLevel(org.apache.logging.log4j.Level level)

This method is not exposed through the public API and is provided primarily for unit testing.

If the new level is null, this logger inherits the level from its parent.

Parameters:

level - The Level to use on this Logger, may be null.

get

public LoggerConfig get()

Specified by:

get in interface Supplier<LoggerConfig>

Specified by:

get in interface org.apache.logging.log4j.util.Supplier<LoggerConfig>

requiresLocation

protected boolean requiresLocation()

doLog

protected void doLog(String fqcn,
 @Nullable StackTraceElement location,
 org.apache.logging.log4j.Level level,
 @Nullable org.apache.logging.log4j.Marker marker,
 @Nullable org.apache.logging.log4j.message.Message message,
 @Nullable Throwable throwable)

Specified by:

doLog in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker)

Specified by:

isEnabled in interface org.apache.logging.log4j.Logger

Specified by:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 String message)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 String message,
 Throwable t)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 String message,
 Object... params)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 String message,
 Object p0)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 String message,
 Object p0,
 Object p1)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6,
 Object p7)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6,
 Object p7,
 Object p8)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6,
 Object p7,
 Object p8,
 Object p9)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 CharSequence message,
 Throwable t)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 Object message,
 Throwable t)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
 org.apache.logging.log4j.Marker marker,
 org.apache.logging.log4j.message.Message message,
 Throwable t)

Specified by:

isEnabled in interface org.apache.logging.log4j.spi.ExtendedLogger

Overrides:

isEnabled in class AbstractLogger

addAppender

public void addAppender(Appender appender)

This method is not exposed through the public API and is used primarily for unit testing.

Parameters:

appender - The Appender to add to the Logger.

removeAppender

public void removeAppender(Appender appender)

This method is not exposed through the public API and is used primarily for unit testing.

Parameters:

appender - The Appender to remove from the Logger.

getAppenders

public Map<String,Appender> getAppenders()

This method is not exposed through the public API and is used primarily for unit testing.

Returns:

A Map containing the Appender's name as the key and the Appender as the value.

getFilters

public Iterator<Filter> getFilters()

This method is not exposed through the public API and is used primarily for unit testing.

Returns:

An Iterator over all the Filters associated with the Logger.

getLevel

public org.apache.logging.log4j.Level getLevel()

Gets the Level associated with the Logger.

Specified by:

getLevel in interface org.apache.logging.log4j.Logger

Returns:

the Level associate with the Logger.

filterCount

public int filterCount()

This method is not exposed through the public API and is used primarily for unit testing.

Returns:

The number of Filters associated with the Logger.

addFilter

public void addFilter(Filter filter)

This method is not exposed through the public API and is used primarily for unit testing.

Parameters:

filter - The Filter to add.

isAdditive

public boolean isAdditive()

This method is not exposed through the public API and is present only to support the Log4j 1.2 compatibility bridge.

Returns:

true if the associated LoggerConfig is additive, false otherwise.

setAdditive

public void setAdditive(boolean additive)

This method is not exposed through the public API and is present only to support the Log4j 1.2 compatibility bridge.

Parameters:

additive - Boolean value to indicate whether the Logger is additive or not.

atLevel

public org.apache.logging.log4j.LogBuilder atLevel(org.apache.logging.log4j.Level level)

Specified by:

atLevel in interface org.apache.logging.log4j.Logger

Overrides:

atLevel in class AbstractLogger

updateConfiguration

protected void updateConfiguration(Configuration newConfig)

Associates this Logger with a new Configuration. This method is not exposed through the public API.

There are two ways this could be used to guarantee all threads are aware of changes to config.

1. Synchronize this method. Accessors don't need to be synchronized as Java will treat all variables within a synchronized block as volatile.
2. Declare the variable volatile. Option 2 is used here as the performance cost is very low and it does a better job at documenting how it is used.

Parameters:

newConfig - The new Configuration.

toString

public String toString()

Returns a String representation of this instance in the form "name:level[ in context_name]".

Overrides:

toString in class Object

Returns:

A String describing this Logger instance.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object