|
|||||||||
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.PreReadResponseControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PreReadResponseControl
This class provides an implementation of the LDAP pre-read response control
as defined in RFC 4527. It
may be used to return a copy of the target entry immediately before
processing a delete, modify, or modify DN operation.
If the corresponding delete, modify, or modify DN request included the
PreReadRequestControl
and the operation was successful, then the
response for that operation should include the pre-read response control with
a read-only copy of the entry as it appeared immediately before processing
the request. If the operation was not successful, then the pre-read response
control will not be returned.
Field Summary | |
---|---|
static java.lang.String |
PRE_READ_RESPONSE_OID
The OID (1.3.6.1.1.13.1) for the pre-read response control. |
Constructor Summary | |
---|---|
PreReadResponseControl(ReadOnlyEntry entry)
Creates a new pre-read response control including the provided entry. |
|
PreReadResponseControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new pre-read response control with the provided information. |
Method Summary | |
---|---|
PreReadResponseControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided information. |
static PreReadResponseControl |
get(LDAPResult result)
Extracts a pre-read response control from the provided result. |
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available. |
ReadOnlyEntry |
getEntry()
Retrieves a read-only copy of the entry returned by this post-read response control. |
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 PRE_READ_RESPONSE_OID
Constructor Detail |
---|
public PreReadResponseControl(ReadOnlyEntry entry)
entry
- The entry to include in this pre-read response control. It
must not be null
.public PreReadResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.
LDAPException
- If the provided control cannot be decoded as a
pre-read response control.Method Detail |
---|
public PreReadResponseControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.
LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.public static PreReadResponseControl get(LDAPResult result) throws LDAPException
result
- The result from which to retrieve the pre-read response
control.
null
if the result did not contain a pre-read response
control.
LDAPException
- If a problem is encountered while attempting to
decode the pre-read response control contained in
the provided result.public ReadOnlyEntry getEntry()
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 |