public final class PostReadResponseControl extends Object implements Control
The following example gets a modified entry from the result of a modify operation.
Connection connection = ...; String DN = ...; ModifyRequest request = Requests.newModifyRequest(DN) .addControl(PostReadRequestControl.newControl(true, "description")) .addModification(ModificationType.REPLACE, "description", "Using the PostReadRequestControl"); Result result = connection.modify(request); PostReadResponseControl control = result.getControl(PostReadResponseControl.DECODER, new DecodeOptions()); Entry modifiedEntry = control.getEntry();
Modifier and Type | Field and Description |
---|---|
static ControlDecoder<PostReadResponseControl> |
DECODER
A decoder which can be used for decoding the post-read response control.
|
static String |
OID
The IANA-assigned OID for the LDAP post-read response control used for
retrieving an entry in the state it had immediately after an update was
applied.
|
Modifier and Type | Method and Description |
---|---|
Entry |
getEntry()
Returns an unmodifiable entry whose contents reflect the state of the
updated entry immediately after the update operation was performed.
|
String |
getOid()
Returns the numeric OID associated with this control.
|
ByteString |
getValue()
Returns the value, if any, associated with this control.
|
boolean |
hasValue()
Returns
true if this control has a value. |
boolean |
isCritical()
Returns
true if it is unacceptable to perform the operation
without applying the semantics of this control. |
static PostReadResponseControl |
newControl(Entry entry)
Creates a new post-read response control.
|
String |
toString() |
public static final String OID
public static final ControlDecoder<PostReadResponseControl> DECODER
public static PostReadResponseControl newControl(Entry entry)
entry
- The entry whose contents reflect the state of the updated
entry immediately after the update operation was performed.NullPointerException
- If entry
was null
.public Entry getEntry()
public String getOid()
Control
public ByteString getValue()
Control
public boolean hasValue()
Control
true
if this control has a value. In some circumstances
it may be useful to determine if a control has a value, without actually
calculating the value and incurring any performance costs.public boolean isCritical()
Control
true
if it is unacceptable to perform the operation
without applying the semantics of this control.
The criticality field only has meaning in controls attached to request
messages (except UnbindRequest). For controls attached to response
messages and the UnbindRequest, the criticality field SHOULD be
false
, and MUST be ignored by the receiving protocol peer. A
value of true
indicates that it is unacceptable to perform the
operation without applying the semantics of the control.
isCritical
in interface Control
true
if this control must be processed by the Directory
Server, or false
if it can be ignored.Copyright 2010-2022 ForgeRock AS.