com.unboundid.ldap.sdk.controls

Class DontUseCopyRequestControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.controls.DontUseCopyRequestControl

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class DontUseCopyRequestControl
extends Control

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.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
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, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toJSONControl, toString, writeTo

Methods inherited from class java.lang.Object

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

Field Detail

DONT_USE_COPY_REQUEST_OID

@NotNull
public static final java.lang.String DONT_USE_COPY_REQUEST_OID

The OID (1.3.6.1.1.22) for the don't use copy request control.

See Also:

Constant Field Values

Constructor Detail

DontUseCopyRequestControl

public DontUseCopyRequestControl()

Creates a new don't use copy request control. The control will be marked critical.

DontUseCopyRequestControl

public DontUseCopyRequestControl(@NotNull
                                 Control control)
                          throws LDAPException

Creates a new don't use copy request control which is decoded from the provided generic control.

Parameters:

control - The generic control to be decoded as a don't use copy request control.

Throws:

LDAPException - If the provided control cannot be decoded as a don't use copy request control.

Method Detail

getControlName

@NotNull
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(@NotNull
                     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.