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

Class UniqueAttributePluginCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<UniqueAttributePluginCfgClient,UniqueAttributePluginCfg>

org.forgerock.opendj.server.config.meta.UniqueAttributePluginCfgDefn

public final class UniqueAttributePluginCfgDefn
extends ManagedObjectDefinition<UniqueAttributePluginCfgClient,UniqueAttributePluginCfg>

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

The Unique Attribute Plugin enforces constraints on the value of an attribute within a portion of the directory.

Method Summary

Modifier and Type	Method	Description
UniqueAttributePluginCfgClient	createClientConfiguration(ManagedObject<? extends UniqueAttributePluginCfgClient> impl)	Creates a client configuration view of the provided managed object.
UniqueAttributePluginCfg	createServerConfiguration(ServerManagedObject<? extends UniqueAttributePluginCfg> impl)	Creates a server configuration view of the provided server managed object.
DnPropertyDefinition	getBaseDnPropertyDefinition()	Get the "base-dn" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static UniqueAttributePluginCfgDefn	getInstance()	Get the Unique Attribute 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.
Class<UniqueAttributePluginCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
AttributeTypePropertyDefinition	getTypePropertyDefinition()	Get the "type" property 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 UniqueAttributePluginCfgDefn getInstance()

Get the Unique Attribute Plugin configuration definition singleton.

Returns:

Returns the Unique Attribute Plugin configuration definition singleton.

createClientConfiguration

public UniqueAttributePluginCfgClient createClientConfiguration(ManagedObject<? extends UniqueAttributePluginCfgClient> 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<UniqueAttributePluginCfgClient,UniqueAttributePluginCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<UniqueAttributePluginCfgClient,UniqueAttributePluginCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<UniqueAttributePluginCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<UniqueAttributePluginCfgClient,UniqueAttributePluginCfg>

Returns:

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

getBaseDnPropertyDefinition

public DnPropertyDefinition getBaseDnPropertyDefinition()

Get the "base-dn" property definition.

Specifies a base DN within which the attribute must be unique.

Returns:

Returns the "base-dn" property 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.

getTypePropertyDefinition

public AttributeTypePropertyDefinition getTypePropertyDefinition()

Get the "type" property definition.

Specifies the attribute types to check for value uniqueness. Each attribute value must be unique for all specified attribute types. For example, if both uid and cn types are specified, then each uid and cn value must be unique for all uid and cn attributes under the specified base DN(s).

Returns:

Returns the "type" property definition.