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

java.lang.Object
  org.apache.directory.shared.asn1.ber.AbstractContainer
      org.apache.directory.shared.ldap.codec.LdapMessageContainer

All Implemented Interfaces:

IAsn1Container

public class LdapMessageContainer
extends AbstractContainer

The LdapMessage container stores all the messages decoded by the Asn1Decoder. When dealing whith an incoding PDU, we will obtain a LdapMessage in the ILdapContainer.

Version:

$Rev: 910150 $, $Date: 2010-02-15 02:37:34 +0100 (Lun, 15 fév 2010) $,

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.asn1.ber.AbstractContainer

decodeBytes, grammar, grammarEndAllowed, maxPDUSize, parentTLV, state, states, stateStack, tlv, transition

Constructor Summary

LdapMessageContainer()
Creates a new LdapMessageContainer object.

LdapMessageContainer(BinaryAttributeDetector binaryAttributeDetector)
Creates a new LdapMessageContainer object.

Method Summary

void	clean()
AbandonRequestCodec	getAbandonRequest()
AddRequestCodec	getAddRequest()
AddResponseCodec	getAddResponse()
BindRequestCodec	getBindRequest()
BindResponseCodec	getBindResponse()
CompareRequestCodec	getCompareRequest()
CompareResponseCodec	getCompareResponse()
AbstractControl	getCurrentControl()
DelRequestCodec	getDelRequest()
DelResponseCodec	getDelResponse()
ExtendedRequestCodec	getExtendedRequest()
ExtendedResponseCodec	getExtendedResponse()
IntermediateResponseCodec	getIntermediateResponse()
LdapMessageCodec	getLdapMessage()
LdapResponseCodec	getLdapResponse()
int	getMessageId()
ModifyDNRequestCodec	getModifyDnRequest()
ModifyDNResponseCodec	getModifyDnResponse()
ModifyRequestCodec	getModifyRequest()
ModifyResponseCodec	getModifyResponse()
SearchRequestCodec	getSearchRequest()
SearchResultDoneCodec	getSearchResultDone()
SearchResultEntryCodec	getSearchResultEntry()
SearchResultReferenceCodec	getSearchResultReference()
UnBindRequestCodec	getUnbindRequest()
boolean	isBinary(String id)
void	setCurrentControl(AbstractControl currentControl) Store a newly created control
void	setLdapMessage(LdapMessageCodec ldapMessage) Set a ldapMessage Object into the container.
void	setMessageId(int messageId) Set the message ID

Methods inherited from class org.apache.directory.shared.asn1.ber.AbstractContainer

getCurrentTLV, getDecodeBytes, getGrammar, getMaxPDUSize, getNewTlvId, getParentTLV, getState, getStates, getTlvId, getTransition, grammarEndAllowed, incrementDecodeBytes, isGrammarEndAllowed, setCurrentTLV, setMaxPDUSize, setParentTLV, setState, setTransition

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapMessageContainer

public LdapMessageContainer()

Creates a new LdapMessageContainer object. We will store ten grammars, it's enough ...

LdapMessageContainer

public LdapMessageContainer(BinaryAttributeDetector binaryAttributeDetector)

Creates a new LdapMessageContainer object. We will store ten grammars, it's enough ...

Parameters:

binaryAttributeDetector - checks if an attribute is binary

Method Detail

getLdapMessage

public LdapMessageCodec getLdapMessage()

Returns:

Returns the ldapMessage.

getLdapResponse

public LdapResponseCodec getLdapResponse()

Returns:

Returns the LdapResponse.

getAbandonRequest

public AbandonRequestCodec getAbandonRequest()

Returns:

Returns the AbandonRequest stored in the container

getAddRequest

public AddRequestCodec getAddRequest()

Returns:

Returns the AddRequest stored in the container

getAddResponse

public AddResponseCodec getAddResponse()

Returns:

Returns the AddResponse stored in the container

getBindRequest

public BindRequestCodec getBindRequest()

Returns:

Returns the BindRequest stored in the container

getBindResponse

public BindResponseCodec getBindResponse()

Returns:

Returns the BindResponse stored in the container

getCompareRequest

public CompareRequestCodec getCompareRequest()

Returns:

Returns the CompareRequest stored in the container

getCompareResponse

public CompareResponseCodec getCompareResponse()

Returns:

Returns the CompareResponse stored in the container

getDelRequest

public DelRequestCodec getDelRequest()

Returns:

Returns the DelRequest stored in the container

getDelResponse

public DelResponseCodec getDelResponse()

Returns:

Returns the DelResponse stored in the container

getExtendedRequest

public ExtendedRequestCodec getExtendedRequest()

Returns:

Returns the ExtendedRequest stored in the container

getExtendedResponse

public ExtendedResponseCodec getExtendedResponse()

Returns:

Returns the ExtendedResponse stored in the container

getIntermediateResponse

public IntermediateResponseCodec getIntermediateResponse()

Returns:

Returns the IntermediateResponse stored in the container

getModifyRequest

public ModifyRequestCodec getModifyRequest()

Returns:

Returns the ModifyRequest stored in the container

getModifyResponse

public ModifyResponseCodec getModifyResponse()

Returns:

Returns the ModifyResponse stored in the container

getModifyDnRequest

public ModifyDNRequestCodec getModifyDnRequest()

Returns:

Returns the ModifyDnRequest stored in the container

getModifyDnResponse

public ModifyDNResponseCodec getModifyDnResponse()

Returns:

Returns the ModifyDnResponse stored in the container

getSearchRequest

public SearchRequestCodec getSearchRequest()

Returns:

Returns the SearchRequest stored in the container

getSearchResultEntry

public SearchResultEntryCodec getSearchResultEntry()

Returns:

Returns the SearchResultEntryCodec stored in the container

getSearchResultReference

public SearchResultReferenceCodec getSearchResultReference()

Returns:

Returns the SearchResultReferenceCodec stored in the container

getSearchResultDone

public SearchResultDoneCodec getSearchResultDone()

Returns:

Returns the SearchResultDone stored in the container

getUnbindRequest

public UnBindRequestCodec getUnbindRequest()

Returns:

Returns the UnbindRequest stored in the container

setLdapMessage

public void setLdapMessage(LdapMessageCodec ldapMessage)

Set a ldapMessage Object into the container. It will be completed by the ldapDecoder .

Parameters:

ldapMessage - The message to set.

clean

public void clean()

Overrides:

clean in class AbstractContainer

isBinary

public boolean isBinary(String id)

Parameters:

id - checks if an attribute id is binary

Returns:

Returns true if the attribute is binary.

getMessageId

public int getMessageId()

Returns:

The message ID

setMessageId

public void setMessageId(int messageId)

Set the message ID

Parameters:

messageId - the id of the message

getCurrentControl

public AbstractControl getCurrentControl()

Returns:

the current control being created

setCurrentControl

public void setCurrentControl(AbstractControl currentControl)

Store a newly created control

Parameters:

currentControl - The control to store