Classes | Public Member Functions | Static Public Member Functions

Hierarchy Class Reference

This class is specialized in retrieving loggers by name and also maintaining the logger hierarchy. More...

Inherits log4cxx::spi::LoggerRepository, and log4cxx::helpers::ObjectImpl.

List of all members.

Classes

class  ClazzHierarchy

Public Member Functions

virtual const helpers::ClassgetClass () const
const void * cast (const helpers::Class &clazz) const
bool instanceof (const helpers::Class &clazz) const
 Hierarchy ()
 Create a new logger hierarchy.
 ~Hierarchy ()
void addRef () const
void releaseRef () const
void addHierarchyEventListener (const spi::HierarchyEventListenerPtr &listener)
void clear ()
 This call will clear all logger definitions from the internal hashtable.
void emitNoAppenderWarning (const LoggerPtr &logger)
LoggerPtr exists (const LogString &name)
 Check if the named logger exists in the hierarchy.
void setThreshold (const LogString &levelStr)
 The string form of setThreshold.
void setThreshold (const LevelPtr &l)
 Enable logging for logging requests with level l or higher.
void fireAddAppenderEvent (const LoggerPtr &logger, const AppenderPtr &appender)
void fireRemoveAppenderEvent (const LoggerPtr &logger, const AppenderPtr &appender)
const LevelPtrgetThreshold () const
 Returns a Level representation of the enable state.
LoggerPtr getLogger (const LogString &name)
 Return a new logger instance named as the first parameter using the default factory.
LoggerPtr getLogger (const LogString &name, const spi::LoggerFactoryPtr &factory)
 Return a new logger instance named as the first parameter using factory.
LoggerList getCurrentLoggers () const
 Returns all the currently defined loggers in this hierarchy as a LoggerList.
LoggerPtr getRootLogger () const
 Get the root of this hierarchy.
bool isDisabled (int level) const
 This method will return true if this repository is disabled for level object passed as parameter and false otherwise.
void resetConfiguration ()
 Reset all values contained in this hierarchy instance to their default.
void shutdown ()
 Used by subclasses to add a renderer to the hierarchy passed as parameter.
virtual bool isConfigured ()
virtual void setConfigured (bool configured)

Static Public Member Functions

static const helpers::ClassgetStaticClass ()
static const
log4cxx::helpers::ClassRegistration
registerClass ()

Detailed Description

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 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 & Destructor Documentation

Hierarchy (  ) 

Create a new logger hierarchy.

~Hierarchy (  ) 

Member Function Documentation

void addHierarchyEventListener ( const spi::HierarchyEventListenerPtr listener  ) 
void addRef (  )  const [virtual]

Reimplemented from ObjectImpl.

const void* cast ( const helpers::Class clazz  )  const [inline, virtual]

Implements Object.

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.

void emitNoAppenderWarning ( const LoggerPtr logger  ) 
LoggerPtr exists ( const LogString name  ) 

Check if the named logger exists in the hierarchy.

If so return its reference, otherwise returns null.

Parameters:
name The name of the logger to search for.
void fireAddAppenderEvent ( const LoggerPtr logger,
const AppenderPtr appender 
)
void fireRemoveAppenderEvent ( const LoggerPtr logger,
const AppenderPtr appender 
)
virtual const helpers::Class& getClass (  )  const [virtual]

Reimplemented from Object.

LoggerList getCurrentLoggers (  )  const

Returns all the currently defined loggers in this hierarchy as a LoggerList.

The root logger is not included in the returned LoggerList.

LoggerPtr getLogger ( const LogString 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.

Parameters:
name The name of the logger to retrieve.
LoggerPtr getLogger ( const LogString name,
const spi::LoggerFactoryPtr 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.

Parameters:
name The name of the logger to retrieve.
factory The factory that will make the new logger instance.
LoggerPtr getRootLogger (  )  const

Get the root of this hierarchy.

static const helpers::Class& getStaticClass (  )  [static]

Reimplemented from Object.

const LevelPtr& getThreshold (  )  const

Returns a Level representation of the enable state.

bool instanceof ( const helpers::Class clazz  )  const [inline, virtual]

Implements Object.

virtual bool isConfigured (  )  [virtual]
bool isDisabled ( int  level  )  const

This method will return true if this repository is disabled for level object passed as parameter and false otherwise.

See also the setThreshold method.

static const log4cxx::helpers::ClassRegistration& registerClass (  )  [static]

Reimplemented from Object.

void releaseRef (  )  const [virtual]

Reimplemented from ObjectImpl.

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 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.

virtual void setConfigured ( bool  configured  )  [virtual]
void setThreshold ( const LevelPtr l  ) 

Enable logging for logging requests with level l or higher.

By default all levels are enabled.

Parameters:
l The minimum level for which logging requests are sent to their appenders.
void setThreshold ( const LogString levelStr  ) 

The string form of setThreshold.

void shutdown (  ) 

Used by subclasses to add a renderer to the hierarchy passed as parameter.

Shutting down a hierarchy will safely close and remove all appenders in all categories including the root logger.

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.


The documentation for this class was generated from the following file: