NOTE: This filter modifies logging events by adding properties to the event. More...
#include <propertyfilter.h>
Public Member Functions | |
| PropertyFilter () | |
| ~PropertyFilter () | |
| void | setProperties (const LogString &props) |
| FilterDecision | decide (const spi::LoggingEventPtr &event) const |
 Public Member Functions inherited from log4cxx::spi::Filter | |
| Filter () | |
| 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... | |
| Public Member Functions inherited from log4cxx::spi::OptionHandler | |
| virtual | ~OptionHandler () |
| Public Member Functions inherited from log4cxx::helpers::Object | |
| virtual | ~Object () |
| virtual bool | instanceof (const Class &clazz) const =0 |
| virtual const void * | cast (const Class &clazz) const =0 |
Additional Inherited Members | |
| Public Types inherited from log4cxx::spi::Filter | |
| enum | FilterDecision { DENY = -1, NEUTRAL = 0, ACCEPT = 1 } |
Detailed Description
NOTE: This filter modifies logging events by adding properties to the event.
The 'properties' param is converted to event properties, which are set on every event processed by the filter.
Individual properties are only set if they do not already exist on the logging event (will not override existing properties).
This class relies on the convention that property name/value pairs are equals-symbol delimited, and each name/value pair is comma-delimited
Example properties param: somename=somevalue,anothername=anothervalue,thirdname=third value
Constructor & Destructor Documentation
◆ PropertyFilter()
| log4cxx::filter::PropertyFilter::PropertyFilter | ( | ) |
◆ ~PropertyFilter()
| log4cxx::filter::PropertyFilter::~PropertyFilter | ( | ) |
Member Function Documentation
◆ decide()
|
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.
- Parameters
-
event The LoggingEvent to decide upon.
- Returns
- The decision of the filter.
Implements log4cxx::spi::Filter.
◆ setProperties()
| void log4cxx::filter::PropertyFilter::setProperties | ( | const LogString & | props | ) |
The documentation for this class was generated from the following file:
