Class AccessLogFilteringCriteriaCfgDefn
- java.lang.Object
-
- org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
-
- org.forgerock.opendj.config.ManagedObjectDefinition<AccessLogFilteringCriteriaCfgClient,AccessLogFilteringCriteriaCfg>
-
- org.forgerock.opendj.server.config.meta.AccessLogFilteringCriteriaCfgDefn
-
public final class AccessLogFilteringCriteriaCfgDefn extends ManagedObjectDefinition<AccessLogFilteringCriteriaCfgClient,AccessLogFilteringCriteriaCfg>
An interface for querying the Access Log Filtering Criteria managed object definition meta information.A set of rules which together determine whether a log record should be logged or not.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AccessLogFilteringCriteriaCfgDefn.LogRecordType
Defines the set of permissible values for the "log-record-type" property.
-
Method Summary
-
Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
-
-
-
-
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.
-
createClientConfiguration
public AccessLogFilteringCriteriaCfgClient createClientConfiguration(ManagedObject<? extends AccessLogFilteringCriteriaCfgClient> impl)
Description copied from class:ManagedObjectDefinition
Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.- Specified by:
createClientConfiguration
in classManagedObjectDefinition<AccessLogFilteringCriteriaCfgClient,AccessLogFilteringCriteriaCfg>
- Parameters:
impl
- The managed object.- Returns:
- Returns a client configuration view of the provided managed object.
-
createServerConfiguration
public AccessLogFilteringCriteriaCfg createServerConfiguration(ServerManagedObject<? extends AccessLogFilteringCriteriaCfg> impl)
Description copied from class:ManagedObjectDefinition
Creates a server configuration view of the provided server managed object.- Specified by:
createServerConfiguration
in classManagedObjectDefinition<AccessLogFilteringCriteriaCfgClient,AccessLogFilteringCriteriaCfg>
- Parameters:
impl
- The server managed object.- Returns:
- Returns a server configuration view of the provided server managed object.
-
getServerConfigurationClass
public Class<AccessLogFilteringCriteriaCfg> getServerConfigurationClass()
Description copied from class:ManagedObjectDefinition
Gets the server configuration class instance associated with this managed object definition.- Specified by:
getServerConfigurationClass
in classManagedObjectDefinition<AccessLogFilteringCriteriaCfgClient,AccessLogFilteringCriteriaCfg>
- Returns:
- Returns the server configuration class instance associated with this managed object definition.
-
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.
-
getLogRecordTypePropertyDefinition
public EnumPropertyDefinition<AccessLogFilteringCriteriaCfgDefn.LogRecordType> getLogRecordTypePropertyDefinition()
Get the "log-record-type" property definition.Filters log records based on their type.
- Returns:
- Returns the "log-record-type" 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.
-
-