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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ManagedObjectDefinition<? extends AccessLogFilteringCriteriaCfgClient,? extends AccessLogFilteringCriteriaCfg>
definition()
Get the configuration definition associated with this Access Log Filtering Criteria.SortedSet<ValueOrExpression<AddressMask>>
getConnectionClientAddressEqualTo()
Gets the "connection-client-address-equal-to" property.SortedSet<ValueOrExpression<AddressMask>>
getConnectionClientAddressNotEqualTo()
Gets the "connection-client-address-not-equal-to" property.SortedSet<ValueOrExpression<Integer>>
getConnectionPortEqualTo()
Gets the "connection-port-equal-to" property.SortedSet<ValueOrExpression<String>>
getConnectionProtocolEqualTo()
Gets the "connection-protocol-equal-to" property.SortedSet<ValueOrExpression<AccessLogFilteringCriteriaCfgDefn.LogRecordType>>
getLogRecordType()
Gets the "log-record-type" property.SortedSet<ValueOrExpression<String>>
getRequestTargetDnEqualTo()
Gets the "request-target-dn-equal-to" property.SortedSet<ValueOrExpression<String>>
getRequestTargetDnNotEqualTo()
Gets the "request-target-dn-not-equal-to" property.ValueOrExpression<Integer>
getResponseEtimeGreaterThan()
Gets the "response-etime-greater-than" property.ValueOrExpression<Integer>
getResponseEtimeLessThan()
Gets the "response-etime-less-than" property.SortedSet<ValueOrExpression<Integer>>
getResponseResultCodeEqualTo()
Gets the "response-result-code-equal-to" property.SortedSet<ValueOrExpression<Integer>>
getResponseResultCodeNotEqualTo()
Gets the "response-result-code-not-equal-to" property.ValueOrExpression<Integer>
getSearchResponseNentriesGreaterThan()
Gets the "search-response-nentries-greater-than" property.ValueOrExpression<Integer>
getSearchResponseNentriesLessThan()
Gets the "search-response-nentries-less-than" property.SortedSet<ValueOrExpression<String>>
getUserDnEqualTo()
Gets the "user-dn-equal-to" property.SortedSet<ValueOrExpression<String>>
getUserDnNotEqualTo()
Gets the "user-dn-not-equal-to" property.SortedSet<ValueOrExpression<Dn>>
getUserIsMemberOf()
Gets the "user-is-member-of" property.SortedSet<ValueOrExpression<Dn>>
getUserIsNotMemberOf()
Gets the "user-is-not-member-of" property.ValueOrExpression<Boolean>
isSearchResponseIsIndexed()
Gets the "search-response-is-indexed" property.void
setConnectionClientAddressEqualTo(Collection<ValueOrExpression<AddressMask>> values)
Sets the "connection-client-address-equal-to" property.void
setConnectionClientAddressNotEqualTo(Collection<ValueOrExpression<AddressMask>> values)
Sets the "connection-client-address-not-equal-to" property.void
setConnectionPortEqualTo(Collection<ValueOrExpression<Integer>> values)
Sets the "connection-port-equal-to" property.void
setConnectionProtocolEqualTo(Collection<ValueOrExpression<String>> values)
Sets the "connection-protocol-equal-to" property.void
setLogRecordType(Collection<ValueOrExpression<AccessLogFilteringCriteriaCfgDefn.LogRecordType>> values)
Sets the "log-record-type" property.void
setRequestTargetDnEqualTo(Collection<ValueOrExpression<String>> values)
Sets the "request-target-dn-equal-to" property.void
setRequestTargetDnNotEqualTo(Collection<ValueOrExpression<String>> values)
Sets the "request-target-dn-not-equal-to" property.void
setResponseEtimeGreaterThan(ValueOrExpression<Integer> value)
Sets the "response-etime-greater-than" property.void
setResponseEtimeLessThan(ValueOrExpression<Integer> value)
Sets the "response-etime-less-than" property.void
setResponseResultCodeEqualTo(Collection<ValueOrExpression<Integer>> values)
Sets the "response-result-code-equal-to" property.void
setResponseResultCodeNotEqualTo(Collection<ValueOrExpression<Integer>> values)
Sets the "response-result-code-not-equal-to" property.void
setSearchResponseIsIndexed(ValueOrExpression<Boolean> value)
Sets the "search-response-is-indexed" property.void
setSearchResponseNentriesGreaterThan(ValueOrExpression<Integer> value)
Sets the "search-response-nentries-greater-than" property.void
setSearchResponseNentriesLessThan(ValueOrExpression<Integer> value)
Sets the "search-response-nentries-less-than" property.void
setUserDnEqualTo(Collection<ValueOrExpression<String>> values)
Sets the "user-dn-equal-to" property.void
setUserDnNotEqualTo(Collection<ValueOrExpression<String>> values)
Sets the "user-dn-not-equal-to" property.void
setUserIsMemberOf(Collection<ValueOrExpression<Dn>> values)
Sets the "user-is-member-of" property.void
setUserIsNotMemberOf(Collection<ValueOrExpression<Dn>> values)
Sets the "user-is-not-member-of" property.-
Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient
commit, properties
-
-
-
-
Method Detail
-
definition
ManagedObjectDefinition<? extends AccessLogFilteringCriteriaCfgClient,? extends AccessLogFilteringCriteriaCfg> definition()
Get the configuration definition associated with this Access Log Filtering Criteria.- Specified by:
definition
in interfaceConfigurationClient
- Returns:
- Returns the configuration definition associated with this Access Log Filtering Criteria.
-
getConnectionClientAddressEqualTo
SortedSet<ValueOrExpression<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 the values of the "connection-client-address-equal-to" property.
-
setConnectionClientAddressEqualTo
void setConnectionClientAddressEqualTo(Collection<ValueOrExpression<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<ValueOrExpression<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 the values of the "connection-client-address-not-equal-to" property.
-
setConnectionClientAddressNotEqualTo
void setConnectionClientAddressNotEqualTo(Collection<ValueOrExpression<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<ValueOrExpression<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 the values of the "connection-port-equal-to" property.
-
setConnectionPortEqualTo
void setConnectionPortEqualTo(Collection<ValueOrExpression<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<ValueOrExpression<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 the values of the "connection-protocol-equal-to" property.
-
setConnectionProtocolEqualTo
void setConnectionProtocolEqualTo(Collection<ValueOrExpression<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.
-
getLogRecordType
SortedSet<ValueOrExpression<AccessLogFilteringCriteriaCfgDefn.LogRecordType>> getLogRecordType()
Gets the "log-record-type" property.Filters log records based on their type.
Default value is undefined
- Returns:
- Returns the values of the "log-record-type" property.
-
setLogRecordType
void setLogRecordType(Collection<ValueOrExpression<AccessLogFilteringCriteriaCfgDefn.LogRecordType>> values) throws PropertyException
Sets the "log-record-type" property.Filters log records based on their type.
- Parameters:
values
- The values of the "log-record-type" property.- Throws:
PropertyException
- If one or more of the new values are invalid.
-
getRequestTargetDnEqualTo
SortedSet<ValueOrExpression<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 the values of the "request-target-dn-equal-to" property.
-
setRequestTargetDnEqualTo
void setRequestTargetDnEqualTo(Collection<ValueOrExpression<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<ValueOrExpression<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 the values of the "request-target-dn-not-equal-to" property.
-
setRequestTargetDnNotEqualTo
void setRequestTargetDnNotEqualTo(Collection<ValueOrExpression<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
ValueOrExpression<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.
Default value is undefined
- Returns:
- Returns the value of the "response-etime-greater-than" property.
-
setResponseEtimeGreaterThan
void setResponseEtimeGreaterThan(ValueOrExpression<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
ValueOrExpression<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.
Default value is undefined
- Returns:
- Returns the value of the "response-etime-less-than" property.
-
setResponseEtimeLessThan
void setResponseEtimeLessThan(ValueOrExpression<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<ValueOrExpression<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 the values of the "response-result-code-equal-to" property.
-
setResponseResultCodeEqualTo
void setResponseResultCodeEqualTo(Collection<ValueOrExpression<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<ValueOrExpression<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 the values of the "response-result-code-not-equal-to" property.
-
setResponseResultCodeNotEqualTo
void setResponseResultCodeNotEqualTo(Collection<ValueOrExpression<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
ValueOrExpression<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.
-
setSearchResponseIsIndexed
void setSearchResponseIsIndexed(ValueOrExpression<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
ValueOrExpression<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.
-
setSearchResponseNentriesGreaterThan
void setSearchResponseNentriesGreaterThan(ValueOrExpression<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
ValueOrExpression<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.
-
setSearchResponseNentriesLessThan
void setSearchResponseNentriesLessThan(ValueOrExpression<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<ValueOrExpression<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 the values of the "user-dn-equal-to" property.
-
setUserDnEqualTo
void setUserDnEqualTo(Collection<ValueOrExpression<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<ValueOrExpression<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 the values of the "user-dn-not-equal-to" property.
-
setUserDnNotEqualTo
void setUserDnNotEqualTo(Collection<ValueOrExpression<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<ValueOrExpression<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 the values of the "user-is-member-of" property.
-
setUserIsMemberOf
void setUserIsMemberOf(Collection<ValueOrExpression<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<ValueOrExpression<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 the values of the "user-is-not-member-of" property.
-
setUserIsNotMemberOf
void setUserIsNotMemberOf(Collection<ValueOrExpression<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.
-
-