Package org.forgerock.opendj.server.config.meta

Class CommonAuditAccessLogPublisherCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<CommonAuditAccessLogPublisherCfgClient,CommonAuditAccessLogPublisherCfg>

org.forgerock.opendj.server.config.meta.CommonAuditAccessLogPublisherCfgDefn

public final class CommonAuditAccessLogPublisherCfgDefn
extends AbstractManagedObjectDefinition<CommonAuditAccessLogPublisherCfgClient,CommonAuditAccessLogPublisherCfg>

An interface for querying the Common Audit Access Log Publisher managed object definition meta information.

Common Audit Access Log Publishers publish access events to commons audit.

Method Summary

Modifier and Type	Method	Description
InstantiableRelationDefinition<AccessLogFilteringCriteriaCfgClient,AccessLogFilteringCriteriaCfg>	getAccessLogFilteringCriteriaRelationDefinition()	Get the "access-log-filtering-criteria" relation definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
EnumPropertyDefinition<AccessLogPublisherCfgDefn.FilteringPolicy>	getFilteringPolicyPropertyDefinition()	Get the "filtering-policy" property definition.
static CommonAuditAccessLogPublisherCfgDefn	getInstance()	Get the Common Audit Access Log Publisher configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
BooleanPropertyDefinition	getLogControlsPropertyDefinition()	Get the "log-controls" property definition.
BooleanPropertyDefinition	getSuppressInternalOperationsPropertyDefinition()	Get the "suppress-internal-operations" property definition.
BooleanPropertyDefinition	getSuppressSynchronizationOperationsPropertyDefinition()	Get the "suppress-synchronization-operations" property definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getInstance

public static CommonAuditAccessLogPublisherCfgDefn getInstance()

Get the Common Audit Access Log Publisher configuration definition singleton.

Returns:

Returns the Common Audit Access Log Publisher configuration definition singleton.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Common Audit Access Log Publisher is enabled for use.

Returns:

Returns the "enabled" property definition.

getFilteringPolicyPropertyDefinition

public EnumPropertyDefinition<AccessLogPublisherCfgDefn.FilteringPolicy> getFilteringPolicyPropertyDefinition()

Get the "filtering-policy" property definition.

Specifies how filtering criteria should be applied to log records.

Returns:

Returns the "filtering-policy" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

The fully-qualified name of the Java class that provides the Common Audit Access Log Publisher implementation.

Returns:

Returns the "java-class" property definition.

getLogControlsPropertyDefinition

public BooleanPropertyDefinition getLogControlsPropertyDefinition()

Get the "log-controls" property definition.

Specifies whether controls with criticality and values will be included in operation log records.

Returns:

Returns the "log-controls" property definition.

getSuppressInternalOperationsPropertyDefinition

public BooleanPropertyDefinition getSuppressInternalOperationsPropertyDefinition()

Get the "suppress-internal-operations" property definition.

Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users.

Returns:

Returns the "suppress-internal-operations" property definition.

getSuppressSynchronizationOperationsPropertyDefinition

public BooleanPropertyDefinition getSuppressSynchronizationOperationsPropertyDefinition()

Get the "suppress-synchronization-operations" property definition.

Indicates whether access messages that are generated by synchronization operations should be suppressed.

Returns:

Returns the "suppress-synchronization-operations" property definition.

getAccessLogFilteringCriteriaRelationDefinition

public InstantiableRelationDefinition<AccessLogFilteringCriteriaCfgClient,AccessLogFilteringCriteriaCfg> getAccessLogFilteringCriteriaRelationDefinition()

Get the "access-log-filtering-criteria" relation definition.

Returns:

Returns the "access-log-filtering-criteria" relation definition.