@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class NoOpRequestControl extends Control
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.
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. }
Modifier and Type | Field and Description |
---|---|
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 and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
@NotNull public static final java.lang.String NO_OP_REQUEST_OID
public NoOpRequestControl()
public NoOpRequestControl(@NotNull 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.@NotNull public java.lang.String getControlName()
getControlName
in class Control