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

Class ExternalAccessLogPublisherCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<ExternalAccessLogPublisherCfgClient,ExternalAccessLogPublisherCfg>

org.forgerock.opendj.server.config.meta.ExternalAccessLogPublisherCfgDefn

public final class ExternalAccessLogPublisherCfgDefn
extends ManagedObjectDefinition<ExternalAccessLogPublisherCfgClient,ExternalAccessLogPublisherCfg>

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

External Access Log Publishers publish access messages to an external handler.

Method Summary

Modifier and Type	Method	Description
ExternalAccessLogPublisherCfgClient	createClientConfiguration(ManagedObject<? extends ExternalAccessLogPublisherCfgClient> impl)	Creates a client configuration view of the provided managed object.
ExternalAccessLogPublisherCfg	createServerConfiguration(ServerManagedObject<? extends ExternalAccessLogPublisherCfg> impl)	Creates a server configuration view of the provided server managed object.
InstantiableRelationDefinition<AccessLogFilteringCriteriaCfgClient,AccessLogFilteringCriteriaCfg>	getAccessLogFilteringCriteriaRelationDefinition()	Get the "access-log-filtering-criteria" relation definition.
StringPropertyDefinition	getConfigFilePropertyDefinition()	Get the "config-file" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
EnumPropertyDefinition<AccessLogPublisherCfgDefn.FilteringPolicy>	getFilteringPolicyPropertyDefinition()	Get the "filtering-policy" property definition.
static ExternalAccessLogPublisherCfgDefn	getInstance()	Get the External Access Log Publisher configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
BooleanPropertyDefinition	getLogControlsPropertyDefinition()	Get the "log-controls" property definition.
StringPropertyDefinition	getLogFieldBlacklistPropertyDefinition()	Get the "log-field-blacklist" property definition.
Class<ExternalAccessLogPublisherCfg>	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 ExternalAccessLogPublisherCfgDefn getInstance()

Get the External Access Log Publisher configuration definition singleton.

Returns:

Returns the External Access Log Publisher configuration definition singleton.

createClientConfiguration

public ExternalAccessLogPublisherCfgClient createClientConfiguration(ManagedObject<? extends ExternalAccessLogPublisherCfgClient> 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<ExternalAccessLogPublisherCfgClient,ExternalAccessLogPublisherCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<ExternalAccessLogPublisherCfgClient,ExternalAccessLogPublisherCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<ExternalAccessLogPublisherCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<ExternalAccessLogPublisherCfgClient,ExternalAccessLogPublisherCfg>

Returns:

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

getConfigFilePropertyDefinition

public StringPropertyDefinition getConfigFilePropertyDefinition()

Get the "config-file" property definition.

The JSON configuration file that defines the External Access Log Publisher. The content of the JSON configuration file depends on the type of external audit event handler. The path to the file is relative to the server root.

Returns:

Returns the "config-file" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the External 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 External 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.

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.

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.