|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.SoftDeleteResponseControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SoftDeleteResponseControl
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 response control that holds information about the soft-deleted entry that results from a soft delete request, and may also be included in a search result entry which represents a soft-deleted entry. The value of this control will be the DN of the soft-deleted entry.
SoftDeleteRequestControl
class for an
example demonstrating the use of this control.
SoftDeleteRequestControl
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
SOFT_DELETE_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.5.21) for the soft delete response control. |
Constructor Summary | |
---|---|
SoftDeleteResponseControl(java.lang.String softDeletedEntryDN)
Creates a new soft delete response control with the provided information. |
|
SoftDeleteResponseControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new soft delete response control with the provided information. |
Method Summary | |
---|---|
SoftDeleteResponseControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided information. |
static SoftDeleteResponseControl |
get(LDAPResult deleteResult)
Extracts a soft delete response control from the provided delete result. |
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available. |
java.lang.String |
getSoftDeletedEntryDN()
Retrieves the DN of the entry containing the soft-deleted representation of the target entry. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.Control |
---|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SOFT_DELETE_RESPONSE_OID
Constructor Detail |
---|
public SoftDeleteResponseControl(java.lang.String softDeletedEntryDN)
softDeletedEntryDN
- The DN of the soft-deleted representation of
the target entry.public SoftDeleteResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
oid
- The OID for the control.isCritical
- Indicates whether the control should be considered
critical.value
- The value for the control.
LDAPException
- If the provided information cannot be used to
create a valid soft delete response control.Method Detail |
---|
public SoftDeleteResponseControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.
LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.public java.lang.String getSoftDeletedEntryDN()
public static SoftDeleteResponseControl get(LDAPResult deleteResult) throws LDAPException
deleteResult
- The delete result from which to retrieve the soft
delete response control.
null
if the result did not contain a soft
delete response control.
LDAPException
- If a problem is encountered while attempting to
decode the soft delete response control contained
in the provided result.public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |