@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SoftDeletedEntryAccessRequestControl extends Control
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only
supported for use against Ping Identity, UnboundID, and
Nokia/Alcatel-Lucent 8661 server products. These classes provide support
for proprietary functionality or for external specifications that are not
considered stable or mature enough to be guaranteed to work in an
interoperable way with other types of LDAP servers.
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 FormModifier and Type | Field and Description |
---|---|
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 and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
@NotNull public static final java.lang.String SOFT_DELETED_ENTRY_ACCESS_REQUEST_OID
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(@NotNull 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.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).@NotNull public java.lang.String getControlName()
getControlName
in class Control