nawa::AccessFilterList Class Reference

#include <nawa/filter/AccessFilterList.h>

Public Member Functions
virtual	~AccessFilterList ()
	AccessFilterList ()
	AccessFilterList (AccessFilterList const &other)
AccessFilterList &	operator= (const AccessFilterList &other)
	AccessFilterList (AccessFilterList &&other) noexcept
AccessFilterList &	operator= (AccessFilterList &&other) noexcept
bool &	filtersEnabled () noexcept
bool	filtersEnabled () const noexcept
AccessFilterList &	filtersEnabled (bool value) noexcept
std::vector< BlockFilter > &	blockFilters () noexcept
std::vector< BlockFilter > const &	blockFilters () const noexcept
AccessFilterList &	blockFilters (std::vector< BlockFilter > value) noexcept
std::vector< AuthFilter > &	authFilters () noexcept
std::vector< AuthFilter > const &	authFilters () const noexcept
AccessFilterList &	authFilters (std::vector< AuthFilter > value) noexcept
std::vector< ForwardFilter > &	forwardFilters () noexcept
std::vector< ForwardFilter > const &	forwardFilters () const noexcept
AccessFilterList &	forwardFilters (std::vector< ForwardFilter > value) noexcept

Detailed Description

Structure in which all filters that should be applied by the RequestHandler can be included. The filters will be processed from the first element in a vector to the last element, block filters first, then auth filters, then forward filters. If one filter leads to a block/forward/denied access, all following filters will be ignored. Filters can only be applied statically on app initialization as part of the AppInit struct (for thread-safety).

Definition at line 40 of file AccessFilterList.h.

Constructor & Destructor Documentation

~AccessFilterList()

virtual nawa::AccessFilterList::~AccessFilterList ( )

virtual

AccessFilterList() [1/3]

nawa::AccessFilterList::AccessFilterList

(

)

AccessFilterList() [2/3]

nawa::AccessFilterList::AccessFilterList

(

AccessFilterList const &

other

)

AccessFilterList() [3/3]

nawa::AccessFilterList::AccessFilterList ( AccessFilterList &&  other )

noexcept

Member Function Documentation

operator=() [1/2]

AccessFilterList & nawa::AccessFilterList::operator=

(

const AccessFilterList &

other

)

operator=() [2/2]

AccessFilterList & nawa::AccessFilterList::operator= ( AccessFilterList &&  other )

noexcept

filtersEnabled() [1/3]

bool & nawa::AccessFilterList::filtersEnabled ( )

noexcept

Is the filter module enabled? If false, no filters will be applied.

Returns

Reference to element.

filtersEnabled() [2/3]

bool nawa::AccessFilterList::filtersEnabled ( ) const

noexcept

filtersEnabled() [3/3]

AccessFilterList & nawa::AccessFilterList::filtersEnabled ( bool  value )

noexcept

blockFilters() [1/3]

std::vector< BlockFilter > & nawa::AccessFilterList::blockFilters ( )

noexcept

List of BlockFilter objects to be applied.

Returns

Reference to element.

blockFilters() [2/3]

std::vector< BlockFilter > const & nawa::AccessFilterList::blockFilters ( ) const

noexcept

blockFilters() [3/3]

AccessFilterList & nawa::AccessFilterList::blockFilters ( std::vector< BlockFilter >  value )

noexcept

authFilters() [1/3]

std::vector< AuthFilter > & nawa::AccessFilterList::authFilters ( )

noexcept

List of AuthFilter objects to be applied.

Returns

Reference to element.

authFilters() [2/3]

std::vector< AuthFilter > const & nawa::AccessFilterList::authFilters ( ) const

noexcept

authFilters() [3/3]

AccessFilterList & nawa::AccessFilterList::authFilters ( std::vector< AuthFilter >  value )

noexcept

forwardFilters() [1/3]

std::vector< ForwardFilter > & nawa::AccessFilterList::forwardFilters ( )

noexcept

List of ForwardFilter objects to be applied.

Returns

Reference to element.

forwardFilters() [2/3]

std::vector< ForwardFilter > const & nawa::AccessFilterList::forwardFilters ( ) const

noexcept

forwardFilters() [3/3]

AccessFilterList & nawa::AccessFilterList::forwardFilters ( std::vector< ForwardFilter >  value )

noexcept

---

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

• include/nawa/filter/AccessFilterList.h