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 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.

    • getExcludeValuesOfAttributesPropertyDefinition

      public AttributeTypePropertyDefinition getExcludeValuesOfAttributesPropertyDefinition()
      Get the "exclude-values-of-attributes" property definition.

      Attributes types targeted by a modify operation for which the modified values should be omitted from the access log.

      Returns:
      Returns the "exclude-values-of-attributes" 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.

    • getIncludeValuesOfAttributesPropertyDefinition

      public AttributeTypePropertyDefinition getIncludeValuesOfAttributesPropertyDefinition()
      Get the "include-values-of-attributes" property definition.

      Attributes types targeted by a modify operation for which the modified values should be included in the access log.

      Returns:
      Returns the "include-values-of-attributes" 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.

    • getLogModifiedAttributeValuesPropertyDefinition

      public BooleanPropertyDefinition getLogModifiedAttributeValuesPropertyDefinition()
      Get the "log-modified-attribute-values" property definition.

      The access log contains the values of attributes targeted by a modify operation.

      Returns:
      Returns the "log-modified-attribute-values" 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.