org.apache.avalon.excalibur.logger.decorator
Class LoggerManagerDecorator

java.lang.Object
  org.apache.avalon.excalibur.logger.decorator.LoggerManagerDecorator

All Implemented Interfaces:

LoggerManager, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.activity.Startable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.logger.LogEnabled

Direct Known Subclasses:

CachingDecorator, LogToSelfDecorator, OverrideDefaultDecorator, PrefixDecorator

public abstract class LoggerManagerDecorator
extends java.lang.Object
implements LoggerManager, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.activity.Startable, org.apache.avalon.framework.activity.Disposable

This is the base class to create LoggerManager decorators. It passes all lifecycle and LoggerManagerc calls onto the wrapped object.

Decorators are expected to be slim - be able to run for instance both with and without having their enableLogging() method called.

This constraint is imposed to allow decorators to be applicable to an object both at its burth, like

 C c = new C();
 DecoratorX d = new DecoratorX( c );
 x.enableLogging( logger );
 

and after the object has been completely configured

 C c = (C)manager.lookup( C.ROLE );
 DecoratorX d = new DecoratorX( c );
 

If this constrianed is not obeyed this should be clearly stated in the javadocs. For instance, LogToSelfDecorator _only_ makes sense if it passes the enableLogging call through it.

This implementation is incomplete, it passes only those calls that are needed in org.apache.avalon.excalibur.logger.decorator.* and org.apache.avalon.excalibur.logger.adapter.*:

    LogEnabled
    Contextualizable
    Configurable
    Startable
    Disposable
 

This object differes from LoggerManagerTee by being abstract, by absence of addTee() public method and by implementation. LoggerManagerTee might be used instead of this but maintaining it as a separate class seemed cleaner.

Since:

4.0

Version:

CVS $Revision: 1.4 $ $Date: 2004/03/10 13:54:50 $

Author:

Avalon Development Team

Field Summary

protected LoggerManager

m_loggerManager The wrapped-in LoggerManager.

Fields inherited from interface org.apache.avalon.excalibur.logger.LoggerManager

ROLE

Constructor Summary

LoggerManagerDecorator(LoggerManager loggerManager)

Method Summary

void	configure(org.apache.avalon.framework.configuration.Configuration configuration)
void	contextualize(org.apache.avalon.framework.context.Context context)
void	dispose()
void	enableLogging(org.apache.avalon.framework.logger.Logger logger)
org.apache.avalon.framework.logger.Logger	getDefaultLogger() Return the default Logger.
org.apache.avalon.framework.logger.Logger	getLoggerForCategory(java.lang.String categoryName) Return the Logger for the specified category.
void	start()
void	stop()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_loggerManager

protected final LoggerManager m_loggerManager

The wrapped-in LoggerManager.

Constructor Detail

LoggerManagerDecorator

public LoggerManagerDecorator(LoggerManager loggerManager)

Method Detail

enableLogging

public void enableLogging(org.apache.avalon.framework.logger.Logger logger)

Specified by:

enableLogging in interface org.apache.avalon.framework.logger.LogEnabled

contextualize

public void contextualize(org.apache.avalon.framework.context.Context context)
                   throws org.apache.avalon.framework.context.ContextException

Specified by:

contextualize in interface org.apache.avalon.framework.context.Contextualizable

Throws:

org.apache.avalon.framework.context.ContextException

configure

public void configure(org.apache.avalon.framework.configuration.Configuration configuration)
               throws org.apache.avalon.framework.configuration.ConfigurationException

Specified by:

configure in interface org.apache.avalon.framework.configuration.Configurable

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

start

public void start()
           throws java.lang.Exception

Specified by:

start in interface org.apache.avalon.framework.activity.Startable

Throws:

java.lang.Exception

stop

public void stop()
          throws java.lang.Exception

Specified by:

stop in interface org.apache.avalon.framework.activity.Startable

Throws:

java.lang.Exception

dispose

public void dispose()

Specified by:

dispose in interface org.apache.avalon.framework.activity.Disposable

getLoggerForCategory

public org.apache.avalon.framework.logger.Logger getLoggerForCategory(java.lang.String categoryName)

Return the Logger for the specified category.

Specified by:

getLoggerForCategory in interface LoggerManager

getDefaultLogger

public org.apache.avalon.framework.logger.Logger getDefaultLogger()

Return the default Logger. This is basically the same as getting the Logger for the "" category.

Specified by:

getDefaultLogger in interface LoggerManager