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

Class LdapEncoder

java.lang.Object

org.apache.directory.api.ldap.codec.api.LdapEncoder

public class LdapEncoder
extends java.lang.Object

LDAP BER encoder.

Field Summary

Fields

Modifier and Type	Field and Description
private LdapApiService	codec The LdapCodecService

Constructor Summary

Constructors

Constructor and Description
LdapEncoder(LdapApiService codec) Creates an instance of Ldap message encoder

Method Summary

Modifier and Type	Method and Description
private int	computeControlLength(Control control) Compute the control's encoded length
private int	computeMessageLength(MessageDecorator<? extends Message> messageDecorator) Compute the LdapMessage length LdapMessage : 0x30 L1 | +--> 0x02 0x0(1-4) [0..2^31-1] (MessageId) +--> protocolOp [+--> Controls] MessageId length = Length(0x02) + length(MessageId) + MessageId.length L1 = length(ProtocolOp) LdapMessage length = Length(0x30) + Length(L1) + MessageId length + L1
static int	computeReferralLength(Referral referral) Compute the referral's encoded length
private java.nio.ByteBuffer	encodeControl(java.nio.ByteBuffer buffer, Control control) Encode a control to a byte[]
java.nio.ByteBuffer	encodeMessage(Message message) Generate the PDU which contains the encoded object.
static void	encodeReferral(java.nio.ByteBuffer buffer, Referral referral) Encode the Referral message to a PDU.

Methods inherited from class java.lang.Object

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

Field Detail

codec

private LdapApiService codec

The LdapCodecService

Constructor Detail

LdapEncoder

public LdapEncoder(LdapApiService codec)

Creates an instance of Ldap message encoder

Parameters:

codec - The Codec service to use to handle Controls and extended operations, plus to get access to the underlying services.

Method Detail

computeControlLength

private int computeControlLength(Control control)

Compute the control's encoded length

encodeControl

private java.nio.ByteBuffer encodeControl(java.nio.ByteBuffer buffer,
                                          Control control)
                                   throws EncoderException

Encode a control to a byte[]

Throws:

EncoderException

encodeMessage

public java.nio.ByteBuffer encodeMessage(Message message)
                                  throws EncoderException

Generate the PDU which contains the encoded object. The generation is done in two phases : - first, we compute the length of each part and the global PDU length - second, we produce the PDU.

 0x30 L1 
   | 
   +--> 0x02 L2 MessageId  
   +--> ProtocolOp 
   +--> Controls 
   
 L2 = Length(MessageId)
 L1 = Length(0x02) + Length(L2) + L2 + Length(ProtocolOp) + Length(Controls)
 LdapMessageLength = Length(0x30) + Length(L1) + L1
 

Parameters:

message - The message to encode

Returns:

A ByteBuffer that contains the PDU

Throws:

EncoderException - If anything goes wrong.

computeMessageLength

private int computeMessageLength(MessageDecorator<? extends Message> messageDecorator)

Compute the LdapMessage length LdapMessage : 0x30 L1 | +--> 0x02 0x0(1-4) [0..2^31-1] (MessageId) +--> protocolOp [+--> Controls] MessageId length = Length(0x02) + length(MessageId) + MessageId.length L1 = length(ProtocolOp) LdapMessage length = Length(0x30) + Length(L1) + MessageId length + L1

Parameters:

messageDecorator - the decorated Message who's length is to be encoded

encodeReferral

public static void encodeReferral(java.nio.ByteBuffer buffer,
                                  Referral referral)
                           throws EncoderException

Encode the Referral message to a PDU.

Parameters:

buffer - The buffer where to put the PDU

referral - The referral to encode

Throws:

EncoderException - If the encoding failed

computeReferralLength

public static int computeReferralLength(Referral referral)

Compute the referral's encoded length

Parameters:

referral - The referral to encode

Returns:

The length of the encoded PDU