com.unboundid.ldap.sdk.unboundidds.controls

Class NoOpRequestControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.unboundidds.controls.NoOpRequestControl

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class NoOpRequestControl
extends Control

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.

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.

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 Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory Server implementations.

This control has an OID of 1.3.6.1.4.1.4203.1.10.2 and a criticality of true. It does not have a value.

Example

The following example demonstrates the process for attempting to perform a modify operation including the LDAP no-op control so that the change is not actually applied:

 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.
 }
 

See Also:

Serialized Form

Field Summary

Fields

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 Summary

Constructors

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.

Method Summary

Modifier and Type	Method and Description
static NoOpRequestControl	decodeJSONControl(JSONObject controlObject, boolean strict) Attempts to decode the provided object as a JSON representation of a no-op request control.
java.lang.String	getControlName() Retrieves the user-friendly name for this control, if available.
JSONObject	toJSONControl() Retrieves a representation of this no-op request control as a JSON object.
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, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_OP_REQUEST_OID

@NotNull
public static final 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.

See Also:

Constant Field Values

Constructor Detail

NoOpRequestControl

public NoOpRequestControl()

Creates a new no-op request control. It will be marked critical, as required by the control specification.

NoOpRequestControl

public NoOpRequestControl(@NotNull
                          Control control)
                   throws LDAPException

Creates a new no-op request control which is decoded from the provided generic control.

Parameters:

control - The generic control to be decoded as a no-op request control.

Throws:

LDAPException - If the provided control cannot be decoded as a no-op request control.

Method Detail

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 class Control

Returns:

The user-friendly name for this control, or the OID if no user-friendly name is available.

toJSONControl

@NotNull
public JSONObject toJSONControl()

Retrieves a representation of this no-op request control as a JSON object. The JSON object uses the following fields (note that since this control does not have a value, neither the value-base64 nor value-json fields may be present):

• oid -- A mandatory string field whose value is the object identifier for this control. For the no-op request control, the OID is "1.3.6.1.4.1.4203.1.10.2".
• control-name -- An optional string field whose value is a human-readable name for this control. This field is only intended for descriptive purposes, and when decoding a control, the oid field should be used to identify the type of control.
• criticality -- A mandatory Boolean field used to indicate whether this control is considered critical.

Overrides:

toJSONControl in class Control

Returns:

A JSON object that contains a representation of this control.

decodeJSONControl

@NotNull
public static NoOpRequestControl decodeJSONControl(@NotNull
                                                            JSONObject controlObject,
                                                            boolean strict)
                                                     throws LDAPException

Attempts to decode the provided object as a JSON representation of a no-op request control.

Parameters:

controlObject - The JSON object to be decoded. It must not be null.

strict - Indicates whether to use strict mode when decoding the provided JSON object. If this is true, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this is false, then unrecognized fields will be ignored.

Returns:

The no-op request control that was decoded from the provided JSON object.

Throws:

LDAPException - If the provided JSON object cannot be parsed as a valid no-op request control.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this LDAP control to the provided buffer.

Overrides:

toString in class Control

Parameters:

buffer - The buffer to which to append the string representation of this buffer.