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

Class AttributeCleanupPluginCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<AttributeCleanupPluginCfgClient,AttributeCleanupPluginCfg>

org.forgerock.opendj.server.config.meta.AttributeCleanupPluginCfgDefn

public final class AttributeCleanupPluginCfgDefn
extends ManagedObjectDefinition<AttributeCleanupPluginCfgClient,AttributeCleanupPluginCfg>

An interface for querying the Attribute Cleanup Plugin managed object definition meta information.

A pre-parse plugin which can be used to remove and rename attributes in ADD and MODIFY requests before being processed.

Method Summary

Modifier and Type	Method	Description
AttributeCleanupPluginCfgClient	createClientConfiguration(ManagedObject<? extends AttributeCleanupPluginCfgClient> impl)	Creates a client configuration view of the provided managed object.
AttributeCleanupPluginCfg	createServerConfiguration(ServerManagedObject<? extends AttributeCleanupPluginCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static AttributeCleanupPluginCfgDefn	getInstance()	Get the Attribute Cleanup Plugin configuration definition singleton.
BooleanPropertyDefinition	getInvokeForInternalOperationsPropertyDefinition()	Get the "invoke-for-internal-operations" property definition.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
EnumPropertyDefinition<PluginCfgDefn.PluginType>	getPluginTypePropertyDefinition()	Get the "plugin-type" property definition.
StringPropertyDefinition	getRemoveInboundAttributesPropertyDefinition()	Get the "remove-inbound-attributes" property definition.
StringPropertyDefinition	getRenameInboundAttributesPropertyDefinition()	Get the "rename-inbound-attributes" property definition.
Class<AttributeCleanupPluginCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

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

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, 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 AttributeCleanupPluginCfgDefn getInstance()

Get the Attribute Cleanup Plugin configuration definition singleton.

Returns:

Returns the Attribute Cleanup Plugin configuration definition singleton.

createClientConfiguration

public AttributeCleanupPluginCfgClient createClientConfiguration(ManagedObject<? extends AttributeCleanupPluginCfgClient> 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<AttributeCleanupPluginCfgClient,AttributeCleanupPluginCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<AttributeCleanupPluginCfgClient,AttributeCleanupPluginCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<AttributeCleanupPluginCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<AttributeCleanupPluginCfgClient,AttributeCleanupPluginCfg>

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 plug-in is enabled for use.

Returns:

Returns the "enabled" property definition.

getInvokeForInternalOperationsPropertyDefinition

public BooleanPropertyDefinition getInvokeForInternalOperationsPropertyDefinition()

Get the "invoke-for-internal-operations" property definition.

Indicates whether the plug-in should be invoked for internal operations.

Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.

Returns:

Returns the "invoke-for-internal-operations" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the plug-in implementation.

Returns:

Returns the "java-class" property definition.

getPluginTypePropertyDefinition

public EnumPropertyDefinition<PluginCfgDefn.PluginType> getPluginTypePropertyDefinition()

Get the "plugin-type" property definition.

Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

Returns:

Returns the "plugin-type" property definition.

getRemoveInboundAttributesPropertyDefinition

public StringPropertyDefinition getRemoveInboundAttributesPropertyDefinition()

Get the "remove-inbound-attributes" property definition.

A list of attributes which should be removed from incoming add or modify requests.

Returns:

Returns the "remove-inbound-attributes" property definition.

getRenameInboundAttributesPropertyDefinition

public StringPropertyDefinition getRenameInboundAttributesPropertyDefinition()

Get the "rename-inbound-attributes" property definition.

A list of attributes which should be renamed in incoming add or modify requests.

Returns:

Returns the "rename-inbound-attributes" property definition.