org.apache.directory.shared.ldap.message
Interface Control

All Superinterfaces:

javax.naming.ldap.Control, java.io.Serializable

public interface Control
extends javax.naming.ldap.Control

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

Version:

$Rev: 434411 $

Author:

Apache Directory Project

Field Summary

Fields inherited from interface javax.naming.ldap.Control

CRITICAL, NONCRITICAL

Method Summary

java.lang.String	getType() Gets the OID of the Control to identify the control type.
byte[]	getValue() Gets the ASN.1 BER encoded value of the control which would have its own custom ASN.1 defined structure based on the nature of the control.
boolean	isCritical() Determines whether or not this control is critical for the correct operation of a request or response message.
void	setCritical(boolean isCritical) Sets the criticil flag which determines whether or not this control is critical for the correct operation of a request or response message.
void	setType(java.lang.String oid) Sets the OID of the Control to identify the control type.
void	setValue(byte[] value) Sets the ASN.1 BER encoded value of the control which would have its own custom ASN.1 defined structure based on the nature of the control.

Methods inherited from interface javax.naming.ldap.Control

getEncodedValue, getID

Method Detail

getType

java.lang.String getType()

Gets the OID of the Control to identify the control type.

Returns:

the OID of this Control.

setType

void setType(java.lang.String oid)

Sets the OID of the Control to identify the control type.

Parameters:

oid - the OID of this Control.

getValue

byte[] getValue()

Gets the ASN.1 BER encoded value of the control which would have its own custom ASN.1 defined structure based on the nature of the control.

Returns:

ASN.1 BER encoded value as binary data.

setValue

void setValue(byte[] value)

Sets the ASN.1 BER encoded value of the control which would have its own custom ASN.1 defined structure based on the nature of the control.

Parameters:

value - ASN.1 BER encoded value as binary data.

isCritical

boolean isCritical()

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.

Specified by:

isCritical in interface javax.naming.ldap.Control

Returns:

true if the control is critical false otherwise.

setCritical

void setCritical(boolean isCritical)

Sets the criticil 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.