Class AccessLogFilteringCriteriaCfgDefn

    • Method Detail

      • getInstance

        public static AccessLogFilteringCriteriaCfgDefn getInstance()
        Get the Access Log Filtering Criteria configuration definition singleton.
        Returns:
        Returns the Access Log Filtering Criteria configuration definition singleton.
      • getConnectionClientAddressEqualToPropertyDefinition

        public IpAddressMaskPropertyDefinition getConnectionClientAddressEqualToPropertyDefinition()
        Get the "connection-client-address-equal-to" property definition.

        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.

        Returns:
        Returns the "connection-client-address-equal-to" property definition.
      • getConnectionClientAddressNotEqualToPropertyDefinition

        public IpAddressMaskPropertyDefinition getConnectionClientAddressNotEqualToPropertyDefinition()
        Get the "connection-client-address-not-equal-to" property definition.

        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.

        Returns:
        Returns the "connection-client-address-not-equal-to" property definition.
      • getConnectionPortEqualToPropertyDefinition

        public IntegerPropertyDefinition getConnectionPortEqualToPropertyDefinition()
        Get the "connection-port-equal-to" property definition.

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

        Returns:
        Returns the "connection-port-equal-to" property definition.
      • getConnectionProtocolEqualToPropertyDefinition

        public StringPropertyDefinition getConnectionProtocolEqualToPropertyDefinition()
        Get the "connection-protocol-equal-to" property definition.

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

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

        Returns:
        Returns the "connection-protocol-equal-to" property definition.
      • getRequestTargetDnEqualToPropertyDefinition

        public StringPropertyDefinition getRequestTargetDnEqualToPropertyDefinition()
        Get the "request-target-dn-equal-to" property definition.

        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).

        Returns:
        Returns the "request-target-dn-equal-to" property definition.
      • getRequestTargetDnNotEqualToPropertyDefinition

        public StringPropertyDefinition getRequestTargetDnNotEqualToPropertyDefinition()
        Get the "request-target-dn-not-equal-to" property definition.

        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).

        Returns:
        Returns the "request-target-dn-not-equal-to" property definition.
      • getResponseEtimeGreaterThanPropertyDefinition

        public IntegerPropertyDefinition getResponseEtimeGreaterThanPropertyDefinition()
        Get the "response-etime-greater-than" property definition.

        Filters operation response log records associated with operations which 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.

        Returns:
        Returns the "response-etime-greater-than" property definition.
      • getResponseEtimeLessThanPropertyDefinition

        public IntegerPropertyDefinition getResponseEtimeLessThanPropertyDefinition()
        Get the "response-etime-less-than" property definition.

        Filters operation response log records associated with operations which 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.

        Returns:
        Returns the "response-etime-less-than" property definition.
      • getResponseResultCodeEqualToPropertyDefinition

        public IntegerPropertyDefinition getResponseResultCodeEqualToPropertyDefinition()
        Get the "response-result-code-equal-to" property definition.

        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.

        Returns:
        Returns the "response-result-code-equal-to" property definition.
      • getResponseResultCodeNotEqualToPropertyDefinition

        public IntegerPropertyDefinition getResponseResultCodeNotEqualToPropertyDefinition()
        Get the "response-result-code-not-equal-to" property definition.

        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.

        Returns:
        Returns the "response-result-code-not-equal-to" property definition.
      • getSearchResponseIsIndexedPropertyDefinition

        public BooleanPropertyDefinition getSearchResponseIsIndexedPropertyDefinition()
        Get the "search-response-is-indexed" property definition.

        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.

        Returns:
        Returns the "search-response-is-indexed" property definition.
      • getSearchResponseNentriesGreaterThanPropertyDefinition

        public IntegerPropertyDefinition getSearchResponseNentriesGreaterThanPropertyDefinition()
        Get the "search-response-nentries-greater-than" property definition.

        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.

        Returns:
        Returns the "search-response-nentries-greater-than" property definition.
      • getSearchResponseNentriesLessThanPropertyDefinition

        public IntegerPropertyDefinition getSearchResponseNentriesLessThanPropertyDefinition()
        Get the "search-response-nentries-less-than" property definition.

        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.

        Returns:
        Returns the "search-response-nentries-less-than" property definition.
      • getUserDnEqualToPropertyDefinition

        public StringPropertyDefinition getUserDnEqualToPropertyDefinition()
        Get the "user-dn-equal-to" property definition.

        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).

        Returns:
        Returns the "user-dn-equal-to" property definition.
      • getUserDnNotEqualToPropertyDefinition

        public StringPropertyDefinition getUserDnNotEqualToPropertyDefinition()
        Get the "user-dn-not-equal-to" property definition.

        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).

        Returns:
        Returns the "user-dn-not-equal-to" property definition.
      • getUserIsMemberOfPropertyDefinition

        public DnPropertyDefinition getUserIsMemberOfPropertyDefinition()
        Get the "user-is-member-of" property definition.

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

        Returns:
        Returns the "user-is-member-of" property definition.
      • getUserIsNotMemberOfPropertyDefinition

        public DnPropertyDefinition getUserIsNotMemberOfPropertyDefinition()
        Get the "user-is-not-member-of" property definition.

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

        Returns:
        Returns the "user-is-not-member-of" property definition.