Package com.unboundid.ldap.sdk.controls

Class ManageDsaITRequestControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.controls.ManageDsaITRequestControl
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ManageDsaITRequestControl extends Control
This class provides an implementation of the ManageDsaIT control as described in RFC 3296. This control may be used to request that the directory server treat all entries as if they were regular entries.

One of the most common uses of the ManageDsaIT control is to request that the directory server to treat an entry containing the "referral" object class as a regular entry rather than a smart referral. Normally, when the server encounters an entry with the referral object class, it sends a referral with the URLs contained in the ref attribute of that entry. However, if the ManageDsaIT control is included then the operation will attempt to operate on the referral definition itself rather than sending that referral to the client.

Example

The following example demonstrates the use of the ManageDsaIT control to delete an entry that may or may not be a referral: 
 // Establish a connection to the directory server.  Even though it's the
 // default behavior, we'll explicitly configure the connection to not follow
 // referrals.
 LDAPConnectionOptions connectionOptions = new LDAPConnectionOptions();
 connectionOptions.setFollowReferrals(false);
 LDAPConnection connection = new LDAPConnection(connectionOptions,
      serverAddress, serverPort, bindDN, bindPassword);

 // Try to delete an entry that will result in a referral.  Without the
 // ManageDsaIT request control, we should get an exception.
 DeleteRequest deleteRequest =
      new DeleteRequest("ou=referral entry,dc=example,dc=com");
 LDAPResult deleteResult;
 try
 {
   deleteResult = connection.delete(deleteRequest);
 }
 catch (LDAPException le)
 {
   // This exception is expected because we should get a referral, and
   // the connection is configured to not follow referrals.
   deleteResult = le.toLDAPResult();
   ResultCode resultCode = le.getResultCode();
   String errorMessageFromServer = le.getDiagnosticMessage();
   String[] referralURLs = le.getReferralURLs();
 }
 LDAPTestUtils.assertResultCodeEquals(deleteResult, ResultCode.REFERRAL);
 LDAPTestUtils.assertHasReferral(deleteResult);

 // Update the delete request to include the ManageDsaIT request control,
 // which will cause the server to try to delete the referral entry instead
 // of returning a referral response.  We'll assume that the delete is
 // successful.
 deleteRequest.addControl(new ManageDsaITRequestControl());
 try
 {
   deleteResult = connection.delete(deleteRequest);
 }
 catch (LDAPException le)
 {
   // The delete shouldn't trigger a referral, but it's possible that the
   // operation failed for some other reason (e.g., entry doesn't exist, the
   // user doesn't have permission to delete it, etc.).
   deleteResult = le.toLDAPResult();
 }
 LDAPTestUtils.assertResultCodeEquals(deleteResult, ResultCode.SUCCESS);
 LDAPTestUtils.assertMissingReferral(deleteResult);

 connection.close();
See Also:

  • Field Details

  • Constructor Details

    • ManageDsaITRequestControl

      public ManageDsaITRequestControl()
      Creates a new ManageDsaIT request control. The control will not be marked critical.

    • ManageDsaITRequestControl

      public ManageDsaITRequestControl(boolean isCritical)
      Creates a new ManageDsaIT request control.
      Parameters:
      isCritical - Indicates whether the control should be marked critical.

    • ManageDsaITRequestControl

      public ManageDsaITRequestControl(@NotNull Control control) throws LDAPException
      Creates a new ManageDsaIT request control which is decoded from the provided generic control.
      Parameters:
      control - The generic control to be decoded as a ManageDsaIT request control.
      Throws:
      LDAPException - If the provided control cannot be decoded as a ManageDsaIT request control.

  • Method Details

    • getControlName

      @NotNull public String getControlName()
      Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.
      Overrides:
      getControlName in class Control
      Returns:
      The user-friendly name for this control, or the OID if no user-friendly name is available.

    • toJSONControl

      @NotNull public JSONObject toJSONControl()
      Retrieves a representation of this ManageDsaIT request control as a JSON object. The JSON object uses the following fields (note that since this control does not have a value, neither the value-base64 nor value-json fields may be present):
      • oid -- A mandatory string field whose value is the object identifier for this control. For the ManageDsaIT request control, the OID is "2.16.840.1.113730.3.4.2".
      • control-name -- An optional string field whose value is a human-readable name for this control. This field is only intended for descriptive purposes, and when decoding a control, the oid field should be used to identify the type of control.
      • criticality -- A mandatory Boolean field used to indicate whether this control is considered critical.
      Overrides:
      toJSONControl in class Control
      Returns:
      A JSON object that contains a representation of this control.

    • decodeJSONControl

      @NotNull public static ManageDsaITRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
      Attempts to decode the provided object as a JSON representation of a ManageDsaIT request control.
      Parameters:
      controlObject - The JSON object to be decoded. It must not be null.
      strict - Indicates whether to use strict mode when decoding the provided JSON object. If this is true, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this is false, then unrecognized fields will be ignored.
      Returns:
      The ManageDsaIT request control that was decoded from the provided JSON object.
      Throws:
      LDAPException - If the provided JSON object cannot be parsed as a valid ManageDsaIT request control.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this LDAP control to the provided buffer.
      Overrides:
      toString in class Control
      Parameters:
      buffer - The buffer to which to append the string representation of this buffer.