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

Interface AccessLogFilteringCriteriaCfgClient

  • All Superinterfaces:
    ConfigurationClient
    public interface AccessLogFilteringCriteriaCfgClient
extends ConfigurationClient
    A client-side interface for reading and modifying Access Log Filtering Criteria settings.

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

    • Method Detail

      • getConnectionClientAddressEqualTo

        SortedSet<org.forgerock.opendj.ldap.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.

        Returns:
        Returns the values of the "connection-client-address-equal-to" property.

      • setConnectionClientAddressEqualTo

        void setConnectionClientAddressEqualTo​(Collection<org.forgerock.opendj.ldap.AddressMask> values)
                                throws PropertyException
        Sets 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.

        Parameters:
        values - The values of the "connection-client-address-equal-to" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getConnectionClientAddressNotEqualTo

        SortedSet<org.forgerock.opendj.ldap.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.

        Returns:
        Returns the values of the "connection-client-address-not-equal-to" property.

      • setConnectionClientAddressNotEqualTo

        void setConnectionClientAddressNotEqualTo​(Collection<org.forgerock.opendj.ldap.AddressMask> values)
                                   throws PropertyException
        Sets 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.

        Parameters:
        values - The values of the "connection-client-address-not-equal-to" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

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

        Returns:
        Returns the values of the "connection-port-equal-to" property.

      • setConnectionPortEqualTo

        void setConnectionPortEqualTo​(Collection<Integer> values)
                       throws PropertyException
        Sets the "connection-port-equal-to" property.

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

        Parameters:
        values - The values of the "connection-port-equal-to" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • 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".

        Returns:
        Returns the values of the "connection-protocol-equal-to" property.

      • setConnectionProtocolEqualTo

        void setConnectionProtocolEqualTo​(Collection<String> values)
                           throws PropertyException
        Sets 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".

        Parameters:
        values - The values of the "connection-protocol-equal-to" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

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

        Returns:
        Returns the values of the "request-target-dn-equal-to" property.

      • setRequestTargetDNEqualTo

        void setRequestTargetDNEqualTo​(Collection<String> values)
                        throws PropertyException
        Sets 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).

        Parameters:
        values - The values of the "request-target-dn-equal-to" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

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

        Returns:
        Returns the values of the "request-target-dn-not-equal-to" property.

      • setRequestTargetDNNotEqualTo

        void setRequestTargetDNNotEqualTo​(Collection<String> values)
                           throws PropertyException
        Sets 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).

        Parameters:
        values - The values of the "request-target-dn-not-equal-to" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getResponseEtimeGreaterThan

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

        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 value of the "response-etime-greater-than" property.

      • setResponseEtimeGreaterThan

        void setResponseEtimeGreaterThan​(Integer value)
                          throws PropertyException
        Sets the "response-etime-greater-than" property.

        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.

        Parameters:
        value - The value of the "response-etime-greater-than" property.
        Throws:
        PropertyException - If the new value is invalid.

      • getResponseEtimeLessThan

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

        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 value of the "response-etime-less-than" property.

      • setResponseEtimeLessThan

        void setResponseEtimeLessThan​(Integer value)
                       throws PropertyException
        Sets the "response-etime-less-than" property.

        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.

        Parameters:
        value - The value of the "response-etime-less-than" property.
        Throws:
        PropertyException - If the new value is invalid.

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

        Returns:
        Returns the values of the "response-result-code-equal-to" property.

      • setResponseResultCodeEqualTo

        void setResponseResultCodeEqualTo​(Collection<Integer> values)
                           throws PropertyException
        Sets 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.

        Parameters:
        values - The values of the "response-result-code-equal-to" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

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

        Returns:
        Returns the values of the "response-result-code-not-equal-to" property.

      • setResponseResultCodeNotEqualTo

        void setResponseResultCodeNotEqualTo​(Collection<Integer> values)
                              throws PropertyException
        Sets 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.

        Parameters:
        values - The values of the "response-result-code-not-equal-to" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

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

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

      • setSearchResponseIsIndexed

        void setSearchResponseIsIndexed​(Boolean value)
                         throws PropertyException
        Sets 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.

        Parameters:
        value - The value of the "search-response-is-indexed" property.
        Throws:
        PropertyException - If the new value is invalid.

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

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

      • setSearchResponseNentriesGreaterThan

        void setSearchResponseNentriesGreaterThan​(Integer value)
                                   throws PropertyException
        Sets 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.

        Parameters:
        value - The value of the "search-response-nentries-greater-than" property.
        Throws:
        PropertyException - If the new value is invalid.

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

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

      • setSearchResponseNentriesLessThan

        void setSearchResponseNentriesLessThan​(Integer value)
                                throws PropertyException
        Sets 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.

        Parameters:
        value - The value of the "search-response-nentries-less-than" property.
        Throws:
        PropertyException - If the new value is invalid.

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

        Returns:
        Returns the values of the "user-dn-equal-to" property.

      • setUserDNEqualTo

        void setUserDNEqualTo​(Collection<String> values)
               throws PropertyException
        Sets 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).

        Parameters:
        values - The values of the "user-dn-equal-to" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

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

        Returns:
        Returns the values of the "user-dn-not-equal-to" property.

      • setUserDNNotEqualTo

        void setUserDNNotEqualTo​(Collection<String> values)
                  throws PropertyException
        Sets 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).

        Parameters:
        values - The values of the "user-dn-not-equal-to" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getUserIsMemberOf

        SortedSet<org.forgerock.opendj.ldap.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.

        Returns:
        Returns the values of the "user-is-member-of" property.

      • setUserIsMemberOf

        void setUserIsMemberOf​(Collection<org.forgerock.opendj.ldap.DN> values)
                throws PropertyException
        Sets the "user-is-member-of" property.

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

        Parameters:
        values - The values of the "user-is-member-of" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.

      • getUserIsNotMemberOf

        SortedSet<org.forgerock.opendj.ldap.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.

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

      • setUserIsNotMemberOf

        void setUserIsNotMemberOf​(Collection<org.forgerock.opendj.ldap.DN> values)
                   throws PropertyException
        Sets the "user-is-not-member-of" property.

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

        Parameters:
        values - The values of the "user-is-not-member-of" property.
        Throws:
        PropertyException - If one or more of the new values are invalid.