org.apache.directory.shared.ldap.codec
Class LdapMessageCodec

java.lang.Object
  org.apache.directory.shared.asn1.AbstractAsn1Object
      org.apache.directory.shared.ldap.codec.LdapMessageCodec

All Implemented Interfaces:

Asn1Object

Direct Known Subclasses:

AbandonRequestCodec, AddRequestCodec, BindRequestCodec, CompareRequestCodec, DelRequestCodec, ExtendedRequestCodec, LdapResponseCodec, ModifyDNRequestCodec, ModifyRequestCodec, SearchRequestCodec, SearchResultEntryCodec, SearchResultReferenceCodec, UnBindRequestCodec

public class LdapMessageCodec
extends AbstractAsn1Object

The main ldapObject : every Ldap Message are encapsulated in it. It contains a message Id, a operation (protocolOp) and one ore more Controls.

Version:

$Rev: 764131 $, $Date: 2009-04-11 03:03:00 +0200 (Sam, 11 avr 2009) $,

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

parent

Constructor Summary

LdapMessageCodec()
Creates a new LdapMessage object.

Method Summary

void	addControl(ControlCodec control) Add a control to the Controls array
int	computeLength() 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
java.nio.ByteBuffer	encode(java.nio.ByteBuffer buffer) Generate the PDU which contains the encoded object.
AbandonRequestCodec	getAbandonRequest() Get a AbandonRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
AddRequestCodec	getAddRequest() Get a AddRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
AddResponseCodec	getAddResponse() Get a AddResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
BindRequestCodec	getBindRequest() Get a BindRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
BindResponseCodec	getBindResponse() Get a BindResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
CompareRequestCodec	getCompareRequest() Get a CompareRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
CompareResponseCodec	getCompareResponse() Get a CompareResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
java.util.List<ControlCodec>	getControls() Get the Control Objects
ControlCodec	getControls(int i) Get the Control Object at a specific index
ControlCodec	getCurrentControl() Get the current Control Object
DelRequestCodec	getDelRequest() Get a DelRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
DelResponseCodec	getDelResponse() Get a DelResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
ExtendedRequestCodec	getExtendedRequest() Get a ExtendedRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
ExtendedResponseCodec	getExtendedResponse() Get a ExtendedResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
IntermediateResponseCodec	getIntermediateResponse() Get a IntermediateResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
LdapResponseCodec	getLdapResponse() Get the encapsulated Ldap response.
int	getMessageId() Get the message ID
int	getMessageType() Get the message type
java.lang.String	getMessageTypeName() Get the message type Name
ModifyDNRequestCodec	getModifyDNRequest() Get a ModifyDNRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
ModifyDNResponseCodec	getModifyDNResponse() Get a ModifyDNResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
ModifyRequestCodec	getModifyRequest() Get a ModifyRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
ModifyResponseCodec	getModifyResponse() Get a ModifyResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
SearchRequestCodec	getSearchRequest() Get a SearchRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
SearchResultDoneCodec	getSearchResultDone() Get a SearchResultDone ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
SearchResultEntryCodec	getSearchResultEntry() Get a SearchResultEntry ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
SearchResultReferenceCodec	getSearchResultReference() Get a SearchResultReference ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
UnBindRequestCodec	getUnBindRequest() Get a UnBindRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.
void	initControls() Init the controls array
void	setMessageId(int messageId) Set the message ID
void	setProtocolOP(Asn1Object protocolOp) Set the ProtocolOP
java.lang.String	toString() Get a String representation of a LdapMessage

Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

addLength, getCurrentLength, getExpectedLength, getParent, getTlvId, setCurrentLength, setExpectedLength, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapMessageCodec

public LdapMessageCodec()

Creates a new LdapMessage object.

Method Detail

getControls

public ControlCodec getControls(int i)

Get the Control Object at a specific index

Parameters:

i - The index of the Control Object to get

Returns:

The selected Control Object

getControls

public java.util.List<ControlCodec> getControls()

Get the Control Objects

Returns:

The Control Objects

getCurrentControl

public ControlCodec getCurrentControl()

Get the current Control Object

Returns:

The current Control Object

addControl

public void addControl(ControlCodec control)

Add a control to the Controls array

