Class SoftDeleteResponseControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.unboundidds.controls.SoftDeleteResponseControl
-
- All Implemented Interfaces:
DecodeableControl
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SoftDeleteResponseControl extends Control implements DecodeableControl
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.
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.
This control has an OID of 1.3.6.1.4.1.30221.2.5.21, a criticality of false, and a value that is simply the string representation of the new DN for the soft-deleted entry.
See the documentation for theSoftDeleteRequestControl
class for an example demonstrating the use of this control.- See Also:
SoftDeleteRequestControl
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field 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 Summary
Constructors Constructor 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.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.-
Methods inherited from class com.unboundid.ldap.sdk.Control
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
-
-
-
-
Field Detail
-
SOFT_DELETE_RESPONSE_OID
@NotNull public static final 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.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SoftDeleteResponseControl
public SoftDeleteResponseControl(@NotNull java.lang.String softDeletedEntryDN)
Creates a new soft delete response control with the provided information.- Parameters:
softDeletedEntryDN
- The DN of the soft-deleted representation of the target entry.
-
SoftDeleteResponseControl
public SoftDeleteResponseControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
Creates a new soft delete response control with the provided information.- Parameters:
oid
- The OID for the control.isCritical
- Indicates whether the control should be considered critical.value
- The value for the control.- Throws:
LDAPException
- If the provided information cannot be used to create a valid soft delete response control.
-
-
Method Detail
-
decodeControl
@NotNull public SoftDeleteResponseControl decodeControl(@NotNull java.lang.String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
Creates a new instance of this decodeable control from the provided information.- Specified by:
decodeControl
in interfaceDecodeableControl
- Parameters:
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked critical.value
- The encoded value for the control. This may benull
if no value was provided.- Returns:
- The decoded representation of this control.
- Throws:
LDAPException
- If the provided information cannot be decoded as a valid instance of this decodeable control.
-
getSoftDeletedEntryDN
@NotNull public java.lang.String getSoftDeletedEntryDN()
Retrieves the DN of the entry containing the soft-deleted representation of the target entry.- Returns:
- The DN of the entry containing the soft-deleted representation of the target entry.
-
get
@Nullable public static SoftDeleteResponseControl get(@NotNull LDAPResult deleteResult) throws LDAPException
Extracts a soft delete response control from the provided delete result.- Parameters:
deleteResult
- The delete result from which to retrieve the soft delete response control.- Returns:
- The soft delete response control contained in the provided delete
result, or
null
if the result did not contain a soft delete response control. - Throws:
LDAPException
- If a problem is encountered while attempting to decode the soft delete response control contained in the provided result.
-
getControlName
@NotNull 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 classControl
- Returns:
- The user-friendly name for this control, or the OID if no user-friendly name is available.
-
-