org.znerd.logdoc

Class LogFilter

java.lang.Object

org.znerd.logdoc.LogFilter

Direct Known Subclasses:

NullLogFilter, SimpleLogFilter

public abstract class LogFilter
extends Object

Parameter value log filters. Implementations of this abstract class can be used to modify parameters during logging.

A typical use is to filter out passwords so these will not be persisted in a logging store.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LogFilter() Constructs a new LogFilter.

Method Summary

Methods

Modifier and Type	Method and Description
abstract Object	filter(String logger, String param, Object value) Filters the specified Object value.
abstract String	filter(String logger, String param, String value) Filters the specified String value.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogFilter

protected LogFilter()

Constructs a new LogFilter.

Method Detail

filter

public abstract String filter(String logger,
            String param,
            String value)

Filters the specified String value.

Parameters:

logger - the name of the logger, for example "org.xins.common.lowlevel.1050", cannot be null.

param - the name of the parameter, for example "queryString", cannot be null.

value - the original parameter value, can be null.

Returns:

the parameter value to use, possibly modified, can be null.

filter

public abstract Object filter(String logger,
            String param,
            Object value)

Filters the specified Object value.

Parameters:

logger - the name of the logger, for example "org.xins.common.lowlevel.1050", cannot be null.

param - the name of the parameter, for example "queryString", cannot be null.

value - the original parameter value, can be null.

Returns:

the parameter value to use, possibly modified, can be null.