@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SoftDeleteResponseControl extends Control implements DecodeableControl
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.
SoftDeleteRequestControl
class for an
example demonstrating the use of this control.SoftDeleteRequestControl
,
Serialized FormModifier and Type | Field and Description |
---|---|
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 and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
@NotNull public static final java.lang.String SOFT_DELETE_RESPONSE_OID
public SoftDeleteResponseControl(@NotNull java.lang.String softDeletedEntryDN)
softDeletedEntryDN
- The DN of the soft-deleted representation of
the target entry.public SoftDeleteResponseControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable 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.@NotNull public SoftDeleteResponseControl decodeControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable 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.@NotNull public java.lang.String getSoftDeletedEntryDN()
@Nullable public static SoftDeleteResponseControl get(@NotNull 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.@NotNull public java.lang.String getControlName()
getControlName
in class Control