org.opends.server.plugins

Class ChangeNumberControlPlugin.ChangeNumberResponseControl

java.lang.Object

org.opends.server.plugins.ChangeNumberControlPlugin.ChangeNumberResponseControl

All Implemented Interfaces:

Control

Enclosing class:

ChangeNumberControlPlugin

public static class ChangeNumberControlPlugin.ChangeNumberResponseControl
extends Object
implements Control

The control used by this plugin.

Constructor Summary

Constructors

Constructor and Description
ChangeNumberResponseControl(boolean isCritical, CSN csn) Constructs a new change number control.

Method Summary

Modifier and Type	Method and Description
CSN	getCSN() Retrieves the CSN.
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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeNumberResponseControl

public ChangeNumberResponseControl(boolean isCritical,
                                   CSN csn)

Constructs a new change number control.

Parameters:

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

csn - The CSN.

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.

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.

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.

getCSN

public CSN getCSN()

Retrieves the CSN.

Returns:

The CSN.

isCritical

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