|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.controls.ManageDsaITRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ManageDsaITRequestControl
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.
// 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();
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 |
---|
public static final java.lang.String MANAGE_DSA_IT_REQUEST_OID
Constructor Detail |
---|
public ManageDsaITRequestControl()
public ManageDsaITRequestControl(boolean isCritical)
isCritical
- Indicates whether the control should be marked
critical.public ManageDsaITRequestControl(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.Method Detail |
---|
public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |