| Methods Summary |
|---|
| public void | addHierarchyEventListener(org.apache.log4j.spi.HierarchyEventListener listener)
if(listeners.contains(listener)) {
LogLog.warn("Ignoring attempt to add an existent listener.");
} else {
listeners.addElement(listener);
}
|
| public void | addRenderer(java.lang.Class classToRender, org.apache.log4j.or.ObjectRenderer or)Add an object renderer for a specific class.
rendererMap.put(classToRender, or);
|
| 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.
//System.out.println("\n\nAbout to clear internal hash table.");
ht.clear();
|
| public void | emitNoAppenderWarning(org.apache.log4j.Category cat)
// No appenders in hierarchy, warn user only once.
if(!this.emittedNoAppenderWarning) {
LogLog.warn("No appenders could be found for logger (" +
cat.getName() + ").");
LogLog.warn("Please initialize the log4j system properly.");
this.emittedNoAppenderWarning = true;
}
|
| public org.apache.log4j.Logger | exists(java.lang.String name)Check if the named logger exists in the hierarchy. If so return
its reference, otherwise returns null.
Object o = ht.get(new CategoryKey(name));
if(o instanceof Logger) {
return (Logger) o;
} else {
return null;
}
|
| public void | fireAddAppenderEvent(org.apache.log4j.Category logger, org.apache.log4j.Appender appender)
if(listeners != null) {
int size = listeners.size();
HierarchyEventListener listener;
for(int i = 0; i < size; i++) {
listener = (HierarchyEventListener) listeners.elementAt(i);
listener.addAppenderEvent(logger, appender);
}
}
|
| void | fireRemoveAppenderEvent(org.apache.log4j.Category logger, org.apache.log4j.Appender appender)
if(listeners != null) {
int size = listeners.size();
HierarchyEventListener listener;
for(int i = 0; i < size; i++) {
listener = (HierarchyEventListener) listeners.elementAt(i);
listener.removeAppenderEvent(logger, appender);
}
}
|
| public java.util.Enumeration | getCurrentCategories()
return getCurrentLoggers();
|
| public java.util.Enumeration | getCurrentLoggers()Returns all the currently defined categories in this hierarchy as
an {@link java.util.Enumeration Enumeration}.
The root logger is not included in the returned
{@link Enumeration}.
// The accumlation in v is necessary because not all elements in
// ht are Logger objects as there might be some ProvisionNodes
// as well.
Vector v = new Vector(ht.size());
Enumeration elems = ht.elements();
while(elems.hasMoreElements()) {
Object o = elems.nextElement();
if(o instanceof Logger) {
v.addElement(o);
}
}
return v.elements();
|
| public org.apache.log4j.Logger | getLogger(java.lang.String name)Return 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.
return getLogger(name, defaultFactory);
|
| public org.apache.log4j.Logger | getLogger(java.lang.String name, org.apache.log4j.spi.LoggerFactory factory)Return a new logger instance named as the first parameter using
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.
//System.out.println("getInstance("+name+") called.");
CategoryKey key = new CategoryKey(name);
// Synchronize to prevent write conflicts. Read conflicts (in
// getChainedLevel method) are possible only if variable
// assignments are non-atomic.
Logger logger;
synchronized(ht) {
Object o = ht.get(key);
if(o == null) {
logger = factory.makeNewLoggerInstance(name);
logger.setHierarchy(this);
ht.put(key, logger);
updateParents(logger);
return logger;
} else if(o instanceof Logger) {
return (Logger) o;
} else if (o instanceof ProvisionNode) {
//System.out.println("("+name+") ht.get(this) returned ProvisionNode");
logger = factory.makeNewLoggerInstance(name);
logger.setHierarchy(this);
ht.put(key, logger);
updateChildren((ProvisionNode) o, logger);
updateParents(logger);
return logger;
}
else {
// It should be impossible to arrive here
return null; // but let's keep the compiler happy.
}
}
|
| public org.apache.log4j.or.RendererMap | getRendererMap()Get the renderer map for this hierarchy.
return rendererMap;
|
| public org.apache.log4j.Logger | getRootLogger()Get the root of this hierarchy.
return root;
|
| public org.apache.log4j.Level | getThreshold()Returns a {@link Level} representation of the enable
state.
return threshold;
|
| public boolean | isDisabled(int level)This method will return true if this repository is
disabled for level object passed as parameter and
false otherwise. See also the {@link
#setThreshold(Level) threshold} emthod.
return thresholdInt > level;
|
| public void | overrideAsNeeded(java.lang.String override)
LogLog.warn("The Hiearchy.overrideAsNeeded method has been deprecated.");
|
| public void | resetConfiguration()Reset 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 to null,
sets their additivity flag to true and sets the level
of the root logger to {@link Level#DEBUG 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.
getRootLogger().setLevel((Level) Level.DEBUG);
root.setResourceBundle(null);
setThreshold(Level.ALL);
// the synchronization is needed to prevent JDK 1.2.x hashtable
// surprises
synchronized(ht) {
shutdown(); // nested locks are OK
Enumeration cats = getCurrentLoggers();
while(cats.hasMoreElements()) {
Logger c = (Logger) cats.nextElement();
c.setLevel(null);
c.setAdditivity(true);
c.setResourceBundle(null);
}
}
rendererMap.clear();
|
| public void | setDisableOverride(java.lang.String override)Does mothing.
LogLog.warn("The Hiearchy.setDisableOverride method has been deprecated.");
|
| public void | setRenderer(java.lang.Class renderedClass, org.apache.log4j.or.ObjectRenderer renderer)Used by subclasses to add a renderer to the hierarchy passed as parameter.
rendererMap.put(renderedClass, renderer);
|
| public void | setThreshold(java.lang.String levelStr)The string form of {@link #setThreshold(Level)}.
Level l = (Level) Level.toLevel(levelStr, null);
if(l != null) {
setThreshold(l);
} else {
LogLog.warn("Could not convert ["+levelStr+"] to Level.");
}
|
| public void | setThreshold(org.apache.log4j.Level l)Enable logging for logging requests with level l or
higher. By default all levels are enabled.
if(l != null) {
thresholdInt = l.level;
threshold = l;
}
|
| 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 {@link org.apache.log4j.net.SocketAppender}
and {@link 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.
Logger root = getRootLogger();
// begin by closing nested appenders
root.closeNestedAppenders();
synchronized(ht) {
Enumeration cats = this.getCurrentLoggers();
while(cats.hasMoreElements()) {
Logger c = (Logger) cats.nextElement();
c.closeNestedAppenders();
}
// then, remove all appenders
root.removeAllAppenders();
cats = this.getCurrentLoggers();
while(cats.hasMoreElements()) {
Logger c = (Logger) cats.nextElement();
c.removeAllAppenders();
}
}
|
| private final void | updateChildren(org.apache.log4j.ProvisionNode pn, org.apache.log4j.Logger logger)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.
//System.out.println("updateChildren called for " + logger.name);
final int last = pn.size();
for(int i = 0; i < last; i++) {
Logger l = (Logger) pn.elementAt(i);
//System.out.println("Updating child " +p.name);
// Unless this child already points to a correct (lower) parent,
// make cat.parent point to l.parent and l.parent to cat.
if(!l.parent.name.startsWith(logger.name)) {
logger.parent = l.parent;
l.parent = logger;
}
}
|
| private final void | updateParents(org.apache.log4j.Logger cat)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.
String name = cat.name;
int length = name.length();
boolean parentFound = false;
//System.out.println("UpdateParents called for " + name);
// if name = "w.x.y.z", loop thourgh "w.x.y", "w.x" and "w", but not "w.x.y.z"
for(int i = name.lastIndexOf('.", length-1); i >= 0;
i = name.lastIndexOf('.", i-1)) {
String substr = name.substring(0, i);
//System.out.println("Updating parent : " + substr);
CategoryKey key = new CategoryKey(substr); // simple constructor
Object o = ht.get(key);
// Create a provision node for a future parent.
if(o == null) {
//System.out.println("No parent "+substr+" found. Creating ProvisionNode.");
ProvisionNode pn = new ProvisionNode(cat);
ht.put(key, pn);
} else if(o instanceof Category) {
parentFound = true;
cat.parent = (Category) o;
//System.out.println("Linking " + cat.name + " -> " + ((Category) o).name);
break; // no need to update the ancestors of the closest ancestor
} else if(o instanceof ProvisionNode) {
((ProvisionNode) o).addElement(cat);
} else {
Exception e = new IllegalStateException("unexpected object type " +
o.getClass() + " in ht.");
e.printStackTrace();
}
}
// If we could not find any existing parents, then link with root.
if(!parentFound)
cat.parent = root;
|
