|
|||||||||
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.PreReadRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class PreReadRequestControl
This class provides an implementation of the LDAP pre-read request control
as defined in RFC 4527. It
may be used to request that the server retrieve a copy of the target entry as
it appeared immediately before processing a delete, modify, or modify DN
operation.
If this control is included in a delete, modify, or modify DN request, then
the corresponding response may include a 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).
The value of this control should contain a set of requested attributes to
include in the entry that is returned. The server should treat this set of
requested attributes exactly as it treats the requested attributes from a
SearchRequest
. As is the case with a search
request, if no attributes are specified, then all user attributes will be
included.
The use of the LDAP pre-read request control is virtually identical to the
use of the LDAP post-read request control. See the documentation for the
PostReadRequestControl
for an example that illustrates its use.
Field Summary | |
---|---|
static java.lang.String |
PRE_READ_REQUEST_OID
The OID (1.3.6.1.1.13.1) for the pre-read request control. |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
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. |
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_REQUEST_OID
Constructor Detail |
---|
public PreReadRequestControl(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, 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(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.Method Detail |
---|
public java.lang.String[] getAttributes()
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 |