Package org.forgerock.opendj.server.config.server

Interface AccessLogFilteringCriteriaCfg

All Superinterfaces:
Configuration
public interface AccessLogFilteringCriteriaCfg extends Configuration
A server-side interface for querying Access Log Filtering Criteria settings.

A set of rules which together determine whether a log record should be logged or not.

  • Method Details

    • configurationClass

      Class<? extends AccessLogFilteringCriteriaCfg> configurationClass()
      Gets the configuration class associated with this Access Log Filtering Criteria.
      Specified by:
      configurationClass in interface Configuration
      Returns:
      Returns the configuration class associated with this Access Log Filtering Criteria.

    • addChangeListener

      void addChangeListener(ConfigurationChangeListener<AccessLogFilteringCriteriaCfg> listener)
      Register to be notified when this Access Log Filtering Criteria is changed.
      Parameters:
      listener - The Access Log Filtering Criteria configuration change listener.

    • removeChangeListener

      void removeChangeListener(ConfigurationChangeListener<AccessLogFilteringCriteriaCfg> listener)
      Deregister an existing Access Log Filtering Criteria configuration change listener.
      Parameters:
      listener - The Access Log Filtering Criteria configuration change listener.

    • getConnectionClientAddressEqualTo

      SortedSet<AddressMask> getConnectionClientAddressEqualTo()
      Gets the "connection-client-address-equal-to" property.

      Filters log records associated with connections which match at least one of the specified client host names or address masks.

      Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask.

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "connection-client-address-equal-to" property.

    • getConnectionClientAddressNotEqualTo

      SortedSet<AddressMask> getConnectionClientAddressNotEqualTo()
      Gets the "connection-client-address-not-equal-to" property.

      Filters log records associated with connections which do not match any of the specified client host names or address masks.

      Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask.

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "connection-client-address-not-equal-to" property.

    • getConnectionPortEqualTo

      SortedSet<Integer> getConnectionPortEqualTo()
      Gets the "connection-port-equal-to" property.

      Filters log records associated with connections to any of the specified listener port numbers.

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "connection-port-equal-to" property.

    • getConnectionProtocolEqualTo

      SortedSet<String> getConnectionProtocolEqualTo()
      Gets the "connection-protocol-equal-to" property.

      Filters log records associated with connections which match any of the specified protocols.

      Typical values include "ldap", "ldaps", or "jmx".

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "connection-protocol-equal-to" property.

    • getLogRecordType

      SortedSet<AccessLogFilteringCriteriaCfgDefn.LogRecordType> getLogRecordType()
      Gets the "log-record-type" property.

      Filters log records based on their type.

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "log-record-type" property.

    • getRequestTargetDnEqualTo

      SortedSet<String> getRequestTargetDnEqualTo()
      Gets the "request-target-dn-equal-to" property.

      Filters operation log records associated with operations which target entries matching at least one of the specified DN patterns.

      Valid DN filters are strings composed of zero or more wildcards. A double wildcard ** replaces one or more RDN components (as in uid=dmiller,**,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com).

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "request-target-dn-equal-to" property.

    • getRequestTargetDnNotEqualTo

      SortedSet<String> getRequestTargetDnNotEqualTo()
      Gets the "request-target-dn-not-equal-to" property.

      Filters operation log records associated with operations which target entries matching none of the specified DN patterns.

      Valid DN filters are strings composed of zero or more wildcards. A double wildcard ** replaces one or more RDN components (as in uid=dmiller,**,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com).

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "request-target-dn-not-equal-to" property.

    • getResponseEntrySizeGreaterThan

      long getResponseEntrySizeGreaterThan()
      Gets the "response-entry-size-greater-than" property.

      Filters operation response log records associated with operations which target one or more entries whose encoded size is bigger than the specified size.

      Frequent operations on large entries may impact performance. It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages.

      Default value: 0 KB

      Returns:
      Returns the value of the "response-entry-size-greater-than" property.

    • getResponseEtimeGreaterThan

      Integer getResponseEtimeGreaterThan()
      Gets the "response-etime-greater-than" property.

      Filters operation response log records associated with operations whose total response time, including queuing and processing time, took longer than the specified number of milli-seconds to complete.

      It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages.

      Default value is undefined

      Returns:
      Returns the value of the "response-etime-greater-than" property.

    • getResponseEtimeLessThan

      Integer getResponseEtimeLessThan()
      Gets the "response-etime-less-than" property.

      Filters operation response log records associated with operations whose total response time, including queuing and processing time, took less than the specified number of milli-seconds to complete.

      It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages.

      Default value is undefined

      Returns:
      Returns the value of the "response-etime-less-than" property.

    • getResponseEtimeProcessingGreaterThan

      Integer getResponseEtimeProcessingGreaterThan()
      Gets the "response-etime-processing-greater-than" property.

      Filters operation response log records associated with operations whose processing time was greater than the specified number of milli-seconds.

      It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages.

      Default value is undefined

      Returns:
      Returns the value of the "response-etime-processing-greater-than" property.

    • getResponseEtimeProcessingLessThan

      Integer getResponseEtimeProcessingLessThan()
      Gets the "response-etime-processing-less-than" property.

      Filters operation response log records associated with operations whose processing time was less than the specified number of milli-seconds.

      It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages.

      Default value is undefined

      Returns:
      Returns the value of the "response-etime-processing-less-than" property.

    • getResponseEtimeQueueingGreaterThan

      Integer getResponseEtimeQueueingGreaterThan()
      Gets the "response-etime-queueing-greater-than" property.

      Filters operation response log records associated with operations whose queuing time was greater than the specified number of milli-seconds.

      It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages.

      Default value is undefined

      Returns:
      Returns the value of the "response-etime-queueing-greater-than" property.

    • getResponseEtimeQueueingLessThan

      Integer getResponseEtimeQueueingLessThan()
      Gets the "response-etime-queueing-less-than" property.

      Filters operation response log records associated with operations whose queuing time was less than the specified number of milli-seconds.

      It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages.

      Default value is undefined

      Returns:
      Returns the value of the "response-etime-queueing-less-than" property.

    • getResponseResultCodeEqualTo

      SortedSet<Integer> getResponseResultCodeEqualTo()
      Gets the "response-result-code-equal-to" property.

      Filters operation response log records associated with operations which include any of the specified result codes.

      It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages.

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "response-result-code-equal-to" property.

    • getResponseResultCodeNotEqualTo

      SortedSet<Integer> getResponseResultCodeNotEqualTo()
      Gets the "response-result-code-not-equal-to" property.

      Filters operation response log records associated with operations which do not include any of the specified result codes.

      It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages.

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "response-result-code-not-equal-to" property.

    • isSearchResponseIsIndexed

      Boolean isSearchResponseIsIndexed()
      Gets the "search-response-is-indexed" property.

      Filters search operation response log records associated with searches which were either indexed or unindexed.

      It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages.

      Default value is undefined

      Returns:
      Returns the value of the "search-response-is-indexed" property.

    • getSearchResponseNentriesGreaterThan

      Integer getSearchResponseNentriesGreaterThan()
      Gets the "search-response-nentries-greater-than" property.

      Filters search operation response log records associated with searches which returned more than the specified number of entries.

      It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages.

      Default value is undefined

      Returns:
      Returns the value of the "search-response-nentries-greater-than" property.

    • getSearchResponseNentriesLessThan

      Integer getSearchResponseNentriesLessThan()
      Gets the "search-response-nentries-less-than" property.

      Filters search operation response log records associated with searches which returned less than the specified number of entries.

      It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages.

      Default value is undefined

      Returns:
      Returns the value of the "search-response-nentries-less-than" property.

    • getUserDnEqualTo

      SortedSet<String> getUserDnEqualTo()
      Gets the "user-dn-equal-to" property.

      Filters log records associated with users matching at least one of the specified DN patterns.

      Valid DN filters are strings composed of zero or more wildcards. A double wildcard ** replaces one or more RDN components (as in uid=dmiller,**,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com).

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "user-dn-equal-to" property.

    • getUserDnNotEqualTo

      SortedSet<String> getUserDnNotEqualTo()
      Gets the "user-dn-not-equal-to" property.

      Filters log records associated with users which do not match any of the specified DN patterns.

      Valid DN filters are strings composed of zero or more wildcards. A double wildcard ** replaces one or more RDN components (as in uid=dmiller,**,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com).

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "user-dn-not-equal-to" property.

    • getUserIsMemberOf

      SortedSet<Dn> getUserIsMemberOf()
      Gets the "user-is-member-of" property.

      Filters log records associated with users which are members of at least one of the specified groups.

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "user-is-member-of" property.

    • getUserIsNotMemberOf

      SortedSet<Dn> getUserIsNotMemberOf()
      Gets the "user-is-not-member-of" property.

      Filters log records associated with users which are not members of any of the specified groups.

      Default value is undefined

      Returns:
      Returns an unmodifiable set containing the values of the "user-is-not-member-of" property.