|
|||||||||
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.unboundidds.controls.SoftDeletedEntryAccessRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SoftDeletedEntryAccessRequestControl
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class provides a request control which may be included in a search request to indicate that soft-deleted entries may be included in the results, or it may be included in a compare or modify request to indicate that the operation should operate against the target entry even if it is a soft-deleted entry.
TRUE
or FALSE
,
but this will only impact how the delete request is to be handled by servers
which do not support this control. A criticality of TRUE
will cause
any server which does not support this control to reject the request, while
a criticality of FALSE
should cause the request to be processed as if
the control had not been included.
SoftDeleteAccessRequestValue ::= SEQUENCE { includeNonSoftDeletedEntries [0] BOOLEAN DEFAULT TRUE, returnEntriesInUndeletedForm [1] BOOLEAN DEFAULT FALSE, ... }See the documentation for the
SoftDeleteRequestControl
class for an
example demonstrating the use of this control.
SoftDeleteResponseControl
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
SOFT_DELETED_ENTRY_ACCESS_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.24) for the soft-deleted entry access request control. |
Constructor Summary | |
---|---|
SoftDeletedEntryAccessRequestControl()
Creates a new soft-deleted entry access request control with the default settings for all elements. |
|
SoftDeletedEntryAccessRequestControl(boolean isCritical,
boolean includeNonSoftDeletedEntries,
boolean returnEntriesInUndeletedForm)
Creates a new soft delete request control with the provided information. |
|
SoftDeletedEntryAccessRequestControl(Control control)
Creates a new soft-deleted entry access request control which is decoded from the provided generic control. |
Method Summary | |
---|---|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available. |
boolean |
includeNonSoftDeletedEntries()
Indicates whether search results should include non-soft-deleted entries if they match the criteria for the associated search request. |
boolean |
returnEntriesInUndeletedForm()
Indicates whether soft-deleted entries returned in search results should be returned in the form in which they would appear if they were undeleted. |
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 SOFT_DELETED_ENTRY_ACCESS_REQUEST_OID
Constructor Detail |
---|
public SoftDeletedEntryAccessRequestControl()
public SoftDeletedEntryAccessRequestControl(boolean isCritical, boolean includeNonSoftDeletedEntries, boolean returnEntriesInUndeletedForm)
isCritical
- Indicates whether this control should
be marked critical. This will only
have an effect on the way the
associated delete operation is
handled by servers which do NOT
support the soft-deleted entry access
request control. For such servers, a
control that is critical will cause
associated request to be rejected,
while a control that is not critical
will be processed as if the control
was not included in the request.includeNonSoftDeletedEntries
- Indicates whether search results
should include non-soft-deleted
entries if they match the criteria
for the associated search request.returnEntriesInUndeletedForm
- Indicates whether soft-deleted
entries returned in search results
should be returned in the form in
which they would appear if they were
undeleted. Note that if soft-deleted
entries should be returned in their
undeleted form, then it may be
possible for multiple entries to be
returned with the same DN (if
multiple soft-deleted entries with
the same original DN match the
criteria, or if at least one
soft-deleted entry and one normal
entry with the same DN both match the
search criteria).public SoftDeletedEntryAccessRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as a soft-deleted entry
access request control.
LDAPException
- If the provided control cannot be decoded as a
soft-deleted entry access request control.Method Detail |
---|
public boolean includeNonSoftDeletedEntries()
true
if the server should return any "normal"
non-soft-deleted entries that match the search criteria, or
false
if the server should only return soft-deleted
entries that match the search criteria.public boolean returnEntriesInUndeletedForm()
false
if soft-deleted entries should be returned in their
current form as soft-deleted entries, or true
if they
should be returned in the form in which they would appear if they
were undeleted (e.g., using the original DN for the entry and
without all the additional meta-attributes added during the
soft delete process).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 |