@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PreReadRequestControl extends Control
PreReadResponseControl
containing a version of the entry as it before after applying that change.
Note that this response control will only be included if the operation was
successful, so it will not be provided if the operation failed for some
reason (e.g., if the change would have violated the server schema, or if the
requester did not have sufficient permission to perform that operation).
SearchRequest
. As is the case with a search
request, if no attributes are specified, then all user attributes will be
included.
PostReadRequestControl
for an example that illustrates its use.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PRE_READ_REQUEST_OID
The OID (1.3.6.1.1.13.1) for the pre-read request control.
|
Constructor and Description |
---|
PreReadRequestControl(boolean isCritical,
java.lang.String... attributes)
Creates a new pre-read request control that will retrieve the specified set
of attributes from the target entry.
|
PreReadRequestControl(Control control)
Creates a new pre-read request control which is decoded from the provided
generic control.
|
PreReadRequestControl(java.lang.String... attributes)
Creates a new pre-read request control that will retrieve the specified set
of attributes from the target entry.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String[] |
getAttributes()
Retrieves the set of attributes that will be requested for inclusion in the
entry returned in the response control.
|
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.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
@NotNull public static final java.lang.String PRE_READ_REQUEST_OID
public PreReadRequestControl(@Nullable java.lang.String... attributes)
attributes
- The set of attributes to retrieve from the target
entry. It behaves in the same way as the set of
requested attributes for a search operation. If this
is empty or null
, then all user attributes
will be returned.public PreReadRequestControl(boolean isCritical, @Nullable java.lang.String... attributes)
isCritical
- Indicates whether this control should be marked
critical.attributes
- The set of attributes to retrieve from the target
entry. It behaves in the same way as the set of
requested attributes for a search operation. If this
is empty or null
, then all user attributes
will be returned.public PreReadRequestControl(@NotNull Control control) throws LDAPException
control
- The generic control to be decoded as a pre-read request
control.LDAPException
- If the provided control cannot be decoded as a
pre-read request control.@NotNull public java.lang.String[] getAttributes()
@NotNull public java.lang.String getControlName()
getControlName
in class Control