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:

org.apache.directory.shared.asn1.ber.IAsn1Container

public class LdapMessageContainer
extends org.apache.directory.shared.asn1.ber.AbstractContainer
implements org.apache.directory.shared.asn1.ber.IAsn1Container

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.

Author:

Apache Directory Project

Field Summary

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

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

Constructor Summary

LdapMessageContainer()
Creates a new LdapMessageContainer object.

LdapMessageContainer(java.util.Set binaries)
Creates a new LdapMessageContainer object.

Method Summary

void	clean()
Control	getCurrentControl()
LdapMessage	getLdapMessage()
int	getMessageId()
boolean	isBinary(java.lang.String id)
void	setCurrentControl(Control currentControl) Store a newly created control
void	setLdapMessage(LdapMessage 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, getGrammar, getNewTlvId, getParentTLV, getState, getStates, getTlvId, getTransition, grammarEndAllowed, isGrammarEndAllowed, setCurrentTLV, setParentTLV, setState, setTransition

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.shared.asn1.ber.IAsn1Container

getCurrentTLV, getGrammar, getNewTlvId, getParentTLV, getState, getStates, getTlvId, getTransition, grammarEndAllowed, isGrammarEndAllowed, setCurrentTLV, setParentTLV, setState, setTransition

Constructor Detail

LdapMessageContainer

public LdapMessageContainer()

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

LdapMessageContainer

public LdapMessageContainer(java.util.Set binaries)

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

Method Detail

getLdapMessage

public LdapMessage getLdapMessage()

Returns:

Returns the ldapMessage.

setLdapMessage

public void setLdapMessage(LdapMessage 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 org.apache.directory.shared.asn1.ber.AbstractContainer

isBinary

public boolean isBinary(java.lang.String id)

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

getCurrentControl

public Control getCurrentControl()

Returns:

the current control being created

setCurrentControl

public void setCurrentControl(Control currentControl)

Store a newly created control

Parameters:

currentControl - The control to store