org.owasp.esapi.logging.java

Class JavaLogFactory

java.lang.Object

org.owasp.esapi.logging.java.JavaLogFactory

All Implemented Interfaces:

LogFactory

public class JavaLogFactory
extends Object
implements LogFactory

LogFactory implementation which creates JAVA supporting Loggers. This implementation requires that a file named 'esapi-java-logging.properties' exists on the classpath.
A default file implementation is available in the configuration jar on GitHub under the 'Releases'

Constructor Summary

Constructors

Constructor and Description
JavaLogFactory()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaLogFactory

public JavaLogFactory()

Method Detail

getLogger

public Logger getLogger(String moduleName)

Description copied from interface: LogFactory

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.

Specified by:

getLogger in interface LogFactory

Parameters:

moduleName - The name of the module requesting the logger.

Returns:

The Logger associated with this module.

getLogger

public Logger getLogger(Class clazz)

Description copied from interface: LogFactory

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.

Specified by:

getLogger in interface LogFactory

Parameters:

clazz - The name of the class requesting the logger.

Returns:

The Logger associated with this class.