Package com.unboundid.ldap.sdk.unboundidds.controls

Class SoftDeletedEntryAccessRequestControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.SoftDeletedEntryAccessRequestControl
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SoftDeletedEntryAccessRequestControl extends Control
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.
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.

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:

  • Field Details

  • Constructor Details

    • 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(@NotNull 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 Details

    • 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

      @NotNull public 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.

    • toJSONControl

      @NotNull public JSONObject toJSONControl()
      Retrieves a representation of this soft-deleted entry access request control as a JSON object. The JSON object uses the following fields:
      • oid -- A mandatory string field whose value is the object identifier for this control. For the soft-deleted entry access request control, the OID is "1.3.6.1.4.1.30221.2.5.24".
      • control-name -- An optional string field whose value is a human-readable name for this control. This field is only intended for descriptive purposes, and when decoding a control, the oid field should be used to identify the type of control.
      • criticality -- A mandatory Boolean field used to indicate whether this control is considered critical.
      • value-base64 -- An optional string field whose value is a base64-encoded representation of the raw value for this soft-deleted entry access request control. Exactly one of the value-base64 and value-json fields must be present.
      • value-json -- An optional JSON object field whose value is a user-friendly representation of the value for this soft-deleted entry access request control. Exactly one of the value-base64 and value-json fields must be present, and if the value-json field is used, then it will use the following fields:
        • include-non-soft-deleted-entries -- A mandatory Boolean field that indicates whether the server should also return any non-soft-deleted entries in the search results.
        • return-entries-in-undeleted-form -- A mandatory Boolean field that indicates whether soft-deleted entries should be returned in the form in which they appeared before they were soft-deleted.
      Overrides:
      toJSONControl in class Control
      Returns:
      A JSON object that contains a representation of this control.

    • decodeJSONControl

      @NotNull public static SoftDeletedEntryAccessRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
      Attempts to decode the provided object as a JSON representation of a soft-deleted entry access request control.
      Parameters:
      controlObject - The JSON object to be decoded. It must not be null.
      strict - Indicates whether to use strict mode when decoding the provided JSON object. If this is true, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this is false, then unrecognized fields will be ignored.
      Returns:
      The soft-deleted entry access request that was decoded from the provided JSON object.
      Throws:
      LDAPException - If the provided JSON object cannot be parsed as a valid soft-deleted entry access request.

    • toString

      public void toString(@NotNull 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.