Package org.opends.server.controls

Class InternalModificationsRequestControl

java.lang.Object

org.opends.server.controls.InternalModificationsRequestControl

All Implemented Interfaces:

Control

public final class InternalModificationsRequestControl
extends Object
implements Control

A control providing additional modifications to a request.

Legacy ModifyDNOperation class allow to provide modifications to perform along with the DN modification. As it is not possible to do this with a ModifyDnRequest, this control can be used for this purpose.

Field Summary

Fields

Modifier and Type	Field	Description
static ControlDecoder<InternalModificationsRequestControl>	DECODER	The Control Decoder that can be used to decode this control.
static String	OID	OID for the internal modifications control.

Constructor Summary

Constructors

Constructor	Description
InternalModificationsRequestControl(boolean isCritical, String origin, List<Modification> mods)	Constructs a new control.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<Modification>	getModifications()	Returns the modifications to perform.
String	getOid()	Returns the numeric OID associated with this control.
String	getOrigin()	Returns the origin of the modifications.
ByteString	getValue()	Returns the value, if any, associated with this control.
int	hashCode()
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.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

OID

public static final String OID

OID for the internal modifications control.

See Also:

Constant Field Values

DECODER

public static final ControlDecoder<InternalModificationsRequestControl> DECODER

The Control Decoder that can be used to decode this control.

Constructor Detail

InternalModificationsRequestControl

public InternalModificationsRequestControl(boolean isCritical,
                                           String origin,
                                           List<Modification> mods)

Constructs a new control.

Parameters:

isCritical - Indicates whether support for this control should be considered a critical part of the server processing.

origin - the non-null origin of the modifications.

mods - the non-null modifications to perform.

Method Detail

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.

getModifications

public List<Modification> getModifications()

Returns the modifications to perform.

Returns:

the non-null modifications

getOrigin

public String getOrigin()

Returns the origin of the modifications.

Returns:

the non-null origin of the modifications

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.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object