Unique Attribute Plugin

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

The values for each attribute must be unique within each base DN specified in the plugin's base-dn property or within all of the server's public naming contexts if no base DNs were specified.

Parent

The Unique Attribute Plugin object inherits from Plugin.

Properties

Use the --advanced option to access advanced properties.

Basic Properties

base-dn

SynopsisSpecifies a base DN within which the attribute must be unique.
Default ValueThe plug-in uses the server's public naming contexts in the searches.
Allowed ValuesA valid DN.
Multi-valuedYes
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

enabled

SynopsisIndicates whether the plug-in is enabled for use.
Default ValueNone
Allowed Valuestrue
false
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

type

SynopsisSpecifies the type of attributes to check for value uniqueness.
Default ValueNone
Allowed ValuesThe name of an attribute type defined in the LDAP schema.
Multi-valuedYes
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

Advanced Properties

invoke-for-internal-operations

SynopsisIndicates whether the plug-in should be invoked for internal operations.
DescriptionAny 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.
Default Valuetrue
Allowed Valuestrue
false
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedYes
Read-OnlyNo

java-class

SynopsisSpecifies the fully-qualified name of the Java class that provides the plug-in implementation.
Default Valueorg.opends.server.plugins.UniqueAttributePlugin
Allowed ValuesA Java class that extends or implements:
org.opends.server.api.plugin.DirectoryServerPlugin
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedYes
Read-OnlyNo

plugin-type

SynopsisSpecifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
Default Valuepreoperationadd
preoperationmodify
preoperationmodifydn
postoperationadd
postoperationmodify
postoperationmodifydn
postsynchronizationadd
postsynchronizationmodify
postsynchronizationmodifydn
Allowed Values

intermediateresponse: Invoked before sending an intermediate repsonse message to the client.

ldifexport: Invoked for each operation to be written during an LDIF export.

ldifimport: Invoked for each entry read during an LDIF import.

ldifimportbegin: Invoked at the beginning of an LDIF import session.

ldifimportend: Invoked at the end of an LDIF import session.

postconnect: Invoked whenever a new connection is established to the server.

postdisconnect: Invoked whenever an existing connection is terminated (by either the client or the server).

postoperationabandon: Invoked after completing the abandon processing.

postoperationadd: Invoked after completing the core add processing but before sending the response to the client.

postoperationbind: Invoked after completing the core bind processing but before sending the response to the client.

postoperationcompare: Invoked after completing the core compare processing but before sending the response to the client.

postoperationdelete: Invoked after completing the core delete processing but before sending the response to the client.

postoperationextended: Invoked after completing the core extended processing but before sending the response to the client.

postoperationmodify: Invoked after completing the core modify processing but before sending the response to the client.

postoperationmodifydn: Invoked after completing the core modify DN processing but before sending the response to the client.

postoperationsearch: Invoked after completing the core search processing but before sending the response to the client.

postoperationunbind: Invoked after completing the unbind processing.

postresponseadd: Invoked after sending the add response to the client.

postresponsebind: Invoked after sending the bind response to the client.

postresponsecompare: Invoked after sending the compare response to the client.

postresponsedelete: Invoked after sending the delete response to the client.

postresponseextended: Invoked after sending the extended response to the client.

postresponsemodify: Invoked after sending the modify response to the client.

postresponsemodifydn: Invoked after sending the modify DN response to the client.

postresponsesearch: Invoked after sending the search result done message to the client.

postsynchronizationadd: Invoked after completing post-synchronization processing for an add operation.

postsynchronizationdelete: Invoked after completing post-synchronization processing for a delete operation.

postsynchronizationmodify: Invoked after completing post-synchronization processing for a modify operation.

postsynchronizationmodifydn: Invoked after completing post-synchronization processing for a modify DN operation.

preoperationadd: Invoked prior to performing the core add processing.

preoperationbind: Invoked prior to performing the core bind processing.

preoperationcompare: Invoked prior to performing the core compare processing.

preoperationdelete: Invoked prior to performing the core delete processing.

preoperationextended: Invoked prior to performing the core extended processing.

preoperationmodify: Invoked prior to performing the core modify processing.

preoperationmodifydn: Invoked prior to performing the core modify DN processing.

preoperationsearch: Invoked prior to performing the core search processing.

preparseabandon: Invoked prior to parsing an abandon request.

preparseadd: Invoked prior to parsing an add request.

preparsebind: Invoked prior to parsing a bind request.

preparsecompare: Invoked prior to parsing a compare request.

preparsedelete: Invoked prior to parsing a delete request.

preparseextended: Invoked prior to parsing an extended request.

preparsemodify: Invoked prior to parsing a modify request.

preparsemodifydn: Invoked prior to parsing a modify DN request.

preparsesearch: Invoked prior to parsing a search request.

preparseunbind: Invoked prior to parsing an unbind request.

searchresultentry: Invoked before sending a search result entry to the client.

searchresultreference: Invoked before sending a search result reference to the client.

shutdown: Invoked during a graceful directory server shutdown.

startup: Invoked during the directory server startup process.

subordinatedelete: Invoked in the course of deleting a subordinate entry of a delete operation.

subordinatemodifydn: Invoked in the course of moving or renaming an entry subordinate to the target of a modify DN operation.

Multi-valuedYes
RequiredYes
Admin Action RequiredThe object must be disabled and re-enabled for changes to take effect.
AdvancedYes
Read-OnlyNo