Class Hierarchy
- All Implemented Interfaces:
LoggerRepository
,RendererSupport
,ThrowableRendererSupport
The casual user does not have to deal with this class directly.
The structure of the logger hierarchy is maintained by the getLogger(java.lang.String)
method. The hierarchy is such that
children link to their parent but parents do not have any pointers to their children. Moreover, loggers can be
instantiated in any order, in particular descendant before ancestor.
In case a descendant is created before a particular ancestor, then it creates a provision node for the ancestor and adds itself to the provision node. Other descendants of the same ancestor add themselves to the previously created provision node.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
private static class
Private LogManager. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final WeakHashMap
<LoggerContext, ConcurrentMap<String, Logger>> private final LoggerFactory
(package private) boolean
(package private) boolean
(package private) Hashtable
private final Vector
private static final Hierarchy.PrivateLoggerAdapter
(package private) RendererMap
(package private) Logger
(package private) Level
(package private) int
private ThrowableRenderer
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add aHierarchyEventListener
event to the repository.void
addRenderer
(Class classToRender, ObjectRenderer or) Adds an object renderer for a specific class.void
clear()
This call will clear all logger definitions from the internal hashtable.void
Tests if the named logger exists in the hierarchy.(package private) Logger
exists
(String name, ClassLoader classLoader) (package private) Logger
exists
(String name, LoggerContext loggerContext) void
fireAddAppenderEvent
(Category logger, Appender appender) (package private) void
fireRemoveAppenderEvent
(Category logger, Appender appender) (package private) static LoggerContext
(package private) LoggerContext
getContext
(ClassLoader classLoader) Deprecated.Gets all the currently defined categories in this hierarchy as anEnumeration
.(package private) static Logger
getInstance
(LoggerContext context, String name) (package private) static Logger
getInstance
(LoggerContext context, String name, Hierarchy.PrivateLoggerAdapter factory) (package private) static Logger
getInstance
(LoggerContext context, String name, LoggerFactory factory) Gets a new logger instance named as the first parameter using the default factory.(package private) Logger
getLogger
(String name, ClassLoader classLoader) getLogger
(String name, LoggerFactory factory) Gets a new logger instance named as the first parameter usingfactory
.(package private) Logger
getLogger
(String name, LoggerFactory factory, ClassLoader classLoader) (package private) static ConcurrentMap
<String, Logger> getLoggersMap
(LoggerContext context) Gets the renderer map for this hierarchy.Gets the root of this hierarchy.(package private) Logger
getRootLogger
(ClassLoader classLoader) (package private) static Logger
getRootLogger
(LoggerContext context) Gets aLevel
representation of theenable
state.Get throwable renderer.boolean
isDisabled
(int level) This method will returntrue
if this repository is disabled forlevel
object passed as parameter andfalse
otherwise.void
overrideAsNeeded
(String override) Deprecated.Deprecated with no replacement.void
Resets all values contained in this hierarchy instance to their default.(package private) void
resetConfiguration
(ClassLoader classLoader) (package private) void
resetConfiguration
(LoggerContext loggerContext) void
setDisableOverride
(String override) Deprecated.Deprecated with no replacement.void
setRenderer
(Class renderedClass, ObjectRenderer renderer) Used by subclasses to add a renderer to the hierarchy passed as parameter.void
setThreshold
(String levelStr) The string form ofsetThreshold(Level)
.void
setThreshold
(Level level) Enable logging for logging requests with levell
or higher.void
setThrowableRenderer
(ThrowableRenderer throwableRenderer) Set throwable renderer.void
shutdown()
Shutting down a hierarchy will safely close and remove all appenders in all categories including the root logger.void
shutdown
(ClassLoader classLoader) (package private) void
shutdown
(LoggerContext context) private final void
updateChildren
(ProvisionNode pn, Logger logger) We update the links for all the children that placed themselves in the provision node 'pn'.private final void
updateParents
(Logger cat) This method loops through all the *potential* parents of 'cat'.
-
Field Details
-
LOGGER_ADAPTER
-
CONTEXT_MAP
-
defaultFactory
-
listeners
-
ht
Hashtable ht -
root
Logger root -
rendererMap
RendererMap rendererMap -
thresholdInt
int thresholdInt -
threshold
Level threshold -
emittedNoAppenderWarning
boolean emittedNoAppenderWarning -
emittedNoResourceBundleWarning
boolean emittedNoResourceBundleWarning -
throwableRenderer
-
-
Constructor Details
-
Hierarchy
Creates a new logger hierarchy.- Parameters:
root
- The root of the new hierarchy.
-
-
Method Details
-
getContext
-
getInstance
-
getInstance
-
getInstance
static Logger getInstance(LoggerContext context, String name, Hierarchy.PrivateLoggerAdapter factory) -
getLoggersMap
-
getRootLogger
-
addHierarchyEventListener
Description copied from interface:LoggerRepository
Add aHierarchyEventListener
event to the repository.- Specified by:
addHierarchyEventListener
in interfaceLoggerRepository
- Parameters:
listener
- The listener
-
addRenderer
Adds an object renderer for a specific class. -
clear
public void clear()This call will clear all logger definitions from the internal hashtable. Invoking this method will irrevocably mess up the logger hierarchy.You should really know what you are doing before invoking this method.
- Since:
- 0.9.0
-
emitNoAppenderWarning
- Specified by:
emitNoAppenderWarning
in interfaceLoggerRepository
-
exists
Tests if the named logger exists in the hierarchy. If so return its reference, otherwise returnsnull
.- Specified by:
exists
in interfaceLoggerRepository
- Parameters:
name
- The name of the logger to search for.
-
exists
-
exists
-
fireAddAppenderEvent
- Specified by:
fireAddAppenderEvent
in interfaceLoggerRepository
-
fireRemoveAppenderEvent
-
getContext
-
getCurrentCategories
Deprecated.Please usegetCurrentLoggers()
instead.Description copied from interface:LoggerRepository
Deprecated. Please useLoggerRepository.getCurrentLoggers()
instead.- Specified by:
getCurrentCategories
in interfaceLoggerRepository
- Returns:
- an enumeration of loggers.
-
getCurrentLoggers
Gets all the currently defined categories in this hierarchy as anEnumeration
.The root logger is not included in the returned
Enumeration
.- Specified by:
getCurrentLoggers
in interfaceLoggerRepository
-
getLogger
Gets a new logger instance named as the first parameter using the default factory.If a logger of that name already exists, then it will be returned. Otherwise, a new logger will be instantiated and then linked with its existing ancestors as well as children.
- Specified by:
getLogger
in interfaceLoggerRepository
- Parameters:
name
- The name of the logger to retrieve.
-
getLogger
-
getLogger
Gets a new logger instance named as the first parameter usingfactory
.If a logger of that name already exists, then it will be returned. Otherwise, a new logger will be instantiated by the
factory
parameter and linked with its existing ancestors as well as children.- Specified by:
getLogger
in interfaceLoggerRepository
- Parameters:
name
- The name of the logger to retrieve.factory
- The factory that will make the new logger instance.
-
getLogger
-
getRendererMap
Gets the renderer map for this hierarchy.- Specified by:
getRendererMap
in interfaceRendererSupport
-
getRootLogger
Gets the root of this hierarchy.- Specified by:
getRootLogger
in interfaceLoggerRepository
- Since:
- 0.9.0
-
getRootLogger
-
getThreshold
Gets aLevel
representation of theenable
state.- Specified by:
getThreshold
in interfaceLoggerRepository
- Returns:
- the level.
- Since:
- 1.2
-
getThrowableRenderer
Get throwable renderer.- Specified by:
getThrowableRenderer
in interfaceThrowableRendererSupport
- Returns:
- throwable renderer, may be null.
-
isDisabled
public boolean isDisabled(int level) This method will returntrue
if this repository is disabled forlevel
object passed as parameter andfalse
otherwise. See also thethreshold
emthod.- Specified by:
isDisabled
in interfaceLoggerRepository
- Parameters:
level
- The level- Returns:
- whether this repository is disabled.
-
overrideAsNeeded
Deprecated.Deprecated with no replacement. -
resetConfiguration
public void resetConfiguration()Resets all values contained in this hierarchy instance to their default. This removes all appenders from all categories, sets the level of all non-root categories tonull
, sets their additivity flag totrue
and sets the level of the root logger toDEBUG
. Moreover, message disabling is set its default "off" value.Existing categories are not removed. They are just reset.
This method should be used sparingly and with care as it will block all logging until it is completed.
- Specified by:
resetConfiguration
in interfaceLoggerRepository
- Since:
- 0.8.5
-
resetConfiguration
-
resetConfiguration
-
setDisableOverride
Deprecated.Deprecated with no replacement.Does nothing. -
setRenderer
Used by subclasses to add a renderer to the hierarchy passed as parameter.- Specified by:
setRenderer
in interfaceRendererSupport
-
setThreshold
Enable logging for logging requests with levell
or higher. By default all levels are enabled.- Specified by:
setThreshold
in interfaceLoggerRepository
- Parameters:
level
- The minimum level for which logging requests are sent to their appenders.
-
setThreshold
The string form ofsetThreshold(Level)
.- Specified by:
setThreshold
in interfaceLoggerRepository
- Parameters:
levelStr
- The threshold value
-
setThrowableRenderer
Set throwable renderer.- Specified by:
setThrowableRenderer
in interfaceThrowableRendererSupport
- Parameters:
throwableRenderer
- renderer, may be null.
-
shutdown
public void shutdown()Shutting down a hierarchy will safely close and remove all appenders in all categories including the root logger.Some appenders such as
invalid reference
org.apache.log4j.net.SocketAppender
AsyncAppender
need to be closed before the application exists. Otherwise, pending logging events might be lost.The
shutdown
method is careful to close nested appenders before closing regular appenders. This is allows configurations where a regular appender is attached to a logger and again to a nested appender.- Specified by:
shutdown
in interfaceLoggerRepository
- Since:
- 1.0
-
shutdown
-
shutdown
-
updateChildren
We update the links for all the children that placed themselves in the provision node 'pn'. The second argument 'cat' is a reference for the newly created Logger, parent of all the children in 'pn' We loop on all the children 'c' in 'pn': If the child 'c' has been already linked to a child of 'cat' then there is no need to update 'c'. Otherwise, we set cat's parent field to c's parent and set c's parent field to cat. -
updateParents
This method loops through all the *potential* parents of 'cat'. There 3 possible cases: 1) No entry for the potential parent of 'cat' exists We create a ProvisionNode for this potential parent and insert 'cat' in that provision node. 2) There entry is of type Logger for the potential parent. The entry is 'cat's nearest existing parent. We update cat's parent field with this entry. We also break from the loop because updating our parent's parent is our parent's responsibility. 3) There entry is of type ProvisionNode for this potential parent. We add 'cat' to the list of children for this potential parent.
-
getCurrentLoggers()
instead.