Parameters:

control - The Control to add

initControls

public void initControls()

Init the controls array

getMessageId

public int getMessageId()

Get the message ID

Returns:

The message ID

setMessageId

public void setMessageId(int messageId)

Set the message ID

Parameters:

messageId - The message ID

getMessageType

public int getMessageType()

Get the message type

Returns:

The message type

getMessageTypeName

public java.lang.String getMessageTypeName()

Get the message type Name

Returns:

The message type name

getLdapResponse

public LdapResponseCodec getLdapResponse()

Get the encapsulated Ldap response.

Returns:

Returns the Ldap response.

getAbandonRequest

public AbandonRequestCodec getAbandonRequest()

Get a AbandonRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the AbandonRequest ldapObject.

getAddRequest

public AddRequestCodec getAddRequest()

Get a AddRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the AddRequest ldapObject.

getAddResponse

public AddResponseCodec getAddResponse()

Get a AddResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the AddResponse ldapObject.

getBindRequest

public BindRequestCodec getBindRequest()

Get a BindRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the BindRequest ldapObject.

getBindResponse

public BindResponseCodec getBindResponse()

Get a BindResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the BindResponse ldapObject.

getCompareRequest

public CompareRequestCodec getCompareRequest()

Get a CompareRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the CompareRequest ldapObject.

getCompareResponse

public CompareResponseCodec getCompareResponse()

Get a CompareResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the CompareResponse ldapObject.

getDelRequest

public DelRequestCodec getDelRequest()

Get a DelRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the DelRequest ldapObject.

getDelResponse

public DelResponseCodec getDelResponse()

Get a DelResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the DelResponse ldapObject.

getExtendedRequest

public ExtendedRequestCodec getExtendedRequest()

Get a ExtendedRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the ExtendedRequest ldapObject.

getExtendedResponse

public ExtendedResponseCodec getExtendedResponse()

Get a ExtendedResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the ExtendedResponse ldapObject.

getIntermediateResponse

public IntermediateResponseCodec getIntermediateResponse()

Get a IntermediateResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the IntermediateResponse ldapObject.

getModifyDNRequest

public ModifyDNRequestCodec getModifyDNRequest()

Get a ModifyDNRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the ModifyDNRequest ldapObject.

getModifyDNResponse

public ModifyDNResponseCodec getModifyDNResponse()

Get a ModifyDNResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the ModifyDNResponse ldapObject.

getModifyRequest

public ModifyRequestCodec getModifyRequest()

Get a ModifyRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the ModifyRequest ldapObject.

getModifyResponse

public ModifyResponseCodec getModifyResponse()

Get a ModifyResponse ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the ModifyResponse ldapObject.

getSearchRequest

public SearchRequestCodec getSearchRequest()

Get a SearchRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the SearchRequest ldapObject.

getSearchResultDone

public SearchResultDoneCodec getSearchResultDone()

Get a SearchResultDone ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the SearchRequestDone ldapObject.

getSearchResultEntry

public SearchResultEntryCodec getSearchResultEntry()

Get a SearchResultEntry ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the SearchResultEntry ldapObject.

getSearchResultReference

public SearchResultReferenceCodec getSearchResultReference()

Get a SearchResultReference ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the SearchResultReference ldapObject.

getUnBindRequest

public UnBindRequestCodec getUnBindRequest()

Get a UnBindRequest ldapObject, assuming that the caller knows that it is the LdapMessage exact type.

Returns:

Returns the UnBindRequest ldapObject.

setProtocolOP

public void setProtocolOP(Asn1Object protocolOp)

Set the ProtocolOP

Parameters:

protocolOp - The protocolOp to set.

computeLength

public int computeLength()

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

Specified by:

computeLength in interface Asn1Object

Specified by:

computeLength in class AbstractAsn1Object

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           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

Specified by:

encode in interface Asn1Object

Overrides:

encode in class AbstractAsn1Object

Parameters:

buffer - The encoded PDU

Returns:

A ByteBuffer that contaons the PDU

Throws:

EncoderException - If anything goes wrong.

toString

public java.lang.String toString()

Get a String representation of a LdapMessage

Overrides:

toString in class java.lang.Object

Returns:

A LdapMessage String