com.unboundid.ldap.sdk.controls
Class ManageDsaITRequestControl

java.lang.Object
  com.unboundid.ldap.sdk.Control
      com.unboundid.ldap.sdk.controls.ManageDsaITRequestControl

All Implemented Interfaces:

java.io.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:

   DeleteRequest deleteRequest =
     new DeleteRequest("uid=john.doe,ou=People,dc=example,dc=com");
   deleteRequest.addControl(new ManageDsaITRequestControl());
   LDAPResult deleteResult = connection.delete(deleteRequest);
 

See Also:

Serialized Form

Field Summary

static java.lang.String

MANAGE_DSA_IT_REQUEST_OID The OID (2.16.840.1.113730.3.4.2) for the ManageDsaIT request control.

Constructor Summary

ManageDsaITRequestControl()
Creates a new ManageDsaIT request control.

ManageDsaITRequestControl(boolean isCritical)
Creates a new ManageDsaIT request control.

ManageDsaITRequestControl(Control control)
Creates a new ManageDsaIT request control which is decoded from the provided generic control.

Method Summary

java.lang.String	getControlName() Retrieves the user-friendly name for this control, if available.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this LDAP control to the provided buffer.

Methods inherited from class com.unboundid.ldap.sdk.Control

decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MANAGE_DSA_IT_REQUEST_OID

public static final java.lang.String MANAGE_DSA_IT_REQUEST_OID

The OID (2.16.840.1.113730.3.4.2) for the ManageDsaIT request control.

See Also:

Constant Field Values

Constructor Detail

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(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 Detail

getControlName

public java.lang.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.

toString

public void toString(java.lang.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.