org.opends.server.admin.std.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
 ManagedObjectDefinition<? extends UniqueAttributePluginCfgClient,? extends UniqueAttributePluginCfg> definition()
          Get the configuration definition associated with this Unique Attribute Plugin.
 java.util.SortedSet<DN> getBaseDN()
          Gets the "base-dn" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.util.SortedSet<PluginCfgDefn.PluginType> getPluginType()
          Gets the "plugin-type" property.
 java.util.SortedSet<AttributeType> getType()
          Gets the "type" property.
 void setBaseDN(java.util.Collection<DN> values)
          Sets the "base-dn" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setPluginType(java.util.Collection<PluginCfgDefn.PluginType> values)
          Sets the "plugin-type" property.
 void setType(java.util.Collection<AttributeType> values)
          Sets the "type" property.
 
Methods inherited from interface org.opends.server.admin.std.client.PluginCfgClient
isEnabled, isInvokeForInternalOperations, setEnabled, setInvokeForInternalOperations
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

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

java.util.SortedSet<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(java.util.Collection<DN> values)
               throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If one or more of the new values are invalid.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

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

Specified by:
getJavaClass in interface PluginCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

getPluginType

java.util.SortedSet<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.

Specified by:
getPluginType in interface PluginCfgClient
Returns:
Returns the values of the "plugin-type" property.

setPluginType

void setPluginType(java.util.Collection<PluginCfgDefn.PluginType> values)
                   throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If one or more of the new values are invalid.

getType

java.util.SortedSet<AttributeType> getType()
Gets the "type" property.

Specifies the type of attributes to check for value uniqueness.

Returns:
Returns the values of the "type" property.

setType

void setType(java.util.Collection<AttributeType> values)
             throws IllegalPropertyValueException
Sets the "type" property.

Specifies the type of attributes to check for value uniqueness.

Parameters:
values - The values of the "type" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.