|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.log4j.Hierarchy
public class Hierarchy
This class is specialized in retrieving loggers by name and also maintaining the logger hierarchy.
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.
Constructor Summary | |
---|---|
Hierarchy(Logger root)
Create a new logger hierarchy. |
Method Summary | |
---|---|
void |
addHierarchyEventListener(HierarchyEventListener listener)
Add a HierarchyEventListener event to the repository. |
void |
addRenderer(Class classToRender,
ObjectRenderer or)
Add an object renderer for a specific class. |
void |
clear()
This call will clear all logger definitions from the internal hashtable. |
void |
emitNoAppenderWarning(Category cat)
|
Logger |
exists(String name)
Check if the named logger exists in the hierarchy. |
void |
fireAddAppenderEvent(Category logger,
Appender appender)
|
Enumeration |
getCurrentCategories()
Deprecated. Please use getCurrentLoggers() instead. |
Enumeration |
getCurrentLoggers()
Returns all the currently defined categories in this hierarchy as an Enumeration . |
Logger |
getLogger(String name)
Return a new logger instance named as the first parameter using the default factory. |
Logger |
getLogger(String name,
LoggerFactory factory)
Return a new logger instance named as the first parameter using factory . |
RendererMap |
getRendererMap()
Get the renderer map for this hierarchy. |
Logger |
getRootLogger()
Get the root of this hierarchy. |
Level |
getThreshold()
Returns a Level representation of the enable
state. |
ThrowableRenderer |
getThrowableRenderer()
Get throwable renderer. |
boolean |
isDisabled(int level)
This method will return true if this repository is
disabled for level object passed as parameter and
false otherwise. |
void |
overrideAsNeeded(String override)
Deprecated. Deprecated with no replacement. |
void |
resetConfiguration()
Reset all values contained in this hierarchy instance to their default. |
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(Level l)
Enable logging for logging requests with level l or
higher. |
void |
setThreshold(String levelStr)
The string form of setThreshold(Level) . |
void |
setThrowableRenderer(ThrowableRenderer renderer)
Set throwable renderer. |
void |
shutdown()
Shutting down a hierarchy will safely close and remove all appenders in all categories including the root logger. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Hierarchy(Logger root)
root
- The root of the new hierarchy.Method Detail |
---|
public void addRenderer(Class classToRender, ObjectRenderer or)
public void addHierarchyEventListener(HierarchyEventListener listener)
LoggerRepository
HierarchyEventListener
event to the repository.
addHierarchyEventListener
in interface LoggerRepository
public void clear()
You should really know what you are doing before invoking this method.
public void emitNoAppenderWarning(Category cat)
emitNoAppenderWarning
in interface LoggerRepository
public Logger exists(String name)
null
.
exists
in interface LoggerRepository
name
- The name of the logger to search for.public void setThreshold(String levelStr)
setThreshold(Level)
.
setThreshold
in interface LoggerRepository
public void setThreshold(Level l)
l
or
higher. By default all levels are enabled.
setThreshold
in interface LoggerRepository
l
- The minimum level for which logging requests are sent to
their appenders.public void fireAddAppenderEvent(Category logger, Appender appender)
fireAddAppenderEvent
in interface LoggerRepository
public Level getThreshold()
Level
representation of the enable
state.
getThreshold
in interface LoggerRepository
public Logger getLogger(String name)
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.
getLogger
in interface LoggerRepository
name
- The name of the logger to retrieve.public Logger getLogger(String name, LoggerFactory factory)
factory
.
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.
getLogger
in interface LoggerRepository
name
- The name of the logger to retrieve.factory
- The factory that will make the new logger instance.public Enumeration getCurrentLoggers()
Enumeration
.
The root logger is not included in the returned
Enumeration
.
getCurrentLoggers
in interface LoggerRepository
public Enumeration getCurrentCategories()
getCurrentLoggers()
instead.
LoggerRepository
LoggerRepository.getCurrentLoggers()
instead.
getCurrentCategories
in interface LoggerRepository
public RendererMap getRendererMap()
getRendererMap
in interface RendererSupport
public Logger getRootLogger()
getRootLogger
in interface LoggerRepository
public boolean isDisabled(int level)
true
if this repository is
disabled for level
object passed as parameter and
false
otherwise. See also the threshold
emthod.
isDisabled
in interface LoggerRepository
public void overrideAsNeeded(String override)
public void resetConfiguration()
null
,
sets their additivity flag to true
and sets the level
of the root logger to DEBUG
. 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.
resetConfiguration
in interface LoggerRepository
public void setDisableOverride(String override)
public void setRenderer(Class renderedClass, ObjectRenderer renderer)
setRenderer
in interface RendererSupport
public void setThrowableRenderer(ThrowableRenderer renderer)
setThrowableRenderer
in interface ThrowableRendererSupport
renderer
- renderer, may be null.public ThrowableRenderer getThrowableRenderer()
getThrowableRenderer
in interface ThrowableRendererSupport
public void shutdown()
Some appenders such as SocketAppender
and 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.
shutdown
in interface LoggerRepository
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |