public interface AccessLogFilteringCriteriaCfg extends Configuration
A set of rules which together determine whether a log record should be logged or not.
Modifier and Type | Method and Description |
---|---|
void |
addChangeListener(ConfigurationChangeListener<AccessLogFilteringCriteriaCfg> listener)
Register to be notified when this Access Log Filtering Criteria is changed.
|
Class<? extends AccessLogFilteringCriteriaCfg> |
configurationClass()
Gets the configuration class associated with this Access Log Filtering Criteria.
|
SortedSet<AddressMask> |
getConnectionClientAddressEqualTo()
Gets the "connection-client-address-equal-to" property.
|
SortedSet<AddressMask> |
getConnectionClientAddressNotEqualTo()
Gets the "connection-client-address-not-equal-to" property.
|
SortedSet<Integer> |
getConnectionPortEqualTo()
Gets the "connection-port-equal-to" property.
|
SortedSet<String> |
getConnectionProtocolEqualTo()
Gets the "connection-protocol-equal-to" property.
|
SortedSet<AccessLogFilteringCriteriaCfgDefn.LogRecordType> |
getLogRecordType()
Gets the "log-record-type" property.
|
SortedSet<String> |
getRequestTargetDNEqualTo()
Gets the "request-target-dn-equal-to" property.
|
SortedSet<String> |
getRequestTargetDNNotEqualTo()
Gets the "request-target-dn-not-equal-to" property.
|
Integer |
getResponseEtimeGreaterThan()
Gets the "response-etime-greater-than" property.
|
Integer |
getResponseEtimeLessThan()
Gets the "response-etime-less-than" property.
|
SortedSet<Integer> |
getResponseResultCodeEqualTo()
Gets the "response-result-code-equal-to" property.
|
SortedSet<Integer> |
getResponseResultCodeNotEqualTo()
Gets the "response-result-code-not-equal-to" property.
|
Integer |
getSearchResponseNentriesGreaterThan()
Gets the "search-response-nentries-greater-than" property.
|
Integer |
getSearchResponseNentriesLessThan()
Gets the "search-response-nentries-less-than" property.
|
SortedSet<String> |
getUserDNEqualTo()
Gets the "user-dn-equal-to" property.
|
SortedSet<String> |
getUserDNNotEqualTo()
Gets the "user-dn-not-equal-to" property.
|
SortedSet<DN> |
getUserIsMemberOf()
Gets the "user-is-member-of" property.
|
SortedSet<DN> |
getUserIsNotMemberOf()
Gets the "user-is-not-member-of" property.
|
Boolean |
isSearchResponseIsIndexed()
Gets the "search-response-is-indexed" property.
|
void |
removeChangeListener(ConfigurationChangeListener<AccessLogFilteringCriteriaCfg> listener)
Deregister an existing Access Log Filtering Criteria configuration change listener.
|
dn
Class<? extends AccessLogFilteringCriteriaCfg> configurationClass()
configurationClass
in interface Configuration
void addChangeListener(ConfigurationChangeListener<AccessLogFilteringCriteriaCfg> listener)
listener
- The Access Log Filtering Criteria configuration change listener.void removeChangeListener(ConfigurationChangeListener<AccessLogFilteringCriteriaCfg> listener)
listener
- The Access Log Filtering Criteria configuration change listener.SortedSet<AddressMask> getConnectionClientAddressEqualTo()
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.
SortedSet<AddressMask> getConnectionClientAddressNotEqualTo()
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.
SortedSet<Integer> getConnectionPortEqualTo()
Filters log records associated with connections to any of the specified listener port numbers.
SortedSet<String> getConnectionProtocolEqualTo()
Filters log records associated with connections which match any of the specified protocols.
Typical values include "ldap", "ldaps", or "jmx".
SortedSet<AccessLogFilteringCriteriaCfgDefn.LogRecordType> getLogRecordType()
Filters log records based on their type.
SortedSet<String> getRequestTargetDNEqualTo()
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).
SortedSet<String> getRequestTargetDNNotEqualTo()
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).
Integer getResponseEtimeGreaterThan()
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.
Integer getResponseEtimeLessThan()
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.
SortedSet<Integer> getResponseResultCodeEqualTo()
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.
SortedSet<Integer> getResponseResultCodeNotEqualTo()
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.
Boolean isSearchResponseIsIndexed()
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.
Integer getSearchResponseNentriesGreaterThan()
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.
Integer getSearchResponseNentriesLessThan()
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.
SortedSet<String> getUserDNEqualTo()
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).
SortedSet<String> getUserDNNotEqualTo()
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).
SortedSet<DN> getUserIsMemberOf()
Filters log records associated with users which are members of at least one of the specified groups.
SortedSet<DN> getUserIsNotMemberOf()
Filters log records associated with users which are not members of any of the specified groups.
Copyright 2010-2017 ForgeRock AS.