public class Logger extends AbstractLogger implements Supplier<LoggerConfig>
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.
TODO All the isEnabled methods could be pushed into a filter interface. Not sure of the utility of having isEnabled
be able to examine the message pattern and parameters. (RG) Moving the isEnabled methods out of Logger noticeably
impacts performance. The message pattern and parameters are required so that they can be used in global filters.Modifier and Type | Class and Description |
---|---|
protected static class |
Logger.LoggerProxy
Serialization proxy class for Logger.
|
protected class |
Logger.PrivateConfig
The binding between a Logger and its configuration.
|
Modifier and Type | Field and Description |
---|---|
protected Logger.PrivateConfig |
privateConfig
Config should be consistent across threads.
|
CATCHING_MARKER, DEFAULT_MESSAGE_FACTORY_CLASS, ENTRY_MARKER, EXCEPTION_MARKER, EXIT_MARKER, FLOW_MARKER, THROWING_MARKER
Modifier | Constructor and Description |
---|---|
protected |
Logger(LoggerContext context,
String name,
MessageFactory messageFactory)
The constructor.
|
Modifier and Type | Method and 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.
|
boolean |
equals(Object o) |
int |
filterCount()
This method is not exposed through the public API and is used primarily for unit testing.
|
LoggerConfig |
get()
Gets a value.
|
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.
|
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(Level level,
Marker marker,
Message message,
Throwable t)
Determines if logging is enabled.
|
boolean |
isEnabled(Level level,
Marker marker,
Object message,
Throwable t)
Determines if logging is enabled.
|
boolean |
isEnabled(Level level,
Marker marker,
String message)
Determine if logging is enabled.
|
boolean |
isEnabled(Level level,
Marker marker,
String message,
Object... params)
Determines if logging is enabled.
|
boolean |
isEnabled(Level level,
Marker marker,
String message,
Throwable t)
Determines if logging is enabled.
|
void |
logMessage(String fqcn,
Level level,
Marker marker,
Message message,
Throwable t)
Always logs a message at the specified level.
|
void |
removeAppender(Appender appender)
This method is not exposed through the public API and is used primarily for unit testing.
|
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(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.
|
protected Object |
writeReplace() |
catching, catching, catching, catchingMsg, checkMessageFactory, 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, entry, entryMsg, 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, exit, exitMsg, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, getMessageFactory, getName, 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, 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, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, printf, printf, throwing, throwing, throwing, throwingMsg, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn
protected volatile Logger.PrivateConfig privateConfig
protected Logger(LoggerContext context, String name, MessageFactory messageFactory)
context
- The LoggerContext this Logger is associated with.messageFactory
- The message factory.name
- The name of the Logger.protected Object writeReplace() throws ObjectStreamException
ObjectStreamException
public Logger getParent()
public LoggerContext getContext()
public void setLevel(Level level)
If the new level is null, this logger inherits the level from its parent.
level
- The Level to use on this Logger, may be null.public LoggerConfig get()
Supplier
get
in interface Supplier<LoggerConfig>
public void logMessage(String fqcn, Level level, Marker marker, Message message, Throwable t)
ExtendedLogger
logMessage
in interface ExtendedLogger
fqcn
- The fully qualified class name of the logger entry point, used to determine the caller class and
method when location information needs to be logged.level
- The logging Level to check.marker
- A Marker or null.message
- The Message.t
- the exception to log, including its stack trace.public boolean isEnabled(Level level, Marker marker, String message, Throwable t)
ExtendedLogger
isEnabled
in interface ExtendedLogger
level
- The logging Level to check.marker
- A Marker or null.message
- The message.t
- the exception to log, including its stack trace.public boolean isEnabled(Level level, Marker marker, String message)
ExtendedLogger
isEnabled
in interface ExtendedLogger
level
- The logging Level to check.marker
- A Marker or null.message
- The message.public boolean isEnabled(Level level, Marker marker, String message, Object... params)
ExtendedLogger
isEnabled
in interface ExtendedLogger
level
- The logging Level to check.marker
- A Marker or null.message
- The message.params
- The parameters.public boolean isEnabled(Level level, Marker marker, Object message, Throwable t)
ExtendedLogger
isEnabled
in interface ExtendedLogger
level
- The logging Level to check.marker
- A Marker or null.message
- The message.t
- A Throwable.public boolean isEnabled(Level level, Marker marker, Message message, Throwable t)
ExtendedLogger
isEnabled
in interface ExtendedLogger
level
- The logging Level to check.marker
- A Marker or null.message
- The Message.t
- A Throwable.public void addAppender(Appender appender)
appender
- The Appender to add to the Logger.public void removeAppender(Appender appender)
appender
- The Appender to remove from the Logger.public Map<String,Appender> getAppenders()
public Iterator<Filter> getFilters()
public Level getLevel()
public int filterCount()
public void addFilter(Filter filter)
filter
- The Filter to add.public boolean isAdditive()
public void setAdditive(boolean additive)
additive
- Boolean value to indicate whether the Logger is additive or not.protected void updateConfiguration(Configuration newConfig)
There are two ways this could be used to guarantee all threads are aware of changes to config.
newConfig
- The new Configuration.public String toString()
"name:level[ in context_name]"
.Copyright © 1999-2017 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.