com.unboundid.ldap.sdk.experimental

Class DraftZeilengaLDAPRelaxRules03RequestControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.experimental.DraftZeilengaLDAPRelaxRules03RequestControl

All Implemented Interfaces:

java.io.Serializable

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

This class provides an implementation of the LDAP relax rules request control as defined in draft-zeilenga-ldap-relax-03. This control may be included in LDAP update (including add, delete, modify, and modify DN) requests to indicate that the server should relax its enforcement of certain constraints for that update operation. Such constraints that may be relaxed include:

• The restriction that prevents changing an entry's structural object class.
• The restriction that prevents clients from altering the values of attributes defined with the NO-USER-MODIFICATION constraint.
• The restriction that prevents using attributes defined with the OBSOLETE constraint.
• The restriction that prevents including an auxiliary object class in an entry when that class is prohibited by a DIT content rule.
• The restriction that prevents including an attribute in an entry when that attribute is prohibited by a DIT content rule.
• The restriction that prevents adding a subordinate entry whose structural class does not satisfy the DIT structure rule that governs the parent entry.
• The restriction that prevents adding an entry with RDN attributes that do not satisfy the governing name form.
• The restriction that prevents altering entries that currently do not conform to the server schema in some way in a manner that does not fix the relevant schema conformance issues.

Note that at the time this control was written, the latest version of the specification may be found in draft-zeilenga-ldap-relax-03. This version of the document does not explicitly specify the OID that should be used for the control. Until such time as this OID is officially defined, this implementation uses the OID temporarily assigned for its use by the OpenLDAP Foundation, which is used by at least the OpenLDAP and ForgeRock servers.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RELAX_RULES_REQUEST_OID The OID (1.3.6.1.4.1.4203.666.5.12) for the LDAP relax rules request control.

Constructor Summary

Constructors

Constructor and Description
DraftZeilengaLDAPRelaxRules03RequestControl() Creates a new relax rules request control.
DraftZeilengaLDAPRelaxRules03RequestControl(Control control) Creates a new relax rules request control which is decoded from the provided generic control.

Method Summary

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.

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, toJSONControl, toString, writeTo

Methods inherited from class java.lang.Object

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

Field Detail

RELAX_RULES_REQUEST_OID

@NotNull
public static final java.lang.String RELAX_RULES_REQUEST_OID

The OID (1.3.6.1.4.1.4203.666.5.12) for the LDAP relax rules request control.

See Also:

Constant Field Values

Constructor Detail

DraftZeilengaLDAPRelaxRules03RequestControl

public DraftZeilengaLDAPRelaxRules03RequestControl()

Creates a new relax rules request control. It will be marked critical, as required by the control specification.

DraftZeilengaLDAPRelaxRules03RequestControl

public DraftZeilengaLDAPRelaxRules03RequestControl(@NotNull
                                                   Control control)
                                            throws LDAPException

Creates a new relax rules request control which is decoded from the provided generic control.

Parameters:

control - The generic control to be decoded as a relax rules request control.

Throws:

LDAPException - If the provided control cannot be decoded as a relax rules 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.

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.