Class UndeleteRequestControl

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class UndeleteRequestControl
    extends Control
    This class provides a request control which may be included in an add request to indicate that the contents of the resulting entry should come not from the data of the add request itself but instead from a soft-deleted entry. This can be used to recover an entry that was previously removed by a delete request containing the SoftDeleteRequestControl.
    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 should always be TRUE. The criticality will have no effect on servers that do support this control, but a criticality of TRUE will ensure that a server which does not support soft deletes does not attempt to process the add request. If the criticality were FALSE, then any server that does not support the control would simply ignore it and attempt to add the entry specified in the add request (which will have details about the undelete to be processed).

    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:
       UndeleteRequestValue ::= SEQUENCE {
         ... }
     
    In the future, the value sequence may allow one or more elements to customize the behavior of the undelete 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:
    HardDeleteRequestControl, SoftDeleteRequestControl, Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ATTR_CHANGES
      The name of the optional attribute used to specify a set of changes to apply to the soft-deleted entry during the course of the undelete.
      static java.lang.String ATTR_DISABLE_ACCOUNT
      The name of the optional attribute used to indicate whether the newly-undeleted user account should be disabled and prevented from authenticating.
      static java.lang.String ATTR_MUST_CHANGE_PASSWORD
      The name of the optional attribute used to indicate whether the newly-undeleted user will be required to change his/her password immediately after authenticating and before being required to request any other operations.
      static java.lang.String ATTR_NEW_PASSWORD
      The name of the optional attribute used to specify the new password for use in the newly-undeleted entry.
      static java.lang.String ATTR_OLD_PASSWORD
      The name of the optional attribute used to specify the password currently contained in the soft-deleted entry, to be validated as part of the undelete process.
      static java.lang.String ATTR_SOFT_DELETED_ENTRY_DN
      The name of the required attribute used to specify the DN of the soft-deleted entry to be undeleted.
      static java.lang.String UNDELETE_REQUEST_OID
      The OID (1.3.6.1.4.1.30221.2.5.23) for the undelete request control.
    • Constructor Summary

      Constructors 
      Constructor Description
      UndeleteRequestControl()
      Creates a undelete request control with a criticality of TRUE and no value.
      UndeleteRequestControl​(Control control)
      Creates a new undelete request control which is decoded from the provided generic control.
    • Field Detail

      • ATTR_CHANGES

        public static final java.lang.String ATTR_CHANGES
        The name of the optional attribute used to specify a set of changes to apply to the soft-deleted entry during the course of the undelete.
        See Also:
        Constant Field Values
      • ATTR_DISABLE_ACCOUNT

        public static final java.lang.String ATTR_DISABLE_ACCOUNT
        The name of the optional attribute used to indicate whether the newly-undeleted user account should be disabled and prevented from authenticating.
        See Also:
        Constant Field Values
      • ATTR_MUST_CHANGE_PASSWORD

        public static final java.lang.String ATTR_MUST_CHANGE_PASSWORD
        The name of the optional attribute used to indicate whether the newly-undeleted user will be required to change his/her password immediately after authenticating and before being required to request any other operations.
        See Also:
        Constant Field Values
      • ATTR_NEW_PASSWORD

        public static final java.lang.String ATTR_NEW_PASSWORD
        The name of the optional attribute used to specify the new password for use in the newly-undeleted entry.
        See Also:
        Constant Field Values
      • ATTR_OLD_PASSWORD

        public static final java.lang.String ATTR_OLD_PASSWORD
        The name of the optional attribute used to specify the password currently contained in the soft-deleted entry, to be validated as part of the undelete process.
        See Also:
        Constant Field Values
    • Constructor Detail

      • UndeleteRequestControl

        public UndeleteRequestControl()
        Creates a undelete request control with a criticality of TRUE and no value.
      • UndeleteRequestControl

        public UndeleteRequestControl​(Control control)
                               throws LDAPException
        Creates a new undelete request control which is decoded from the provided generic control.
        Parameters:
        control - The generic control to be decoded as an undelete request control.
        Throws:
        LDAPException - If the provided control cannot be decoded as an undelete request control.
    • Method Detail

      • createUndeleteRequest

        public static AddRequest createUndeleteRequest​(java.lang.String targetDN,
                                                       java.lang.String softDeletedEntryDN)
        Creates a new undelete request that may be used to recover the specified soft-deleted entry.
        Parameters:
        targetDN - The DN to use for the entry recovered from the soft-deleted entry contents. It must not be null.
        softDeletedEntryDN - The DN of the soft-deleted entry to be used in the restore process. It must not be null.
        Returns:
        An add request with an appropriate set of content
      • createUndeleteRequest

        public static AddRequest createUndeleteRequest​(java.lang.String targetDN,
                                                       java.lang.String softDeletedEntryDN,
                                                       java.util.List<Modification> changes,
                                                       java.lang.String oldPassword,
                                                       java.lang.String newPassword,
                                                       java.lang.Boolean mustChangePassword,
                                                       java.lang.Boolean disableAccount)
        Creates a new undelete request that may be used to recover the specified soft-deleted entry.
        Parameters:
        targetDN - The DN to use for the entry recovered from the soft-deleted entry contents. It must not be null.
        softDeletedEntryDN - The DN of the soft-deleted entry to be used in the restore process. It must not be null.
        changes - An optional set of changes that should be applied to the entry during the course of undelete processing. It may be null or empty if this element should be omitted from the resulting add request.
        oldPassword - An optional copy of the password currently contained in the soft-deleted entry to be recovered. If this is non-null, then this password will be required to match that contained in the target entry for the undelete to succeed.
        newPassword - An optional new password to set for the user as part of the undelete processing. It may be null if no new password should be provided.
        mustChangePassword - Indicates whether the recovered user will be required to change his/her password before being allowed to request any other operations. It may be null if this should be omitted from the resulting add request.
        disableAccount - Indicates whether the undeleted entry should be made disabled so that it cannot be used to authenticate. It may be null if this should be omitted from the resulting add request.
        Returns:
        An add request with an appropriate set of content
      • 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.