Apache Log4cxx
Version 1.3.1
|
This is a very simple filter based on level matching, which can be used to reject messages with priorities outside a certain range. More...
#include <levelrangefilter.h>
Public Types | |
typedef spi::Filter | BASE_CLASS |
Public Types inherited from log4cxx::spi::Filter | |
enum | FilterDecision { DENY = -1 , NEUTRAL = 0 , ACCEPT = 1 } |
Public Member Functions | |
LevelRangeFilter () | |
~LevelRangeFilter () | |
void | setOption (const LogString &option, const LogString &value) override |
Set option to value . | |
void | setLevelMin (const LevelPtr &levelMin1) |
Set the levelMin option. | |
const LevelPtr & | getLevelMin () const |
Get the value of the levelMin option. | |
void | setLevelMax (const LevelPtr &levelMax1) |
Set the levelMax option. | |
const LevelPtr & | getLevelMax () const |
Get the value of the levelMax option. | |
void | setAcceptOnMatch (bool acceptOnMatch1) |
Set the acceptOnMatch option. | |
bool | getAcceptOnMatch () const |
Get the value of the acceptOnMatch option. | |
FilterDecision | decide (const spi::LoggingEventPtr &event) const override |
Return the decision of this filter. | |
Public Member Functions inherited from log4cxx::spi::Filter | |
Filter () | |
Filter (std::unique_ptr< FilterPrivate > priv) | |
virtual | ~Filter () |
log4cxx::spi::FilterPtr | getNext () const |
void | setNext (const log4cxx::spi::FilterPtr &newNext) |
void | activateOptions (helpers::Pool &p) override |
Activate the options that were previously set with calls to option setters. | |
void | setOption (const LogString &option, const LogString &value) override |
Set option to value . | |
virtual FilterDecision | decide (const LoggingEventPtr &event) const =0 |
Public Member Functions inherited from log4cxx::spi::OptionHandler | |
virtual | ~OptionHandler () |
virtual void | activateOptions (helpers::Pool &p)=0 |
Activate the options that were previously set with calls to option setters. | |
virtual void | setOption (const LogString &option, const LogString &value)=0 |
Set option to value . | |
Public Member Functions inherited from log4cxx::helpers::Object | |
virtual | ~Object () |
virtual const helpers::Class & | getClass () const =0 |
virtual bool | instanceof (const Class &clazz) const =0 |
virtual const void * | cast (const Class &clazz) const =0 |
This is a very simple filter based on level matching, which can be used to reject messages with priorities outside a certain range.
The filter admits three options levelMin
, levelMax
and acceptOnMatch
.
If the level of the LoggingEvent
is not between Min and Max (inclusive), then DENY
is returned.
If the Logging event level is within the specified range, then if acceptOnMatch
is true, ACCEPT
is returned, and if acceptOnMatch
is false, NEUTRAL
is returned.
If levelMin
w is not defined, then there is no minimum acceptable level (ie a level is never rejected for being too "low"/unimportant). If levelMax
is not defined, then there is no maximum acceptable level (ie a level is never rejected for beeing too "high"/important).
Refer to the setThreshold
method available to all
appenders extending AppenderSkeleton for a more convenient way to filter out events by level.
log4cxx::filter::LevelRangeFilter::LevelRangeFilter | ( | ) |
log4cxx::filter::LevelRangeFilter::~LevelRangeFilter | ( | ) |
|
overridevirtual |
Return the decision of this filter.
Returns NEUTRAL
if the levelToMatch
option is not set or if there is not match. Otherwise, if there is a match, then the returned decision is ACCEPT
if the acceptOnMatch
property is set to true
. The returned decision is DENY
if the acceptOnMatch
property is set to false.
Implements log4cxx::spi::Filter.
bool log4cxx::filter::LevelRangeFilter::getAcceptOnMatch | ( | ) | const |
Get the value of the acceptOnMatch
option.
const LevelPtr & log4cxx::filter::LevelRangeFilter::getLevelMax | ( | ) | const |
Get the value of the levelMax
option.
const LevelPtr & log4cxx::filter::LevelRangeFilter::getLevelMin | ( | ) | const |
Get the value of the levelMin
option.
void log4cxx::filter::LevelRangeFilter::setAcceptOnMatch | ( | bool | acceptOnMatch1 | ) |
Set the acceptOnMatch
option.
void log4cxx::filter::LevelRangeFilter::setLevelMax | ( | const LevelPtr & | levelMax1 | ) |
Set the levelMax
option.
void log4cxx::filter::LevelRangeFilter::setLevelMin | ( | const LevelPtr & | levelMin1 | ) |
Set the levelMin
option.
|
overridevirtual |
Set option
to value
.
Supported options | Supported values | Default value |
---|---|---|
LevelMin | (1) | ALL |
LevelMax | (1) | OFF |
AcceptOnMatch | True,False | True |
(1). One of "Trace", "Debug", "Info", "Warn", "Error", "Fatal", "Off", "All" or a custom level in which case it is of the form {levelName}#{registeredClassName}
.
Implements log4cxx::spi::OptionHandler.