public interface AccessLogFilteringCriteriaCfgClient extends ConfigurationClient
A set of rules which together determine whether a log record should be logged or not.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends AccessLogFilteringCriteriaCfgClient,? extends AccessLogFilteringCriteriaCfg> |
definition()
Get the configuration definition 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 |
setConnectionClientAddressEqualTo(Collection<AddressMask> values)
Sets the "connection-client-address-equal-to" property.
|
void |
setConnectionClientAddressNotEqualTo(Collection<AddressMask> values)
Sets the "connection-client-address-not-equal-to" property.
|
void |
setConnectionPortEqualTo(Collection<Integer> values)
Sets the "connection-port-equal-to" property.
|
void |
setConnectionProtocolEqualTo(Collection<String> values)
Sets the "connection-protocol-equal-to" property.
|
void |
setLogRecordType(Collection<AccessLogFilteringCriteriaCfgDefn.LogRecordType> values)
Sets the "log-record-type" property.
|
void |
setRequestTargetDNEqualTo(Collection<String> values)
Sets the "request-target-dn-equal-to" property.
|
void |
setRequestTargetDNNotEqualTo(Collection<String> values)
Sets the "request-target-dn-not-equal-to" property.
|
void |
setResponseEtimeGreaterThan(Integer value)
Sets the "response-etime-greater-than" property.
|
void |
setResponseEtimeLessThan(Integer value)
Sets the "response-etime-less-than" property.
|
void |
setResponseResultCodeEqualTo(Collection<Integer> values)
Sets the "response-result-code-equal-to" property.
|
void |
setResponseResultCodeNotEqualTo(Collection<Integer> values)
Sets the "response-result-code-not-equal-to" property.
|
void |
setSearchResponseIsIndexed(Boolean value)
Sets the "search-response-is-indexed" property.
|
void |
setSearchResponseNentriesGreaterThan(Integer value)
Sets the "search-response-nentries-greater-than" property.
|
void |
setSearchResponseNentriesLessThan(Integer value)
Sets the "search-response-nentries-less-than" property.
|
void |
setUserDNEqualTo(Collection<String> values)
Sets the "user-dn-equal-to" property.
|
void |
setUserDNNotEqualTo(Collection<String> values)
Sets the "user-dn-not-equal-to" property.
|
void |
setUserIsMemberOf(Collection<DN> values)
Sets the "user-is-member-of" property.
|
void |
setUserIsNotMemberOf(Collection<DN> values)
Sets the "user-is-not-member-of" property.
|
commit, properties
ManagedObjectDefinition<? extends AccessLogFilteringCriteriaCfgClient,? extends AccessLogFilteringCriteriaCfg> definition()
definition
in interface ConfigurationClient
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.
void setConnectionClientAddressEqualTo(Collection<AddressMask> values) throws PropertyException
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.
values
- The values of the "connection-client-address-equal-to" property.PropertyException
- If one or more of the new values are invalid.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.
void setConnectionClientAddressNotEqualTo(Collection<AddressMask> values) throws PropertyException
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.
values
- The values of the "connection-client-address-not-equal-to" property.PropertyException
- If one or more of the new values are invalid.SortedSet<Integer> getConnectionPortEqualTo()
Filters log records associated with connections to any of the specified listener port numbers.
void setConnectionPortEqualTo(Collection<Integer> values) throws PropertyException
Filters log records associated with connections to any of the specified listener port numbers.
values
- The values of the "connection-port-equal-to" property.PropertyException
- If one or more of the new values are invalid.SortedSet<String> getConnectionProtocolEqualTo()
Filters log records associated with connections which match any of the specified protocols.
Typical values include "ldap", "ldaps", or "jmx".
void setConnectionProtocolEqualTo(Collection<String> values) throws PropertyException
Filters log records associated with connections which match any of the specified protocols.
Typical values include "ldap", "ldaps", or "jmx".
values
- The values of the "connection-protocol-equal-to" property.PropertyException
- If one or more of the new values are invalid.SortedSet<AccessLogFilteringCriteriaCfgDefn.LogRecordType> getLogRecordType()
Filters log records based on their type.
void setLogRecordType(Collection<AccessLogFilteringCriteriaCfgDefn.LogRecordType> values) throws PropertyException
Filters log records based on their type.
values
- The values of the "log-record-type" property.PropertyException
- If one or more of the new values are invalid.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).
void setRequestTargetDNEqualTo(Collection<String> values) throws PropertyException
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).
values
- The values of the "request-target-dn-equal-to" property.PropertyException
- If one or more of the new values are invalid.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).
void setRequestTargetDNNotEqualTo(Collection<String> values) throws PropertyException
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).
values
- The values of the "request-target-dn-not-equal-to" property.PropertyException
- If one or more of the new values are invalid.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.
void setResponseEtimeGreaterThan(Integer value) throws PropertyException
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.
value
- The value of the "response-etime-greater-than" property.PropertyException
- If the new value is invalid.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.
void setResponseEtimeLessThan(Integer value) throws PropertyException
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.
value
- The value of the "response-etime-less-than" property.PropertyException
- If the new value is invalid.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.
void setResponseResultCodeEqualTo(Collection<Integer> values) throws PropertyException
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.
values
- The values of the "response-result-code-equal-to" property.PropertyException
- If one or more of the new values are invalid.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.
void setResponseResultCodeNotEqualTo(Collection<Integer> values) throws PropertyException
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.
values
- The values of the "response-result-code-not-equal-to" property.PropertyException
- If one or more of the new values are invalid.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.
void setSearchResponseIsIndexed(Boolean value) throws PropertyException
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.
value
- The value of the "search-response-is-indexed" property.PropertyException
- If the new value is invalid.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.
void setSearchResponseNentriesGreaterThan(Integer value) throws PropertyException
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.
value
- The value of the "search-response-nentries-greater-than" property.PropertyException
- If the new value is invalid.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.
void setSearchResponseNentriesLessThan(Integer value) throws PropertyException
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.
value
- The value of the "search-response-nentries-less-than" property.PropertyException
- If the new value is invalid.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).
void setUserDNEqualTo(Collection<String> values) throws PropertyException
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).
values
- The values of the "user-dn-equal-to" property.PropertyException
- If one or more of the new values are invalid.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).
void setUserDNNotEqualTo(Collection<String> values) throws PropertyException
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).
values
- The values of the "user-dn-not-equal-to" property.PropertyException
- If one or more of the new values are invalid.SortedSet<DN> getUserIsMemberOf()
Filters log records associated with users which are members of at least one of the specified groups.
void setUserIsMemberOf(Collection<DN> values) throws PropertyException
Filters log records associated with users which are members of at least one of the specified groups.
values
- The values of the "user-is-member-of" property.PropertyException
- If one or more of the new values are invalid.SortedSet<DN> getUserIsNotMemberOf()
Filters log records associated with users which are not members of any of the specified groups.
void setUserIsNotMemberOf(Collection<DN> values) throws PropertyException
Filters log records associated with users which are not members of any of the specified groups.
values
- The values of the "user-is-not-member-of" property.PropertyException
- If one or more of the new values are invalid.Copyright 2010-2017 ForgeRock AS.