|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Entry
com.unboundid.ldap.sdk.ReadOnlyEntry
com.unboundid.ldap.sdk.unboundidds.SoftDeletedEntry
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SoftDeletedEntry
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.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. 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:
SoftDeletedEntryAccessRequestControl
.
Field Summary | |
---|---|
static java.lang.String |
ATTR_SOFT_DELETE_FROM_DN
The name of the attribute that will be included in a soft-deleted entry to indicate the original DN the entry held before it was converted to a soft-deleted entry. |
static java.lang.String |
ATTR_SOFT_DELETE_REQUESTER_DN
The name of the attribute that will be included in a soft-deleted entry to indicate the DN of the user that requested the soft delete operation. |
static java.lang.String |
ATTR_SOFT_DELETE_REQUESTER_IP_ADDRESS
The name of the attribute that will be included in a soft-deleted entry to indicate the IP address of the client that requested the soft delete operation. |
static java.lang.String |
ATTR_SOFT_DELETE_TIMESTAMP
The name of the attribute that will be included in a soft-deleted entry to indicate the time it was converted to a soft-deleted entry. |
static java.lang.String |
OC_SOFT_DELETED_ENTRY
The name of the auxiliary object class that will be used to mark soft-deleted entries. |
Constructor Summary | |
---|---|
SoftDeletedEntry(Entry entry)
Creates a soft-deleted entry from the provided entry. |
Method Summary | |
---|---|
java.lang.String |
getSoftDeleteFromDN()
Retrieves the DN held by the entry at the time it was converted to a soft-deleted entry. |
java.lang.String |
getSoftDeleteRequesterDN()
Retrieves the DN of the user that requested the soft delete operation, if available. |
java.lang.String |
getSoftDeleteRequesterIPAddress()
Retrieves the IP address of the client that requested the soft delete operation, if available. |
java.util.Date |
getSoftDeleteTimestamp()
Retrieves the time that the entry was converted to a soft-deleted entry, if available. |
ReadOnlyEntry |
getUndeletedEntry()
Retrieves a copy of the original entry as it appeared before the soft delete operation was processed. |
static boolean |
isSoftDeletedEntry(Entry entry)
Indicates whether the provided entry may be parsed as a valid soft-deleted entry. |
Methods inherited from class com.unboundid.ldap.sdk.ReadOnlyEntry |
---|
addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeAttributeValues, removeAttributeValues, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setDN, setDN |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ATTR_SOFT_DELETE_FROM_DN
public static final java.lang.String ATTR_SOFT_DELETE_REQUESTER_DN
public static final java.lang.String ATTR_SOFT_DELETE_REQUESTER_IP_ADDRESS
public static final java.lang.String ATTR_SOFT_DELETE_TIMESTAMP
public static final java.lang.String OC_SOFT_DELETED_ENTRY
Constructor Detail |
---|
public SoftDeletedEntry(Entry entry) throws LDAPException
entry
- The entry to be processed as a soft-deleted entry. It must
not be null
.
LDAPException
- If the provided entry does not represent a valid
soft-deleted entry.Method Detail |
---|
public java.lang.String getSoftDeleteFromDN()
public java.util.Date getSoftDeleteTimestamp()
null
if this is not available in the entry.public java.lang.String getSoftDeleteRequesterDN()
null
if this is not available in the entry.public java.lang.String getSoftDeleteRequesterIPAddress()
null
if this is not available in the entry.public ReadOnlyEntry getUndeletedEntry()
public static boolean isSoftDeletedEntry(Entry entry)
entry
- The entry to be examined. It must not be null
.
true
if the provided entry contains at least a
ds-soft-delete-entry object class and a ds-soft-delete-from-dn
attribute.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |