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

Class JsonFileAccessLogPublisherCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<JsonFileAccessLogPublisherCfgClient,JsonFileAccessLogPublisherCfg>

org.forgerock.opendj.server.config.meta.JsonFileAccessLogPublisherCfgDefn

public final class JsonFileAccessLogPublisherCfgDefn
extends ManagedObjectDefinition<JsonFileAccessLogPublisherCfgClient,JsonFileAccessLogPublisherCfg>

An interface for querying the JSON File Based Access Log Publisher managed object definition meta information.

JSON File Based Access Log Publishers publish access messages to JSON files.

Method Summary

Modifier and Type	Method	Description
JsonFileAccessLogPublisherCfgClient	createClientConfiguration(ManagedObject<? extends JsonFileAccessLogPublisherCfgClient> impl)	Creates a client configuration view of the provided managed object.
JsonFileAccessLogPublisherCfg	createServerConfiguration(ServerManagedObject<? extends JsonFileAccessLogPublisherCfg> impl)	Creates a server configuration view of the provided server managed object.
InstantiableRelationDefinition<AccessLogFilteringCriteriaCfgClient,AccessLogFilteringCriteriaCfg>	getAccessLogFilteringCriteriaRelationDefinition()	Get the "access-log-filtering-criteria" relation definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
AttributeTypePropertyDefinition	getExcludeValuesOfAttributesPropertyDefinition()	Get the "exclude-values-of-attributes" property definition.
EnumPropertyDefinition<AccessLogPublisherCfgDefn.FilteringPolicy>	getFilteringPolicyPropertyDefinition()	Get the "filtering-policy" property definition.
AttributeTypePropertyDefinition	getIncludeValuesOfAttributesPropertyDefinition()	Get the "include-values-of-attributes" property definition.
static JsonFileAccessLogPublisherCfgDefn	getInstance()	Get the JSON File Based Access Log Publisher configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
BooleanPropertyDefinition	getLogControlsPropertyDefinition()	Get the "log-controls" property definition.
StringPropertyDefinition	getLogDirectoryPropertyDefinition()	Get the "log-directory" property definition.
StringPropertyDefinition	getLogFieldBlacklistPropertyDefinition()	Get the "log-field-blacklist" property definition.
StringPropertyDefinition	getLogFileNamePrefixPropertyDefinition()	Get the "log-file-name-prefix" property definition.
BooleanPropertyDefinition	getLogModifiedAttributeValuesPropertyDefinition()	Get the "log-modified-attribute-values" property definition.
AggregationPropertyDefinition<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg>	getRetentionPolicyPropertyDefinition()	Get the "retention-policy" property definition.
AggregationPropertyDefinition<LogRotationPolicyCfgClient,LogRotationPolicyCfg>	getRotationPolicyPropertyDefinition()	Get the "rotation-policy" property definition.
Class<JsonFileAccessLogPublisherCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object 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

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, 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 Detail

getInstance

public static JsonFileAccessLogPublisherCfgDefn getInstance()

Get the JSON File Based Access Log Publisher configuration definition singleton.

Returns:

Returns the JSON File Based Access Log Publisher configuration definition singleton.

createClientConfiguration

public JsonFileAccessLogPublisherCfgClient createClientConfiguration(ManagedObject<? extends JsonFileAccessLogPublisherCfgClient> 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 class ManagedObjectDefinition<JsonFileAccessLogPublisherCfgClient,JsonFileAccessLogPublisherCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public JsonFileAccessLogPublisherCfg createServerConfiguration(ServerManagedObject<? extends JsonFileAccessLogPublisherCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<JsonFileAccessLogPublisherCfgClient,JsonFileAccessLogPublisherCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<JsonFileAccessLogPublisherCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<JsonFileAccessLogPublisherCfgClient,JsonFileAccessLogPublisherCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the JSON File Based 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 JSON File Based 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.

getLogDirectoryPropertyDefinition

public StringPropertyDefinition getLogDirectoryPropertyDefinition()

Get the "log-directory" property definition.

The directory to use for the log files generated by the JSON File Based Access Log Publisher. The path to the directory is relative to the server root.

Returns:

Returns the "log-directory" property definition.

getLogFieldBlacklistPropertyDefinition

public StringPropertyDefinition getLogFieldBlacklistPropertyDefinition()

Get the "log-field-blacklist" property definition.

List of fields that the server omits from access log messages.

Valid values for this property are JSON paths for fields present in the log file.

Returns:

Returns the "log-field-blacklist" property definition.

getLogFileNamePrefixPropertyDefinition

public StringPropertyDefinition getLogFileNamePrefixPropertyDefinition()

Get the "log-file-name-prefix" property definition.

File name prefix (without extension) for CSV and JSON file based access log publishers.

Returns:

Returns the "log-file-name-prefix" 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.

getRetentionPolicyPropertyDefinition

public AggregationPropertyDefinition<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg> getRetentionPolicyPropertyDefinition()

Get the "retention-policy" property definition.

The retention policy to use for the JSON File Based Access Log Publisher.

When multiple policies are used, log files are cleaned when any of the policy's conditions are met.

Returns:

Returns the "retention-policy" property definition.

getRotationPolicyPropertyDefinition

public AggregationPropertyDefinition<LogRotationPolicyCfgClient,LogRotationPolicyCfg> getRotationPolicyPropertyDefinition()

Get the "rotation-policy" property definition.

The rotation policy to use for the JSON File Based Access Log Publisher.

When multiple policies are used, rotation will occur if any policy's conditions are met.

Returns:

Returns the "rotation-policy" 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.