org.forgerock.opendj.ldap.controls

Class PermissiveModifyRequestControl

java.lang.Object

org.forgerock.opendj.ldap.controls.PermissiveModifyRequestControl

All Implemented Interfaces:

Control

public final class PermissiveModifyRequestControl
extends Object
implements Control

The Microsoft defined permissive modify request control. The OID for this control is 1.2.840.113556.1.4.1413, and it does not have a value.

This control can only be used with LDAP modify requests. It changes the behavior of the modify operation as follows:

• Attempts to add an attribute value which already exists will be ignored and will not cause an AttributeValueExists error result to be returned.
• Attempts to delete an attribute value which does not exist will be ignored and will not cause an NoSuchAttribute error result to be returned.

In other words, a modify request add modification ensures that the attribute contains the specified attribute value, and a delete modification ensures that the attribute does not contain the specified attribute value.

 String groupDN = ...;
 String memberDN = ...;
 Connection connection = ...;

 // Add a member to a static group, telling the directory server not to
 // complain if the member already belongs to the group.
 ModifyRequest request = Requests.newModifyRequest(groupDN)
          .addControl(PermissiveModifyRequestControl.newControl(true))
          .addModification(ModificationType.ADD, "member", memberDN);
 connection.modify(request);
 

Field Summary

Fields

Modifier and Type	Field and Description
static ControlDecoder<PermissiveModifyRequestControl>	DECODER A decoder which can be used for decoding the permissive modify request control.
static String	OID The OID for the permissive modify request control.

Method Summary

Modifier and Type	Method and Description
String	getOid() Returns the numeric OID associated with this control.
ByteString	getValue() Returns the value, if any, associated with this control.
boolean	hasValue() Returns true if this control has a value.
boolean	isCritical() Returns true if it is unacceptable to perform the operation without applying the semantics of this control.
static PermissiveModifyRequestControl	newControl(boolean isCritical) Creates a new permissive modify request control having the provided criticality.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OID

public static final String OID

The OID for the permissive modify request control.

See Also:

Constant Field Values

DECODER

public static final ControlDecoder<PermissiveModifyRequestControl> DECODER

A decoder which can be used for decoding the permissive modify request control.

Method Detail

newControl

public static PermissiveModifyRequestControl newControl(boolean isCritical)

Creates a new permissive modify request control having the provided criticality.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

Returns:

The new control.

getOid

public String getOid()

Description copied from interface: Control

Returns the numeric OID associated with this control.

Specified by:

getOid in interface Control

Returns:

The numeric OID associated with this control.

getValue

public ByteString getValue()

Description copied from interface: Control

Returns the value, if any, associated with this control. Its format is defined by the specification of this control.

Specified by:

getValue in interface Control

Returns:

The value associated with this control, or null if there is no value.

hasValue

public boolean hasValue()

Description copied from interface: Control

Returns true if this control has a value. In some circumstances it may be useful to determine if a control has a value, without actually calculating the value and incurring any performance costs.

Specified by:

hasValue in interface Control

Returns:

true if this control has a value, or false if there is no value.

isCritical

public boolean isCritical()

Description copied from interface: Control

Returns true if it is unacceptable to perform the operation without applying the semantics of this control.

The criticality field only has meaning in controls attached to request messages (except UnbindRequest). For controls attached to response messages and the UnbindRequest, the criticality field SHOULD be false, and MUST be ignored by the receiving protocol peer. A value of true indicates that it is unacceptable to perform the operation without applying the semantics of the control.

Specified by:

isCritical in interface Control

Returns:

true if this control must be processed by the Directory Server, or false if it can be ignored.

toString

public String toString()

Overrides:

toString in class Object