org.owasp.esapi

Interface LogFactory

All Known Implementing Classes:

JavaLogFactory, Log4JLogFactory

public interface LogFactory

The LogFactory interface is intended to allow substitution of various logging packages, while providing a common interface to access them. In the reference implementation, JavaLogFactory.java implements this interface. JavaLogFactory.java also contains an inner class called JavaLogger which implements Logger.java and uses the Java logging package to log events.

Author:

rdawes

See Also:

ESAPI

Method Summary

Modifier and Type	Method and Description
Logger	getLogger(Class clazz) Gets the logger associated with the specified class.
Logger	getLogger(String moduleName) Gets the logger associated with the specified module name.

Method Detail

getLogger

Logger getLogger(String moduleName)

Gets the logger associated with the specified module name. The module name is used by the logger to log which module is generating the log events. The implementation of this method should return any preexisting Logger associated with this module name, rather than creating a new Logger.

The JavaLogFactory reference implementation meets these requirements.

Parameters:

moduleName - The name of the module requesting the logger.

Returns:

The Logger associated with this module.

getLogger

Logger getLogger(Class clazz)

Gets the logger associated with the specified class. The class is used by the logger to log which class is generating the log events. The implementation of this method should return any preexisting Logger associated with this class name, rather than creating a new Logger.

The JavaLogFactory reference implementation meets these requirements.

Parameters:

clazz - The name of the class requesting the logger.

Returns:

The Logger associated with this class.