com.unboundid.ldap.sdk.unboundidds.controls

Class SuppressReferentialIntegrityUpdatesRequestControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.unboundidds.controls.SuppressReferentialIntegrityUpdatesRequestControl

All Implemented Interfaces:

java.io.Serializable

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

This class provides a request control which may be included in a delete or modify DN request to indicate that the server should skip any referential integrity processing that would have otherwise been done for that operation.

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.

The request control has an OID of "1.3.6.1.4.1.30221.2.5.30" and does not have a value. The criticality for this control may be either TRUE or FALSE, which may impact whether a server will process the associated modify DN or delete operation if the server does not support the use of this control. If a server receives a critical control that it does not support for the associated operation, then it will return a failure result without attempting to process that operation. If a server receives a non-critical control that it does not support for the associated operation, then it will process the operation as if that control had not been provided.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SUPPRESS_REFINT_REQUEST_OID The OID (1.3.6.1.4.1.30221.2.5.30) for the suppress referential integrity updates request control.

Constructor Summary

Constructors

Constructor and Description
SuppressReferentialIntegrityUpdatesRequestControl() Creates a new suppress referential integrity updates request control.
SuppressReferentialIntegrityUpdatesRequestControl(boolean isCritical) Creates a new suppress referential integrity updates request control.
SuppressReferentialIntegrityUpdatesRequestControl(Control control) Creates a new suppress referential integrity updates request control which is decoded from the provided generic control.

Method Summary

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

SUPPRESS_REFINT_REQUEST_OID

@NotNull
public static final java.lang.String SUPPRESS_REFINT_REQUEST_OID

The OID (1.3.6.1.4.1.30221.2.5.30) for the suppress referential integrity updates request control.

See Also:

Constant Field Values

Constructor Detail

SuppressReferentialIntegrityUpdatesRequestControl

public SuppressReferentialIntegrityUpdatesRequestControl()

Creates a new suppress referential integrity updates request control. It will be critical.

SuppressReferentialIntegrityUpdatesRequestControl

public SuppressReferentialIntegrityUpdatesRequestControl(boolean isCritical)

Creates a new suppress referential integrity updates request control.

Parameters:

isCritical - Indicates whether the control should be marked critical.

SuppressReferentialIntegrityUpdatesRequestControl

public SuppressReferentialIntegrityUpdatesRequestControl(@NotNull
                                                         Control control)
                                                  throws LDAPException

Creates a new suppress referential integrity updates request control which is decoded from the provided generic control.

Parameters:

control - The generic control to be decoded as a suppress referential integrity updates request control.

Throws:

LDAPException - If the provided control cannot be decoded as a suppress referential integrity updates 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 suppress referential integrity updates 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 suppress referential integrity updates request control, the OID is "1.3.6.1.4.1.30221.2.5.30".
• 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 SuppressReferentialIntegrityUpdatesRequestControl decodeJSONControl(@NotNull
                                                                                           JSONObject controlObject,
                                                                                           boolean strict)
                                                                                    throws LDAPException

Attempts to decode the provided object as a JSON representation of a suppress referential integrity updates 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 suppress referential integrity updates request control that was decoded from the provided JSON object.

Throws:

LDAPException - If the provided JSON object cannot be parsed as a valid suppress referential integrity updates 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.