org.apache.directory.shared.ldap.message.control

Interface Control

All Known Implementing Classes:

AbstractControl, CascadeControl, ControlImpl, EntryChangeControl, LdifControl, ManageDsaITControl, PagedResultsControl, PersistentSearchControl, SubentriesControl, SyncDoneValueControl, SyncInfoValueControl, SyncRequestValueControl, SyncStateValueControl

public interface Control

Protocol request and response altering control interface. Any number of controls may be associated with a protocol message.

Version:

$Rev: 764131 $

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method and Description
String	getOid()
byte[]	getValue() Returns the encoded value for this Control
boolean	hasValue() Tells if the Control has a value or not
boolean	isCritical() Tells if the control is critical or not.
void	setCritical(boolean isCritical) Sets the critical flag which determines whether or not this control is critical for the correct operation of a request or response message.
void	setValue(byte[] value) Stores the encoded value for this Control

Method Detail

getOid

String getOid()

Returns:

The Control's OID

isCritical

boolean isCritical()

Tells if the control is critical or not.

Returns:

true/code> if the control is critical, false otherwise

setCritical

void setCritical(boolean isCritical)

Sets the critical flag which determines whether or not this control is critical for the correct operation of a request or response message. The default for this value should be false.

Parameters:

isCritical - true if the control is critical false otherwise.

getValue

byte[] getValue()

Returns the encoded value for this Control

Returns:

The encoded value

setValue

void setValue(byte[] value)

Stores the encoded value for this Control

Parameters:

value - The encoded value

hasValue

boolean hasValue()

Tells if the Control has a value or not

Returns:

true if th Control has a value, even containing no bytes.