Package com.unboundid.ldap.sdk.unboundidds

Class SoftDeletedEntry

java.lang.Object
com.unboundid.ldap.sdk.Entry
com.unboundid.ldap.sdk.ReadOnlyEntry
com.unboundid.ldap.sdk.unboundidds.SoftDeletedEntry
All Implemented Interfaces:
LDIFRecord, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SoftDeletedEntry extends ReadOnlyEntry
This class provides a data structure for representing information about a soft-deleted entry, which results from a soft delete operation that has caused the entry to be hidden so that it is not accessible to clients under normal circumstances, rather than causing the entry to be completely removed from the server.
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.

A soft-deleted entry will have its RDN altered to include the entryUUID for the original entry, will be updated to include the "ds-soft-delete-entry" auxiliary object class, and will have additional metadata attributes added to it which may include:
  • ds-soft-delete-from-dn -- This specifies the DN assigned to the entry before it was converted to a soft-deleted entry.
  • ds-soft-delete-timestamp -- This specifies the time that the entry was converted to a soft-deleted entry.
  • ds-soft-delete-requester-dn -- This specifies the DN of the user who requested the soft delete operation.
  • ds-soft-delete-requester-ip-address -- This specifies the IP address of the client that requested the soft delete operation.


Soft-deleted entries may only be retrieved by users who have the soft-delete-read privilege, and then only by clients who issue a search request with one or more of the following characteristics:
  • The search operation has a scope of baseObject and a base DN which specifically targets a soft-deleted entry.
  • The search operation includes a filter with a component that will specifically match entries that have the ds-soft-delete-entry object class (e.g., "(objectClass=ds-soft-delete-entry)").
  • The search operation includes a SoftDeletedEntryAccessRequestControl.
See Also:

  • Field Details

  • Constructor Details

    • SoftDeletedEntry

      public SoftDeletedEntry(@NotNull Entry entry) throws LDAPException
      Creates a soft-deleted entry from the provided entry.
      Parameters:
      entry - The entry to be processed as a soft-deleted entry. It must not be null.
      Throws:
      LDAPException - If the provided entry does not represent a valid soft-deleted entry.

  • Method Details

    • getSoftDeleteFromDN

      @NotNull public String getSoftDeleteFromDN()
      Retrieves the DN held by the entry at the time it was converted to a soft-deleted entry.
      Returns:
      The DN held by the entry at the time it was converted to a soft-deleted entry.

    • getSoftDeleteTimestamp

      @Nullable public Date getSoftDeleteTimestamp()
      Retrieves the time that the entry was converted to a soft-deleted entry, if available.
      Returns:
      The time that the entry was converted to a soft-deleted entry, or null if this is not available in the entry.

    • getSoftDeleteRequesterDN

      @Nullable public String getSoftDeleteRequesterDN()
      Retrieves the DN of the user that requested the soft delete operation, if available.
      Returns:
      The DN of the user that requested the soft delete operation, or null if this is not available in the entry.

    • getSoftDeleteRequesterIPAddress

      @Nullable public String getSoftDeleteRequesterIPAddress()
      Retrieves the IP address of the client that requested the soft delete operation, if available.
      Returns:
      The IP address of the client that requested the soft delete operation, or null if this is not available in the entry.

    • getUndeletedEntry

      @NotNull public ReadOnlyEntry getUndeletedEntry()
      Retrieves a copy of the original entry as it appeared before the soft delete operation was processed. It will have its original DN and all soft delete metadata attributes and auxiliary object class removed.
      Returns:
      A copy of the original entry as it appeared before the soft delete operation was processed.

    • isSoftDeletedEntry

      public static boolean isSoftDeletedEntry(@NotNull Entry entry)
      Indicates whether the provided entry may be parsed as a valid soft-deleted entry.
      Parameters:
      entry - The entry to be examined. It must not be null.
      Returns:
      true if the provided entry contains at least a ds-soft-delete-entry object class and a ds-soft-delete-from-dn attribute.