Public Types | |
DENY = -1 | |
NEUTRAL = 0 | |
ACCEPT = 1 | |
enum | FilterDecision { DENY = -1, NEUTRAL = 0, ACCEPT = 1 } |
Public Member Functions | |
void | activateOptions () |
void | setOption (const String &option, const String &value) |
virtual FilterDecision | decide (const LoggingEventPtr &event) const =0 |
Public Attributes | |
FilterPtr | next |
This abstract class assumes and also imposes that filters be organized in a linear chain. The decide(LoggingEvent) method of each filter is called sequentially, in the order of their addition to the chain.
The decide(LoggingEvent) method must return one of the integer constants DENY, NEUTRAL or ACCEPT.
If the value DENY is returned, then the log event is dropped immediately without consulting with the remaining filters.
If the value NEUTRAL is returned, then the next filter in the chain is consulted. If there are no more filters in the chain, then the log event is logged. Thus, in the presence of no filters, the default behaviour is to log all logging events.
If the value ACCEPT is returned, then the log event is logged without consulting the remaining filters.
The philosophy of log4cxx filters is largely inspired from the Linux ipchains.
Note that filtering is only supported by the DOMConfigurator.
enum FilterDecision |
void activateOptions | ( | ) | [inline, virtual] |
Usually filters options become active when set. We provide a
default do-nothing implementation for convenience.
Implements OptionHandler.
virtual FilterDecision decide | ( | const LoggingEventPtr & | event | ) | const [pure virtual] |
If the decision is DENY
, then the event will be dropped. If the decision is NEUTRAL
, then the next filter, if any, will be invoked. If the decision is ACCEPT then the event will be logged without consulting with other filters in the chain.
event | The LoggingEvent to decide upon. |
void setOption | ( | const String & | option, | |
const String & | value | |||
) | [inline, virtual] |
Set option
to value
.
The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when activateOptions is called.
Implements OptionHandler.