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

Class AccessLogPublisherCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<AccessLogPublisherCfgClient,AccessLogPublisherCfg>

org.forgerock.opendj.server.config.meta.AccessLogPublisherCfgDefn

public final class AccessLogPublisherCfgDefn
extends ManagedObjectDefinition<AccessLogPublisherCfgClient,AccessLogPublisherCfg>

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

Access Log Publishers are responsible for distributing access log messages from the access logger to a destination.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AccessLogPublisherCfgDefn.FilteringPolicy	Defines the set of permissible values for the "filtering-policy" property.

Method Summary

Modifier and Type	Method	Description
AccessLogPublisherCfgClient	createClientConfiguration(ManagedObject<? extends AccessLogPublisherCfgClient> impl)	Creates a client configuration view of the provided managed object.
AccessLogPublisherCfg	createServerConfiguration(ServerManagedObject<? extends AccessLogPublisherCfg> 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.
EnumPropertyDefinition<AccessLogPublisherCfgDefn.FilteringPolicy>	getFilteringPolicyPropertyDefinition()	Get the "filtering-policy" property definition.
static AccessLogPublisherCfgDefn	getInstance()	Get the Access Log Publisher configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<AccessLogPublisherCfg>	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

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 AccessLogPublisherCfgDefn getInstance()

Get the Access Log Publisher configuration definition singleton.

Returns:

Returns the Access Log Publisher configuration definition singleton.

createClientConfiguration

public AccessLogPublisherCfgClient createClientConfiguration(ManagedObject<? extends AccessLogPublisherCfgClient> 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<AccessLogPublisherCfgClient,AccessLogPublisherCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<AccessLogPublisherCfgClient,AccessLogPublisherCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<AccessLogPublisherCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<AccessLogPublisherCfgClient,AccessLogPublisherCfg>

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 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 Access Log Publisher implementation.

Returns:

Returns the "java-class" 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.