Openfire 3.5.0 Javadoc

org.jivesoftware.util.log
Class Hierarchy

java.lang.Object
  extended by org.jivesoftware.util.log.Hierarchy

public class Hierarchy
extends Object

This class encapsulates a basic independent log hierarchy. The hierarchy is essentially a safe wrapper around root logger.

Author:
Peter Donald

Constructor Summary
Hierarchy()
          Create a hierarchy object.
 
Method Summary
static Hierarchy getDefaultHierarchy()
          Retrieve the default hierarchy.
 Logger getLoggerFor(String category)
          Retrieve a logger for named category.
protected  Logger getRootLogger()
          Utility method to retrieve logger for hierarchy.
 void setDefaultLogTarget(LogTarget target)
          Set the default log target for hierarchy.
 void setDefaultLogTargets(LogTarget[] targets)
          Set the default log targets for this hierarchy.
 void setDefaultPriority(Priority priority)
          Set the default priority for hierarchy.
 void setErrorHandler(ErrorHandler errorHandler)
          Set the ErrorHandler associated with hierarchy.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Hierarchy

public Hierarchy()
Create a hierarchy object. The default LogTarget writes to stdout.

Method Detail

getDefaultHierarchy

public static Hierarchy getDefaultHierarchy()
Retrieve the default hierarchy.

In most cases the default LogHierarchy is the only one used in an application. However when security is a concern or multiple independent applications will be running in same JVM it is advantageous to create new Hierarchies rather than reuse default.

Returns:
the default Hierarchy

setDefaultLogTarget

public void setDefaultLogTarget(LogTarget target)
Set the default log target for hierarchy. This is the target inherited by loggers if no other target is specified.

Parameters:
target - the default target

setDefaultLogTargets

public void setDefaultLogTargets(LogTarget[] targets)
Set the default log targets for this hierarchy. These are the targets inherited by loggers if no other targets are specified

Parameters:
targets - the default targets

setDefaultPriority

public void setDefaultPriority(Priority priority)
Set the default priority for hierarchy. This is the priority inherited by loggers if no other priority is specified.

Parameters:
priority - the default priority

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)
Set the ErrorHandler associated with hierarchy.

Parameters:
errorHandler - the ErrorHandler

getLoggerFor

public Logger getLoggerFor(String category)
Retrieve a logger for named category.

Parameters:
category - the context
Returns:
the Logger

getRootLogger

protected final Logger getRootLogger()
Utility method to retrieve logger for hierarchy. This method is intended for use by sub-classes which can take responsibility for manipulating Logger directly.

Returns:
the Logger

Openfire 3.5.0 Javadoc

Copyright © 2003-2007 Jive Software.