Chapter 4. Enforcing attribute uniqueness

Procedure

1. Create a new plug-in configuration entry:

   # dsconf -D "cn=Directory Manager" ldap://server.example.com plugin attr-uniq add "Mail Uniqueness" --attr-name mail --subtree ou=sales,dc=example,dc=com ou=accounting,dc=example,dc=com

   Copy to Clipboard Toggle word wrap

   The command creates the cn=Mail Uniqueness,cn=plugins,cn=config configuration entry.

   Note

   You can set the plug-in to verify uniqueness of multiple attributes in one configuration entry.

2. Optional: Configure uniqueness across all subtrees configured in this plug-in configuration entry:

   # dsconf -D "cn=Directory Manager" ldap://server.example.com plugin attr-uniq set "Mail Uniqueness" --across-all-subtrees on

   Copy to Clipboard Toggle word wrap

   The command sets the uniqueness-across-all-subtrees plug-in configuration parameter to on. Therefore, the plug-in checks uniqueness of the mail attribute across both the ou=sales,dc=example,dc=com and ou=accounting,dc=example,dc=com subtrees. By default, the plug-in only checks uniqueness across the subtree where the entry is created or updated, which means that if you create or update an entry under ou=sales,dc=example,dc=com, the plug-in checks the mail attribute uniqueness only across this subtree.

3. Optional: Set a subtree that the plug-in must exclude from the attribute uniqueness verification.

   For example, if you want the plug-in to skip the ou=internal,ou=sales,dc=example,dc=com subtree, you can use the ldapmodify utility to set the uniqueness-exclude-subtrees parameter:

   # ldapmodify -D "cn=Directory Manager" -W -H ldap://server.example.com -x
   
   dn: cn=Mail Uniqueness,cn=plugins,cn=config
   changetype: modify
   add: uniqueness-exclude-subtrees
   uniqueness-exclude-subtrees: ou=internal,ou=sales,dc=example,dc=com

   Copy to Clipboard Toggle word wrap

4. Optional: If you what the plug-in to verify uniqueness only in entries that contain a specific object class, set this object class as a value for the uniqueness-subtree-entries-oc parameter.

   For example, you want the mail attribute to be unique only in entries that contain the inetOrgPerson object class, enter:

   # dsconf -D "cn=Directory Manager" ldap://server.example.com plugin attr-uniq set "Mail Uniqueness" --subtree-entries-oc=inetOrgPerson

   Copy to Clipboard Toggle word wrap

5. Enable the plug-in on the server:

   # dsconf -D "cn=Directory Manager" ldap://server.example.com plugin attr-uniq enable "Mail Uniqueness"

   Copy to Clipboard Toggle word wrap

6. Restart the instance:

   # dsctl instance_name restart

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a new plug-in configuration entry:

   # dsconf -D "cn=Directory Manager" ldap://server.example.com plugin attr-uniq add "Mail Uniqueness with OC" --attr-name mail --subtree-entries-oc=inetOrgPerson --top-entry-oc=nsContainer

   Copy to Clipboard Toggle word wrap

   The command creates the cn=Mail Uniqueness with OC,cn=plugins,cn=config entry with the configured uniqueness-top-entry-oc and uniqueness-subtree-entries-oc plug-in parameters.

2. Optional: Set a subtree that the plug-in must exclude from the attribute uniqueness verification.

   For example, if you want the plug-in to skip the ou=internal,ou=sales,dc=example,dc=com subtree, use the ldapmodify utility to set the uniqueness-exclude-subtrees parameter:

   # ldapmodify -D "cn=Directory Manager" -W -H ldap://server.example.com -x
   
   dn: cn=Mail Uniqueness with OC,cn=plugins,cn=config
   changetype: modify
   add: uniqueness-exclude-subtrees
   uniqueness-exclude-subtrees: ou=internal,ou=sales,dc=example,dc=com

   Copy to Clipboard Toggle word wrap

3. Enable the plug-in on the server:

   # dsconf -D "cn=Directory Manager" ldap://server.example.com plugin attr-uniq enable "Mail Uniqueness with OC"

   Copy to Clipboard Toggle word wrap

4. Restart the instance:

   # dsctl instance_name restart

   Copy to Clipboard Toggle word wrap

Procedure

1. Select the instance, where you want to configure the plug-in.
2. Open the Plugins menu and select the Attribute Uniqueness plug-in from the list.
3. Click Add Config button to start the configuration of a new configuration entry.
4. Enter the name of the configuration entry in the Config Name field.
5. Select which attributes must be unique in the Attribute Names field. The field sets the uniqueness-attribute-name attribute.

6. Enter the subtrees under which the plug-in checks uniqueness of attributes in the Subtrees field. The field sets the uniqueness-subtrees attribute.

   By default, the plug-in checks uniqueness across only the subtree where the entry is created or updated. To check across all listed subtrees, check the Across All Subtrees checkbox that sets the uniqueness-across-all-subtrees attribute to on.

7. Toggle the switch to the Configuration is enabled position.

8. Click Add Config button to create the plug-in configuration entry.

   Figure 4.1. Configuration example of the Attribute Uniqueness plug-in.

   

   View larger image

   
9. Restart the instance. For more details, see Starting and stopping a Directory Server instance by using the web console.