org.opends.server.admin.std.server
Interface UniqueAttributePluginCfg

All Superinterfaces:
Configuration, PluginCfg

public interface UniqueAttributePluginCfg
extends PluginCfg

A server-side interface for querying Unique Attribute Plugin settings.

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


Method Summary
 void addUniqueAttributeChangeListener(ConfigurationChangeListener<UniqueAttributePluginCfg> listener)
          Register to be notified when this Unique Attribute Plugin is changed.
 java.lang.Class<? extends UniqueAttributePluginCfg> configurationClass()
          Gets the configuration class 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 removeUniqueAttributeChangeListener(ConfigurationChangeListener<UniqueAttributePluginCfg> listener)
          Deregister an existing Unique Attribute Plugin configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.PluginCfg
addChangeListener, isEnabled, isInvokeForInternalOperations, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends UniqueAttributePluginCfg> configurationClass()
Gets the configuration class associated with this Unique Attribute Plugin.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface PluginCfg
Returns:
Returns the configuration class associated with this Unique Attribute Plugin.

addUniqueAttributeChangeListener

void addUniqueAttributeChangeListener(ConfigurationChangeListener<UniqueAttributePluginCfg> listener)
Register to be notified when this Unique Attribute Plugin is changed.

Parameters:
listener - The Unique Attribute Plugin configuration change listener.

removeUniqueAttributeChangeListener

void removeUniqueAttributeChangeListener(ConfigurationChangeListener<UniqueAttributePluginCfg> listener)
Deregister an existing Unique Attribute Plugin configuration change listener.

Parameters:
listener - The Unique Attribute Plugin configuration change listener.

getBaseDN

java.util.SortedSet<DN> getBaseDN()
Gets the "base-dn" property.

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

Returns:
Returns an unmodifiable set containing the values of the "base-dn" property.

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 PluginCfg
Returns:
Returns the value of the "java-class" property.

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 PluginCfg
Returns:
Returns an unmodifiable set containing the values of the "plugin-type" property.

getType

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

Specifies the type of attributes to check for value uniqueness.

Returns:
Returns an unmodifiable set containing the values of the "type" property.