@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ManageDsaITRequestControl extends Control
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.
// 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();
| Modifier and Type | Field and Description |
|---|---|
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 and Description |
|---|
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.
|
| Modifier and Type | Method and Description |
|---|---|
static ManageDsaITRequestControl |
decodeJSONControl(JSONObject controlObject,
boolean strict)
Attempts to decode the provided object as a JSON representation of a
ManageDsaIT request control.
|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available.
|
JSONObject |
toJSONControl()
Retrieves a representation of this ManageDsaIT request control as a JSON
object.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided
buffer.
|
decode, decode, decodeControls, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo@NotNull public static final java.lang.String MANAGE_DSA_IT_REQUEST_OID
public ManageDsaITRequestControl()
public ManageDsaITRequestControl(boolean isCritical)
isCritical - Indicates whether the control should be marked
critical.public ManageDsaITRequestControl(@NotNull Control control) throws LDAPException
control - The generic control to be decoded as a ManageDsaIT request
control.LDAPException - If the provided control cannot be decoded as a
ManageDsaIT request control.@NotNull public java.lang.String getControlName()
getControlName in class Control@NotNull public JSONObject toJSONControl()
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.
toJSONControl in class Control@NotNull public static ManageDsaITRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
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.LDAPException - If the provided JSON object cannot be parsed as a
valid ManageDsaIT request control.