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

Class SoftDeleteRequestControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.SoftDeleteRequestControl
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SoftDeleteRequestControl extends Control
This class provides a request control which may be included in a delete request to indicate that the server should perform a soft delete rather than a hard delete. A soft delete will leave the entry in the server, but will mark it hidden so that it can only be retrieved with a special request (e.g., one which includes the SoftDeletedEntryAccessRequestControl or a filter which includes an "(objectClass=ds-soft-deleted-entry)" component). A soft-deleted entry may later be undeleted (using an add request containing the UndeleteRequestControl) in order to restore them with the same or a different DN.
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 delete request to be processed as if the control had not been included (i.e., as a regular "hard" delete).

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: 
   SoftDeleteRequestValue ::= SEQUENCE {
     returnSoftDeleteResponse     [0] BOOLEAN DEFAULT TRUE,
     ... }


Example

The following example demonstrates the use of the soft delete request control to remove the "uid=test,dc=example,dc=com" user with a soft delete operation, and then to recover it with an undelete operation: 
 // Perform a search to verify that the test entry exists.
 SearchRequest searchRequest = new SearchRequest("dc=example,dc=com",
      SearchScope.SUB, Filter.createEqualityFilter("uid", "test"));
 SearchResult searchResult = connection.search(searchRequest);
 LDAPTestUtils.assertEntriesReturnedEquals(searchResult, 1);
 String originalDN = searchResult.getSearchEntries().get(0).getDN();

 // Perform a soft delete against the entry.
 DeleteRequest softDeleteRequest = new DeleteRequest(originalDN);
 softDeleteRequest.addControl(new SoftDeleteRequestControl());
 LDAPResult softDeleteResult = connection.delete(softDeleteRequest);

 // Verify that a soft delete response control was included in the result.
 SoftDeleteResponseControl softDeleteResponseControl =
      SoftDeleteResponseControl.get(softDeleteResult);
 String softDeletedDN = softDeleteResponseControl.getSoftDeletedEntryDN();

 // Verify that the original entry no longer exists.
 LDAPTestUtils.assertEntryMissing(connection, originalDN);

 // Verify that the original search no longer returns any entries.
 searchResult = connection.search(searchRequest);
 LDAPTestUtils.assertNoEntriesReturned(searchResult);

 // Verify that the search will return an entry if we include the
 // soft-deleted entry access control in the request.
 searchRequest.addControl(new SoftDeletedEntryAccessRequestControl());
 searchResult = connection.search(searchRequest);
 LDAPTestUtils.assertEntriesReturnedEquals(searchResult, 1);

 // Perform an undelete operation to restore the entry.
 AddRequest undeleteRequest = UndeleteRequestControl.createUndeleteRequest(
      originalDN, softDeletedDN);
 LDAPResult undeleteResult = connection.add(undeleteRequest);

 // Verify that the original entry is back.
 LDAPTestUtils.assertEntryExists(connection, originalDN);

 // Permanently remove the original entry with a hard delete.
 DeleteRequest hardDeleteRequest = new DeleteRequest(originalDN);
 hardDeleteRequest.addControl(new HardDeleteRequestControl());
 LDAPResult hardDeleteResult = connection.delete(hardDeleteRequest);
Note that this class provides convenience methods that can be used to easily create a delete request containing an appropriate soft delete request control. Similar methods can be found in the HardDeleteRequestControl and UndeleteRequestControl classes for creating appropriate hard delete and undelete requests, respectively.
See Also:

  • Field Details

  • Constructor Details

    • SoftDeleteRequestControl

      public SoftDeleteRequestControl()
      Creates a new soft delete request control with the default settings for all elements. It will be marked critical.

    • SoftDeleteRequestControl

      public SoftDeleteRequestControl(boolean isCritical, boolean returnSoftDeleteResponse)
      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 delete request control. For such servers, a control that is critical will cause the soft delete attempt to fail, while a control that is not critical will be processed as if the control was not included in the request (i.e., as a normal "hard" delete).
      returnSoftDeleteResponse - Indicates whether to return a soft delete response control in the delete response to the client.

    • SoftDeleteRequestControl

      public SoftDeleteRequestControl(@NotNull Control control) throws LDAPException
      Creates a new soft delete request control which is decoded from the provided generic control.
      Parameters:
      control - The generic control to be decoded as a soft delete request control.
      Throws:
      LDAPException - If the provided control cannot be decoded as a soft delete request control.

  • Method Details

    • returnSoftDeleteResponse

      public boolean returnSoftDeleteResponse()
      Indicates whether the delete response should include a SoftDeleteResponseControl.
      Returns:
      true if the delete response should include a soft delete response control, or false if not.

    • createSoftDeleteRequest

      @NotNull public static DeleteRequest createSoftDeleteRequest(@NotNull String targetDN, boolean isCritical, boolean returnSoftDeleteResponse)
      Creates a new delete request that may be used to soft delete the specified target entry.
      Parameters:
      targetDN - The DN of the entry to be soft deleted.
      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 delete request control. For such servers, a control that is critical will cause the soft delete attempt to fail, while a control that is not critical will be processed as if the control was not included in the request (i.e., as a normal "hard" delete).
      returnSoftDeleteResponse - Indicates whether to return a soft delete response control in the delete response to the client.
      Returns:
      A delete request with the specified target DN and an appropriate soft delete request control.

    • 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 delete 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 delete request control, the OID is "1.3.6.1.4.1.30221.2.5.20".
      • 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 delete 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 delete 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:
        • return-soft-delete-response-control -- A mandatory Boolean field that indicates whether to include a corresponding soft delete response control in the delete result.
      Overrides:
      toJSONControl in class Control
      Returns:
      A JSON object that contains a representation of this control.

    • decodeJSONControl

      @NotNull public static SoftDeleteRequestControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
      Attempts to decode the provided object as a JSON representation of a soft delete 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 delete request control that was decoded from the provided JSON object.
      Throws:
      LDAPException - If the provided JSON object cannot be parsed as a valid soft delete request control.

    • 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.