Package org.apache.directory.api.ldap.codec.api

Interface CodecControl<E extends Control>

Type Parameters:

E - The control being handled by this codec

All Superinterfaces:

Asn1Object, Control, Decorator<E>

All Known Implementing Classes:

BasicControlDecorator, ControlDecorator

public interface CodecControl<E extends Control>
extends Control, Decorator<E>

The codec uses this interface to add additional information to LDAP Model Control objects during encoding and decoding.

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method	Description
Asn1Object	decode(byte[] controlBytes)	Decodes raw ASN.1 encoded bytes into an Asn1Object for the control.
byte[]	getValue()	Gets the binary ASN.1 BER encoded representation of the control.
boolean	hasValue()	Checks to see if a value is set for this CodecControl.
void	setValue(byte[] value)	Set the Control's encoded control value.

Methods inherited from interface org.apache.directory.api.asn1.Asn1Object

computeLength, encode

Methods inherited from interface org.apache.directory.api.ldap.model.message.Control

getOid, isCritical, setCritical

Methods inherited from interface org.apache.directory.api.ldap.codec.api.Decorator

getCodecService, getDecorated

Method Detail

decode

Asn1Object decode(byte[] controlBytes)
           throws DecoderException

Decodes raw ASN.1 encoded bytes into an Asn1Object for the control.

Parameters:

controlBytes - the encoded control bytes

Returns:

the decoded Asn1Object for the control

Throws:

DecoderException - if anything goes wrong

hasValue

boolean hasValue()

Checks to see if a value is set for this CodecControl.

Returns:

true, if this control has a value, false otherwise

getValue

byte[] getValue()

Gets the binary ASN.1 BER encoded representation of the control.

Returns:

The control's encoded value

setValue

void setValue(byte[] value)

Set the Control's encoded control value.

Parameters:

value - The encoded control value to store.