Package org.forgerock.audit.filter

Class FilterPolicy

java.lang.Object
org.forgerock.audit.filter.FilterPolicy
public class FilterPolicy extends Object
Represents a FilterPolicy which contains the includeIf and excludeIf values for the filter. The includeIf property lists fields/values in JsonPointer syntax to include for the audit event. By default all audit event fields are included. The excludeIf property lists fields/values in JsonPointer syntax to exclude for the audit event. The listed fields/values should be prefixed with the topic the JsonPointer applies to. For example, the following excludeIf value: 
     "/access/exclude/field"
would exclude the field "/exclude/field" for the access audit topic. The following is an example FilterPolicy in json format. 
     {
         "excludeIf" : [
              "/access/exclude/field"
         ],
         "includeIf" : [
              "/access/include/field"
         ]
     }

  • Constructor Details

    • FilterPolicy

      public FilterPolicy()

  • Method Details

    • getIncludeIf

      public List<String> getIncludeIf()
      Gets the includeIf list. The includeIf is a list of values to include in the audit event.
      Returns:
      The list of includeIfs.

    • setIncludeIf

      public void setIncludeIf(Collection<String> includeIf)
      Sets the includeIf list. The includeIf is a list of values to include in the audit event.
      Parameters:
      includeIf - The list of includeIfs.

    • getExcludeIf

      public List<String> getExcludeIf()
      Gets the excludeIf list. The excludeIf is a list of values to exclude from the audit event.
      Returns:
      The list of excludeIfs.

    • setExcludeIf

      public void setExcludeIf(Collection<String> excludeIf)
      Sets the excludeIf list. The excludeIf is a list of values to exclude from the audit event.
      Parameters:
      excludeIf - The list of excludeIfs.