This is a very simple filter based on string matching. More...

#include <stringmatchfilter.h>

Inheritance diagram for log4cxx::filter::StringMatchFilter:

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
	StringMatchFilter ()

	~StringMatchFilter ()

void	setOption (const LogString &option, const LogString &value) override
	Set `option` to `value`.

void	setStringToMatch (const LogString &stringToMatch1)

const LogString &	getStringToMatch () const

void	setAcceptOnMatch (bool acceptOnMatch1)

bool	getAcceptOnMatch () const

FilterDecision	decide (const spi::LoggingEventPtr &event) const override
	Returns `NEUTRAL` is there is no string match.

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

Detailed Description

This is a very simple filter based on string matching.

The filter admits two options StringToMatch and AcceptOnMatch. If there is a match between the value of the StringToMatch option and the message of the LoggingEvent, then the decide method returns ACCEPT if the AcceptOnMatch option value is true, if it is false then DENY is returned. If there is no match, NEUTRAL is returned.

See configuration files test6.xml, test7.xml, test8.xml, test9.xml, and test10.xml for examples of seeting up a StringMatchFilter.

Member Typedef Documentation

◆ BASE_CLASS

typedef spi::Filter log4cxx::filter::StringMatchFilter::BASE_CLASS

Constructor & Destructor Documentation

◆ StringMatchFilter()

log4cxx::filter::StringMatchFilter::StringMatchFilter ( )

◆ ~StringMatchFilter()

log4cxx::filter::StringMatchFilter::~StringMatchFilter ( )

Member Function Documentation

◆ decide()

FilterDecision log4cxx::filter::StringMatchFilter::decide ( const spi::LoggingEventPtr & event ) const

overridevirtual

Returns NEUTRAL is there is no string match.

Implements log4cxx::spi::Filter.

◆ getAcceptOnMatch()

bool log4cxx::filter::StringMatchFilter::getAcceptOnMatch ( ) const

◆ getStringToMatch()

const LogString & log4cxx::filter::StringMatchFilter::getStringToMatch ( ) const

◆ setAcceptOnMatch()

void log4cxx::filter::StringMatchFilter::setAcceptOnMatch ( bool acceptOnMatch1 )

◆ setOption()

void log4cxx::filter::StringMatchFilter::setOption	(	const LogString &	option,
		const LogString &	value
	)

overridevirtual

Set option to value.

Supported options	Supported values	Default value
StringToMatch	{any}	-
AcceptOnMatch	True,False	True

Implements log4cxx::spi::OptionHandler.

◆ setStringToMatch()

void log4cxx::filter::StringMatchFilter::setStringToMatch ( const LogString & stringToMatch1 )

The documentation for this class was generated from the following file:

stringmatchfilter.h

Public Types

Public Member Functions