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

java.lang.Object
  extended by com.unboundid.ldap.sdk.Control
      extended by com.unboundid.ldap.sdk.unboundidds.controls.SuppressReferentialIntegrityUpdatesRequestControl
All Implemented Interfaces:
java.io.Serializable

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

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
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.

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

SUPPRESS_REFINT_REQUEST_OID

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(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

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.

toString

public void toString(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.