|
|||||||||
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.NoOpRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class NoOpRequestControl
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 an implementation of the LDAP no-op control as defined in draft-zeilenga-ldap-noop. This control may be included in an add, delete, modify, or modify DN request to indicate that the server should validate the request but not actually make any changes to the data. It allows the client to verify that the operation would likely succeed (including schema validation, access control checks, and other processing) without making any changes to the server data.
ResultCode.SUCCESS
result. Instead, if the operation would likely
have completed successfully if the no-op control had not been included, then
the server will include a response with the ResultCode.NO_OPERATION
result. If the operation would not have been successful, then the result
code in the response will be the appropriate result code for that failure.
Note that if the response from the server includes the
ResultCode.NO_OPERATION
result, then the LDAP SDK will not throw an
exception but will instead return the response in an
LDAPResult
object. There is no corresponding
response control.
ModifyRequest modifyRequest = new ModifyRequest("dc=example,dc=com", new Modification(ModificationType.REPLACE, "description", "new value")); modifyRequest.addControl(new NoOpRequestControl()); try { LDAPResult result = connection.modify(modifyRequest); if (result.getResultCode() == ResultCode.NO_OPERATION) { // The modify would likely have succeeded. } else { // The modify would likely have failed. } } catch (LDAPException le) { // The modify attempt failed even with the no-op control. }
Field Summary | |
---|---|
static java.lang.String |
NO_OP_REQUEST_OID
The OID (1.3.6.1.4.1.4203.1.10.2) for the LDAP no-op request control. |
Constructor Summary | |
---|---|
NoOpRequestControl()
Creates a new no-op request control. |
|
NoOpRequestControl(Control control)
Creates a new no-op request control which is decoded from the provided generic control. |
Method Summary | |
---|---|
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 NO_OP_REQUEST_OID
Constructor Detail |
---|
public NoOpRequestControl()
public NoOpRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as a no-op request
control.
LDAPException
- If the provided control cannot be decoded as a
no-op request control.Method Detail |
---|
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 |