com.ibm.di.eventhandler.ldap
Class LDAPControl

java.lang.Object
  com.ibm.di.eventhandler.ldap.LDAPControl

All Implemented Interfaces:

Serializable, Control

public class LDAPControl
extends Object
implements Control

See Also:

Serialized Form

Field Summary

static String[]	CONTROL_NAMES
static String[]	CONTROL_OIDS
String	controlType
byte[]	controlValue
ByteBuffer	controlValueBuffer
boolean	criticality
static int	OID_PAGED_SEARCH

Fields inherited from interface javax.naming.ldap.Control

CRITICAL, NONCRITICAL

Constructor Summary

LDAPControl(ByteBuffer buf)

LDAPControl(String oid)
Creates a new instance with the given OID.

Method Summary

boolean	canHandleControl() Returns true if this class can handle the encoding/decoding of the control value.
String	controlAttrPrefix() Returns the internal name for the control type.
ByteBuffer	getBuffer() This method returns the entire LDAP control as an encoded BER sequence.
Entry	getControlValueEntry() This method parses the control value into an entry object if the control is known to this class.
byte[]	getEncodedValue()
String	getID()
boolean	isCritical()
boolean	isPagedSearchControl()
void	setControlValueEntry(Entry entry) This method converts the entry object to the control value sequence required by the control type.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

controlType

public String controlType

criticality

public boolean criticality

controlValue

public byte[] controlValue

controlValueBuffer

public transient ByteBuffer controlValueBuffer

OID_PAGED_SEARCH

public static final int OID_PAGED_SEARCH

See Also:

Constant Field Values

CONTROL_OIDS

public static final String[] CONTROL_OIDS

CONTROL_NAMES

public static final String[] CONTROL_NAMES

Constructor Detail

LDAPControl

public LDAPControl(String oid)

Creates a new instance with the given OID. The provided OID is checked against the local names to translate it to an OID. Otherwise, it is expected that the oid value is a dotted decimal.

LDAPControl

public LDAPControl(ByteBuffer buf)
            throws Exception

Throws:

Exception

Method Detail

toString

public String toString()

Overrides:

toString in class Object

canHandleControl

public boolean canHandleControl()

Returns true if this class can handle the encoding/decoding of the control value.

isPagedSearchControl

public boolean isPagedSearchControl()

controlAttrPrefix

public String controlAttrPrefix()

Returns the internal name for the control type. The control name is used as a suffix when generating an entry for its values.

getControlValueEntry

public Entry getControlValueEntry()
                           throws Exception

This method parses the control value into an entry object if the control is known to this class. Otherwise, null is returned.

Throws:

Exception

setControlValueEntry

public void setControlValueEntry(Entry entry)
                          throws Exception

This method converts the entry object to the control value sequence required by the control type. If the control type is unknown to this class an exception is thrown.

Throws:

Exception

getBuffer

public ByteBuffer getBuffer()
                     throws Exception

This method returns the entire LDAP control as an encoded BER sequence.

Throws:

Exception

getEncodedValue

public byte[] getEncodedValue()

Specified by:

getEncodedValue in interface Control

getID

public String getID()

Specified by:

getID in interface Control

isCritical

public boolean isCritical()

Specified by:

isCritical in interface Control