log4shib 2.0.0

Public Types | Public Member Functions | Protected Member Functions | List of all members
log4shib::Filter Class Referenceabstract

Users should extend this class to implement customized logging event filtering. More...

`#include <Filter.hh>`

## Public Types
enum | Decision { DENY = -1 , NEUTRAL = 0 , ACCEPT = 1 }

## Public Member Functions
| Filter ()
| Default Constructor for Filter. More...
virtual | ~Filter ()
| Destructor for Filter. More...
virtual void | setChainedFilter (Filter *filter)
| Set the next Filter in the Filter chain. More...
virtual Filter * | getChainedFilter ()
| Get the next Filter in the Filter chain. More...
virtual Filter * | getEndOfChain ()
| Get the last Filter in the Filter chain. More...
virtual void | appendChainedFilter (Filter *filter)
| Add a Filter to the end of the Filter chain. More...
virtual Decision | decide (const LoggingEvent &event)
| Decide whether to accept or deny a LoggingEvent. More...

## Protected Member Functions
virtual Decision | _decide (const LoggingEvent &event)=0
| Decide whether this Filter accepts or denies the given LoggingEvent. More...

## Detailed Description

Users should extend this class to implement customized logging event filtering.

Note that log4shib::Category and lof4cpp::Appender 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 a Decision value, either DENY, NEUTRAL or ACCCEPT.

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 log4shib filters is largely inspired from the Linux ipchains.

## Member Enumeration Documentation

## ◆ Decision

enum log4shib::Filter::Decision

Enumerator
DENY |
NEUTRAL |
ACCEPT |

## Constructor & Destructor Documentation

## ◆ Filter()

log4shib::Filter::Filter | ( |  | ) |

Default Constructor for Filter.

## ◆ ~Filter()

log4shib::Filter::~Filter | ( |  | ) |
| virtual

Destructor for Filter.

## Member Function Documentation

## ◆ _decide()

virtual Decision log4shib::Filter::_decide | ( | const LoggingEvent & | event | ) |
| protected pure virtual

Decide whether this Filter accepts or denies the given LoggingEvent.

Actual implementation of Filter should override this method and not `decide(LoggingEvent&)`.

Parameters

  event | The LoggingEvent to decide on.

Returns
  The Decision

## ◆ appendChainedFilter()

void log4shib::Filter::appendChainedFilter | ( | Filter * | filter | ) |
| virtual

Add a Filter to the end of the Filter chain.

Convience method for getEndOfChain()->setChainedFilter(filter).

Parameters

  filter | The filter to add to the end of the chain.

## ◆ decide()

Filter::Decision log4shib::Filter::decide | ( | const LoggingEvent & | event | ) |
| virtual

Decide whether to accept or deny a LoggingEvent.

This method will walk the entire chain until a non neutral decision has been made or the end of the chain has been reached.

Parameters

  event | The LoggingEvent to decide on.

Returns
  The Decision

## ◆ getChainedFilter()

Filter * log4shib::Filter::getChainedFilter | ( |  | ) |
| virtual

Get the next Filter in the Filter chain.

Returns
  The next Filter or NULL if the current filter is the last in the chain

## ◆ getEndOfChain()

Filter * log4shib::Filter::getEndOfChain | ( |  | ) |
| virtual

Get the last Filter in the Filter chain.

Returns
  The last Filter in the Filter chain

## ◆ setChainedFilter()

void log4shib::Filter::setChainedFilter | ( | Filter * | filter | ) |
| virtual

Set the next Filter in the Filter chain.

Parameters

  filter | The filter to chain

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

- Filter.hh
- Filter.cpp