org.apache.directory.shared.ldap.message
Class ControlImpl

java.lang.Object
  org.apache.directory.shared.ldap.message.ControlImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

EntryChangeControl, ManageDsaITControl, PersistentSearchControl, SubentriesControl

public abstract class ControlImpl

extends java.lang.Object

implements Control

Lockable Control implementation.

Version:

$Rev: 434411 $

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

Fields inherited from interface javax.naming.ldap.Control

CRITICAL, NONCRITICAL

Constructor Summary

ControlImpl()

Method Summary

java.lang.String	getID() Retrieves the object identifier assigned for the LDAP control.
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 class java.lang.Object

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

Methods inherited from interface javax.naming.ldap.Control

getEncodedValue

Constructor Detail

ControlImpl

public ControlImpl()

Method Detail

isCritical

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

Returns:

true if the control is critical false otherwise.

setCritical

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

Specified by:

setCritical in interface Control

Parameters:

isCritical - true if the control is critical false otherwise.

getType

public java.lang.String getType()

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

Specified by:

getType in interface Control

Returns:

the OID of this Control.

setType

public void setType(java.lang.String oid)

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

Specified by:

setType in interface Control

Parameters:

oid - the OID of this Control.

getValue

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

Specified by:

getValue in interface Control

Returns:

ASN.1 BER encoded value as binary data.

setValue

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

Specified by:

setValue in interface Control

Parameters:

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

getID

public java.lang.String getID()

Retrieves the object identifier assigned for the LDAP control.

Specified by:

getID in interface javax.naming.ldap.Control

Returns:

The non-null object identifier string.