Package org.forgerock.audit.filter
Class FilterBuilder
java.lang.Object
org.forgerock.audit.filter.FilterBuilder
Builds a
Filter
for a given set of FilterPolicy
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds theFilter
.withCaseInsensitiveFields
(Collection<String> caseInsensitiveFields) Specifies which topic fields should be filtered case-insensitively.withConfiguredPolicies
(Map<String, FilterPolicy> policiesByType) Sets the filter policies supplied through configuration.withEventTopicsMetadata
(EventTopicsMetaData eventTopicsMetaData) Sets the event topics metadata.withHandledTopics
(Set<String> handledTopics) Specifies which topics are registered to an audit event handler.
-
Constructor Details
-
FilterBuilder
public FilterBuilder()
-
-
Method Details
-
withEventTopicsMetadata
Sets the event topics metadata.- Parameters:
eventTopicsMetaData
- Meta-data describing the types of events the AuditService can receive.- Returns:
- This
FilterBuilder
.
-
withConfiguredPolicies
Sets the filter policies supplied through configuration.- Parameters:
policiesByType
- The policies, keyed on either 'field' or 'value' (case-insensitive).- Returns:
- This
FilterBuilder
.
-
withCaseInsensitiveFields
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
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
Builds theFilter
.- Returns:
- The
Filter
.
-