|
Apache log4cxx
Version 0.10.0
|
|
Apache log4cxx
Version 0.10.0
|
Users should extend this class to implement customized logging event filtering. More...
Public Types | |
| enum | FilterDecision { DENY = -1, NEUTRAL = 0, ACCEPT = 1 } |
Public Member Functions | |
| Filter () | |
| void | addRef () const |
| void | releaseRef () const |
| log4cxx::spi::FilterPtr | getNext () const |
| void | setNext (const log4cxx::spi::FilterPtr &newNext) |
| void | activateOptions (log4cxx::helpers::Pool &p) |
| Usually filters options become active when set. More... | |
| void | setOption (const LogString &option, const LogString &value) |
Set option to value. More... | |
| virtual FilterDecision | decide (const LoggingEventPtr &event) const =0 |
 Public Member Functions inherited from OptionHandler | |
| virtual | ~OptionHandler () |
| Public Member Functions inherited from Object | |
| virtual const helpers::Class & | getClass () const |
| virtual | ~Object () |
| virtual bool | instanceof (const Class &clazz) const =0 |
| virtual const void * | cast (const Class &clazz) const =0 |
| Public Member Functions inherited from ObjectImpl | |
| ObjectImpl () | |
| virtual | ~ObjectImpl () |
Additional Inherited Members | |
| Static Public Member Functions inherited from Object | |
| static const helpers::Class & | getStaticClass () |
| static const log4cxx::helpers::ClassRegistration & | registerClass () |
| Protected Attributes inherited from ObjectImpl | |
| unsigned int volatile | ref |
Users should extend this class to implement customized logging event filtering.
Note that Logger and AppenderSkeleton, the parent class of all standard appenders, have built-in filtering rules. It is suggested that you first use and understand the built-in rules before rushing to write your own custom filters.
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 |
| Filter | ( | ) |
|
virtual |
Usually filters options become active when set.
We provide a
default do-nothing implementation for convenience.
Implements OptionHandler.
|
virtual |
Reimplemented from ObjectImpl.
|
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. |
Implemented in LevelRangeFilter, ExpressionFilter, AndFilter, LevelMatchFilter, StringMatchFilter, LocationInfoFilter, PropertyFilter, DenyAllFilter, and MapFilter.
| log4cxx::spi::FilterPtr getNext | ( | ) | const |
|
virtual |
Reimplemented from ObjectImpl.
| void setNext | ( | const log4cxx::spi::FilterPtr & | newNext | ) |
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.
