|
|||||||||
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.DontUseCopyRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class DontUseCopyRequestControl
This class provides an implementation of the LDAP don't use copy control as defined in RFC 6171. This control may be used to request that only an authoritative directory server be used to process the associated search or compare request, and that the request should not be processed on a directory that may contain data that is cached or potentially stale. If the client includes this control in a request sent to a non-authoritative server, then that server may send a referral to the authoritative server, or it may simply reject the request.
Field Summary | |
---|---|
static java.lang.String |
DONT_USE_COPY_REQUEST_OID
The OID (1.3.6.1.1.22) for the don't use copy request control. |
Constructor Summary | |
---|---|
DontUseCopyRequestControl()
Creates a new don't use copy request control. |
|
DontUseCopyRequestControl(Control control)
Creates a new don't use copy 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 DONT_USE_COPY_REQUEST_OID
Constructor Detail |
---|
public DontUseCopyRequestControl()
public DontUseCopyRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as a don't use copy
request control.
LDAPException
- If the provided control cannot be decoded as a
don't use copy 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 |