com.unboundid.ldap.sdk.unboundidds.controls

Class IgnoreNoUserModificationRequestControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.unboundidds.controls.IgnoreNoUserModificationRequestControl

All Implemented Interfaces:

java.io.Serializable

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

This class provides an implementation of an LDAP control that can be used to request that the Directory Server ignore the NO-USER-MODIFICATION flag for attribute types. It may be included in an add request to allow the client to include attributes which are not normally allowed to be externally specified (e.g., entryUUID, creatorsName, modifiersName, etc.). This control does not have a value, and there is no corresponding response 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.

Example

The following example demonstrates the process for attempting to perform an add operation including the ignore NO-USER-MODIFICATION control so that an entry can be added which already includes the creatorsName and createTimestamp attributes:

 AddRequest addRequest = new AddRequest("dc=example,dc=com",
      new Attribute("objectClass", "top", "domain"),
      new Attribute("dc", "example"),
      new Attribute("creatorsName", "cn=Admin User DN"),
      new Attribute("createTimestamp", "20080101000000Z"));
 addRequest.addControl(new IgnoreNoUserModificationRequestControl());

 try
 {
   LDAPResult result = connection.add(addRequest);
   // The entry was added successfully.
 }
 catch (LDAPException le)
 {
   // The attempt to add the entry failed.
 }
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IGNORE_NO_USER_MODIFICATION_REQUEST_OID The OID (1.3.6.1.4.1.30221.2.5.5) for the ignore NO-USER-MODIFICATION request control.

Constructor Summary

Constructors

Constructor and Description
IgnoreNoUserModificationRequestControl() Creates a new ignore NO-USER-MODIFICATION request control.
IgnoreNoUserModificationRequestControl(boolean isCritical) Creates a new ignore NO-USER-MODIFICATION request control with the given criticality.
IgnoreNoUserModificationRequestControl(Control control) Creates a new ignore NO-USER-MODIFICATION request control which is decoded from the provided generic control.

Method Summary

Modifier and Type	Method and Description
static IgnoreNoUserModificationRequestControl	decodeJSONControl(JSONObject controlObject, boolean strict) Attempts to decode the provided object as a JSON representation of an ignore NO-USER-MODIFICATION request control.
java.lang.String	getControlName() Retrieves the user-friendly name for this control, if available.
JSONObject	toJSONControl() Retrieves a representation of this ignore NO-USER-MODIFICATION 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

IGNORE_NO_USER_MODIFICATION_REQUEST_OID

@NotNull
public static final java.lang.String IGNORE_NO_USER_MODIFICATION_REQUEST_OID

The OID (1.3.6.1.4.1.30221.2.5.5) for the ignore NO-USER-MODIFICATION request control.

See Also:

Constant Field Values

Constructor Detail

IgnoreNoUserModificationRequestControl

public IgnoreNoUserModificationRequestControl()

Creates a new ignore NO-USER-MODIFICATION request control. It will be marked critical.

IgnoreNoUserModificationRequestControl

public IgnoreNoUserModificationRequestControl(boolean isCritical)

Creates a new ignore NO-USER-MODIFICATION request control with the given criticality.

Parameters:

isCritical - Indicates whether the control should be considered critical.

IgnoreNoUserModificationRequestControl

public IgnoreNoUserModificationRequestControl(@NotNull
                                              Control control)
                                       throws LDAPException

Creates a new ignore NO-USER-MODIFICATION request control which is decoded from the provided generic control.

Parameters:

control - The generic control to be decoded as an ignore NO-USER-MODIFICATION request control.

Throws:

LDAPException - If the provided control cannot be decoded as an ignore NO-USER-MODIFICATION 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 ignore NO-USER-MODIFICATION 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 ignore NO-USER-MODIFICATION request control, the OID is "1.3.6.1.4.1.30221.2.5.5".
• 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 IgnoreNoUserModificationRequestControl decodeJSONControl(@NotNull
                                                                                JSONObject controlObject,
                                                                                boolean strict)
                                                                         throws LDAPException

Attempts to decode the provided object as a JSON representation of an ignore NO-USER-MODIFICATION 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 ignore NO-USER-MODIFICATION request control that was decoded from the provided JSON object.

Throws:

LDAPException - If the provided JSON object cannot be parsed as a valid ignore NO-USER-MODIFICATION 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.