Package org.forgerock.audit.filter

Class FilterBuilder

java.lang.Object

org.forgerock.audit.filter.FilterBuilder

public class FilterBuilder
extends Object

Builds a Filter for a given set of FilterPolicy.

Constructor Summary

Constructors

Constructor	Description
FilterBuilder()

Method Summary

Modifier and Type	Method	Description
Filter	build()	Builds the Filter.
FilterBuilder	withCaseInsensitiveFields(Collection<String> caseInsensitiveFields)	Specifies which topic fields should be filtered case-insensitively.
FilterBuilder	withConfiguredPolicies(Map<String,FilterPolicy> policiesByType)	Sets the filter policies supplied through configuration.
FilterBuilder	withEventTopicsMetadata(EventTopicsMetaData eventTopicsMetaData)	Sets the event topics metadata.
FilterBuilder	withHandledTopics(Set<String> handledTopics)	Specifies which topics are registered to an audit event handler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterBuilder

public FilterBuilder()

Method Detail

withEventTopicsMetadata

public FilterBuilder withEventTopicsMetadata(EventTopicsMetaData eventTopicsMetaData)

Sets the event topics metadata.

Parameters:

eventTopicsMetaData - Meta-data describing the types of events the AuditService can receive.

Returns:

This FilterBuilder.

withConfiguredPolicies

public FilterBuilder withConfiguredPolicies(Map<String,FilterPolicy> policiesByType)

Sets the filter policies supplied through configuration.

Parameters:

policiesByType - The policies, keyed on either 'field' or 'value' (case-insensitive).

Returns:

This FilterBuilder.

withCaseInsensitiveFields

public FilterBuilder withCaseInsensitiveFields(Collection<String> caseInsensitiveFields)

Specifies which topic fields should be filtered case-insensitively.

Parameters:

caseInsensitiveFields - the list of audit event fields to treat case-insensitively when filtering.

Returns:

This FilterBuilder.

withHandledTopics

public FilterBuilder withHandledTopics(Set<String> handledTopics)

Specifies which topics are registered to an audit event handler.

This information is needed to allow warnings for potential misconfiguration to ignore unused topics.

Parameters:

handledTopics - The set of topics for which an audit event handler has been registered.

Returns:

This FilterBuilder.

build

public Filter build()

Builds the Filter.

Returns:

The Filter.