|
|||||||||
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.HardDeleteRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class HardDeleteRequestControl
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 request control which may be included in a delete request to indicate that the server should completely remove the target entry, even if it would otherwise process the operation as a soft delete and merely hide the entry from most clients.
TRUE
or FALSE
,
but this will only impact how the delete request is to be handled by servers
which do not support this control. A criticality of TRUE
will cause
any server which does not support this control to reject the request, while
a criticality of FALSE
should cause the delete request to be
processed as if the control had not been included (i.e., as a regular "hard"
delete).
HardDeleteRequestValue ::= SEQUENCE { ... }In the future, the value sequence may allow one or more elements to customize the behavior of the hard delete operation, but at present no such elements are defined. See the documentation for the
SoftDeleteRequestControl
class for an
example demonstrating the use of this control.
SoftDeleteRequestControl
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
HARD_DELETE_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.5.22) for the hard delete request control. |
Constructor Summary | |
---|---|
HardDeleteRequestControl()
Creates a new hard delete request control. |
|
HardDeleteRequestControl(boolean isCritical)
Creates a new hard delete request control with the provided information. |
|
HardDeleteRequestControl(Control control)
Creates a new hard delete request control which is decoded from the provided generic control. |
Method Summary | |
---|---|
static DeleteRequest |
createHardDeleteRequest(java.lang.String targetDN,
boolean isCritical)
Creates a new delete request that may be used to hard delete the specified target entry. |
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available. |
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 HARD_DELETE_REQUEST_OID
Constructor Detail |
---|
public HardDeleteRequestControl()
public HardDeleteRequestControl(boolean isCritical)
isCritical
- Indicates whether this control should be marked
critical. This will only have an effect on the way the
associated delete operation is handled by servers which
do NOT support the hard delete request control. For
such servers, a control that is critical will cause the
hard delete attempt to fail, while a control that is
not critical will be processed as if the control was
not included in the request (i.e., as a normal "hard"
delete).public HardDeleteRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as a hard delete request
control.
LDAPException
- If the provided control cannot be decoded as a hard
delete request control.Method Detail |
---|
public static DeleteRequest createHardDeleteRequest(java.lang.String targetDN, boolean isCritical)
targetDN
- The DN of the entry to be hard deleted.isCritical
- Indicates whether this control should be marked
critical. This will only have an effect on the way the
associated delete operation is handled by servers which
do NOT support the hard delete request control. For
such servers, a control that is critical will cause the
hard delete attempt to fail, while a control that is
not critical will be processed as if the control was
not included in the request (i.e., as a normal "hard"
delete).
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 |