|
|||||||||
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.experimental.DraftZeilengaLDAPNoOp12RequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class DraftZeilengaLDAPNoOp12RequestControl
This class provides an implementation of the LDAP no-op control as defined in
draft-zeilenga-ldap-noop-12. 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.
Note that an operation which includes the no-op control will never have a
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.
Note that at the time this control was written, the latest version of the
specification may be found in draft-zeilenga-ldap-noop-11. This version of
the document does not explicitly specify either the OID that should be used
for the control, or the result code that should be used for the associated
operation if all other processing is completed successfully but no changes
are made as a result of this control. Until such time as these are defined,
this implementation uses the OID temporarily assigned for its use by the
OpenLDAP Foundation, which is used by at least the OpenLDAP, OpenDS, and the
UnboundID Directory Server implementations.
ModifyRequest modifyRequest = new ModifyRequest("dc=example,dc=com", new Modification(ModificationType.REPLACE, "description", "new value")); modifyRequest.addControl(new DraftZeilengaLDAPNoOp12RequestControl()); try { LDAPResult result = connection.modify(modifyRequest); if (result.getResultCode() == ResultCode.NO_OPERATION) { // The modification would likely have succeeded if the no-op control // hadn't been included in the request. } else { // The modification would likely have failed if the no-op control // hadn't been included in the request. } } catch (LDAPException le) { // The modification failed even with the no-op control in the request. }
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 | |
---|---|
DraftZeilengaLDAPNoOp12RequestControl()
Creates a new no-op request control. |
|
DraftZeilengaLDAPNoOp12RequestControl(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 DraftZeilengaLDAPNoOp12RequestControl()
public DraftZeilengaLDAPNoOp12RequestControl(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 |