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

Class HardDeleteRequestControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.HardDeleteRequestControl
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class HardDeleteRequestControl extends Control
This class provides a request control which may be included in a delete request to indicate that the server should completely remove the target entry, even if it would otherwise process the operation as a soft delete and merely hide the entry from most clients.
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 an empty ASN.1 sequence, like: 
   HardDeleteRequestValue ::= SEQUENCE {
     ... }
In the future, the value sequence may allow one or more elements to customize the behavior of the hard delete operation, but at present no such elements are defined. See the documentation for the SoftDeleteRequestControl class for an example demonstrating the use of this control.
See Also:

  • Field Details

  • Constructor Details

    • HardDeleteRequestControl

      public HardDeleteRequestControl()
      Creates a new hard delete request control. It will not be marked critical.

    • HardDeleteRequestControl

      public HardDeleteRequestControl(boolean isCritical)
      Creates a new hard 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 hard delete request control. For such servers, a control that is critical will cause the hard 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).

    • HardDeleteRequestControl

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

  • Method Details

    • createHardDeleteRequest

      @NotNull public static DeleteRequest createHardDeleteRequest(@NotNull String targetDN, boolean isCritical)
      Creates a new delete request that may be used to hard delete the specified target entry.
      Parameters:
      targetDN - The DN of the entry to be hard 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 hard delete request control. For such servers, a control that is critical will cause the hard 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).
      Returns:
      A delete request with the specified target DN and an appropriate hard 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 hard delete request control as a JSON object. The JSON object uses the following fields (note that since this control does not have a value, neither the value-base64 nor value-json fields may be present):
      • oid -- A mandatory string field whose value is the object identifier for this control. For the hard delete request control, the OID is "1.3.6.1.4.1.30221.2.5.22".
      • 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.
      Overrides:
      toJSONControl in class Control
      Returns:
      A JSON object that contains a representation of this control.

    • decodeJSONControl

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