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 Details

    • configurationClass

      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

      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

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