Package org.forgerock.opendj.server.config.client

Interface UniqueAttributePluginCfgClient

All Superinterfaces:

ConfigurationClient, PluginCfgClient

public interface UniqueAttributePluginCfgClient
extends PluginCfgClient

A client-side interface for reading and modifying Unique Attribute Plugin settings.

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
ManagedObjectDefinition<? extends UniqueAttributePluginCfgClient,? extends UniqueAttributePluginCfg>	definition()	Get the configuration definition associated with this Unique Attribute Plugin.
SortedSet<ValueOrExpression<Dn>>	getBaseDn()	Gets the "base-dn" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
SortedSet<ValueOrExpression<PluginCfgDefn.PluginType>>	getPluginType()	Gets the "plugin-type" property.
SortedSet<ValueOrExpression<AttributeType>>	getType()	Gets the "type" property.
void	setBaseDn(Collection<ValueOrExpression<Dn>> values)	Sets the "base-dn" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values)	Sets the "plugin-type" property.
void	setType(Collection<ValueOrExpression<AttributeType>> values)	Sets the "type" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.PluginCfgClient

isEnabled, isInvokeForInternalOperations, setEnabled, setInvokeForInternalOperations

Method Detail

definition

ManagedObjectDefinition<? extends UniqueAttributePluginCfgClient,? extends UniqueAttributePluginCfg> definition()

Get the configuration definition associated with this Unique Attribute Plugin.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface PluginCfgClient

Returns:

Returns the configuration definition associated with this Unique Attribute Plugin.

getBaseDn

SortedSet<ValueOrExpression<Dn>> getBaseDn()

Gets the "base-dn" property.

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

Returns:

Returns the values of the "base-dn" property.

setBaseDn

void setBaseDn(Collection<ValueOrExpression<Dn>> values)
        throws PropertyException

Sets the "base-dn" property.

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

Parameters:

values - The values of the "base-dn" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.plugins.UniqueAttributePlugin

Specified by:

getJavaClass in interface PluginCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface PluginCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

getPluginType

@MandatoryProperty
SortedSet<ValueOrExpression<PluginCfgDefn.PluginType>> getPluginType()

Gets the "plugin-type" property.

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

Default values: preoperationadd, preoperationmodify, preoperationmodifydn, postoperationadd, postoperationmodify, postoperationmodifydn, postsynchronizationadd, postsynchronizationmodify, postsynchronizationmodifydn

Specified by:

getPluginType in interface PluginCfgClient

Returns:

Returns the values of the "plugin-type" property.

setPluginType

@MandatoryProperty
void setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values)
            throws PropertyException

Sets the "plugin-type" property.

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

Specified by:

setPluginType in interface PluginCfgClient

Parameters:

values - The values of the "plugin-type" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getType

@MandatoryProperty
SortedSet<ValueOrExpression<AttributeType>> getType()

Gets the "type" property.

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 values of the "type" property.

setType

@MandatoryProperty
void setType(Collection<ValueOrExpression<AttributeType>> values)
      throws PropertyException

Sets the "type" property.

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).

Parameters:

values - The values of the "type" property.

Throws:

PropertyException - If one or more of the new values are invalid.