3.4.3. Creating Smart Referrals

Smart referrals map a directory entry or directory tree to a specific LDAP URL. Using smart referrals, client applications can be referred to a specific server or a specific entry on a specific server.
For example, a client application requests the directory entry uid=jdoe,ou=people,dc=example,dc=com. A smart referral is returned to the client that points to the entry cn=john doe,o=people,l=europe,dc=example,dc=com on the server directory.europe.example.com.
The way the directory uses smart referrals conforms to the standard specified in RFC 2251 section 4.1.11. The RFC can be downloaded at http://www.ietf.org/rfc/rfc2251.txt.

3.4.3.1. Creating Smart Referrals Using the Directory Server Console

To configure smart referrals, do the following:
  1. In the Directory Server Console, select the Directory tab.
  2. Browse through the tree in the left navigation pane, and select the entry for which to add the referral.
  3. Right-click the entry, and select Set Smart Referrals.
    The Edit Smart Referrals dialog box opens.
  4. Select the Enable Smart Referral option to define smart referrals for the selected entry. (Unchecking the option removes all smart referrals from the entry and deletes the referral object class from the entry.)
  5. In the Enter a new Smart Referral field, enter a referral in the LDAP URL format, and then click Add to add the referral to the list. The LDAP URL must be in the following format:
    ldap://hostname:portnumber/[optional_dn]
    optional_dn is the explicit DN for the server to return to the requesting client application. For example, this LDAP URL references John Doe's entry:
    ldap://directory.example.com:389/cn=john doe,o=people,l=europe,dc=example,dc=com
    For the server to use the DN from the original search request instead, enter the LDAP URL in the format:
    ldap://hostname:portnumber/
    Clicking Construct opens a wizard to direct the process of adding a referral.
  6. To allow a referral to be followed with different authentication, click Authentication, and specify the appropriate DN and password. Keep in mind that this authentication remains valid only until the Console is closed; then it's reset to the same authentication used to log into the Console.
  7. The Smart Referral List lists the referrals currently in place for the selected entry. The entire list of referrals is returned to client applications in response to a request with the Return Referrals for All Operations or Return Referrals for Update Operations options in the Suffix Settings tab, which is available under the Configuration tab.
    To modify the list, click Edit to edit the selected referral or Delete to delete the selected referral.
  8. Click OK.