com.unboundid.ldap.sdk.unboundidds.controls
Class SoftDeletedEntryAccessRequestControl

java.lang.Object
  extended by com.unboundid.ldap.sdk.Control
      extended by com.unboundid.ldap.sdk.unboundidds.controls.SoftDeletedEntryAccessRequestControl
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class SoftDeletedEntryAccessRequestControl
extends Control

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.

The criticality for this control may be either 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.

The control may optionally have a value. If a value is provided, then it must be the encoded representation of the following ASN.1 element:
   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.

See Also:
SoftDeleteResponseControl, Serialized Form

Field 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

SOFT_DELETED_ENTRY_ACCESS_REQUEST_OID

public static final 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.

See Also:
Constant Field Values
Constructor Detail

SoftDeletedEntryAccessRequestControl

public SoftDeletedEntryAccessRequestControl()
Creates a new soft-deleted entry access request control with the default settings for all elements. It will not be marked critical.


SoftDeletedEntryAccessRequestControl

public SoftDeletedEntryAccessRequestControl(boolean isCritical,
                                            boolean includeNonSoftDeletedEntries,
                                            boolean returnEntriesInUndeletedForm)
Creates a new soft delete request control with the provided information.

Parameters:
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).

SoftDeletedEntryAccessRequestControl

public SoftDeletedEntryAccessRequestControl(Control control)
                                     throws LDAPException
Creates a new soft-deleted entry access request control which is decoded from the provided generic control.

Parameters:
control - The generic control to be decoded as a soft-deleted entry access request control.
Throws:
LDAPException - If the provided control cannot be decoded as a soft-deleted entry access request control.
Method Detail

includeNonSoftDeletedEntries

public boolean includeNonSoftDeletedEntries()
Indicates whether search results should include non-soft-deleted entries if they match the criteria for the associated search request.

Returns:
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.

returnEntriesInUndeletedForm

public 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. 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).

Returns:
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).

getControlName

public java.lang.String getControlName()
Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.

Overrides:
getControlName in class Control
Returns:
The user-friendly name for this control, or the OID if no user-friendly name is available.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided buffer.

Overrides:
toString in class Control
Parameters:
buffer - The buffer to which to append the string representation of this buffer.