org.apache.directory.api.dsmlv2

Class Dsmlv2Container

java.lang.Object

org.apache.directory.api.dsmlv2.Dsmlv2Container

All Implemented Interfaces:

Container

public class Dsmlv2Container
extends java.lang.Object
implements Container

This class represents the DSML Container. It used by the DSML Parser to store information.

Field Summary

Fields

Modifier and Type	Field and Description
private BatchRequestDsml	batchRequest The BatchRequest of the parsing
private BatchResponseDsml	batchResponse The BatchResponse of the parsing
private LdapApiService	codec The codec service
private AbstractGrammar	grammar The associated grammar
private org.xmlpull.v1.XmlPullParser	parser The pool parser
private java.lang.Enum<Dsmlv2StatesEnum>	state The current state of the decoding
private java.lang.Enum<Dsmlv2StatesEnum>[]	states Store the different states for debug purpose
private java.lang.Enum<Dsmlv2StatesEnum>	transition The current transition

Constructor Summary

Constructors

Constructor and Description
Dsmlv2Container(LdapApiService codec) Creates a new LdapMessageContainer object.

Method Summary

Modifier and Type	Method and Description
BatchRequestDsml	getBatchRequest() Gets the DSML Batch Request
BatchResponseDsml	getBatchResponse() Gets the DSML Batch Response
AbstractGrammar	getGrammar() Gets the grammar
LdapApiService	getLdapCodecService() Gets the LdapApiService associated with this Container.
org.xmlpull.v1.XmlPullParser	getParser() Gets the parser
java.lang.Enum<Dsmlv2StatesEnum>	getState() Get the current grammar state
java.lang.Enum<Dsmlv2StatesEnum>[]	getStates() Get the states for this container's grammars
java.lang.Enum<Dsmlv2StatesEnum>	getTransition() Get the transition
GrammarTransition	getTransition(java.lang.Enum<Dsmlv2StatesEnum> currentState, Tag currentTag) Get the transition associated with the state and tag
void	setBatchRequest(BatchRequestDsml batchRequest) Sets the DSML Batch Request
void	setBatchResponse(BatchResponseDsml batchResponse) Sets the DSML Batch Request
void	setGrammar(AbstractGrammar grammar) Sets the Grammar
void	setParser(org.xmlpull.v1.XmlPullParser parser) Sets the parser
void	setState(java.lang.Enum<Dsmlv2StatesEnum> state) Set the new current state
void	setTransition(java.lang.Enum<Dsmlv2StatesEnum> transition) Update the transition from a state to another

Methods inherited from class java.lang.Object

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

Field Detail

state

private java.lang.Enum<Dsmlv2StatesEnum> state

The current state of the decoding

transition

private java.lang.Enum<Dsmlv2StatesEnum> transition

The current transition

states

private java.lang.Enum<Dsmlv2StatesEnum>[] states

Store the different states for debug purpose

parser

private org.xmlpull.v1.XmlPullParser parser

The pool parser

batchRequest

private BatchRequestDsml batchRequest

The BatchRequest of the parsing

batchResponse

private BatchResponseDsml batchResponse

The BatchResponse of the parsing

grammar

private AbstractGrammar grammar

The associated grammar

codec

private final LdapApiService codec

The codec service

Constructor Detail

Dsmlv2Container

public Dsmlv2Container(LdapApiService codec)

Creates a new LdapMessageContainer object.

Parameters:

codec - the Codec used to encode/decode the messages

Method Detail

getLdapCodecService

public LdapApiService getLdapCodecService()

Gets the LdapApiService associated with this Container.

Returns:

The codec used to encode/decode the messages

getBatchRequest

public BatchRequestDsml getBatchRequest()

Gets the DSML Batch Request

Returns:

Returns the Batch Request

setBatchRequest

public void setBatchRequest(BatchRequestDsml batchRequest)

Sets the DSML Batch Request

Parameters:

batchRequest - the Batch Request to set

getBatchResponse

public BatchResponseDsml getBatchResponse()

Gets the DSML Batch Response

Returns:

Returns the Batch Response

setBatchResponse

public void setBatchResponse(BatchResponseDsml batchResponse)

Sets the DSML Batch Request

Parameters:

batchResponse - the Batch Response to set

getParser

public org.xmlpull.v1.XmlPullParser getParser()

Gets the parser

Returns:

the parser

setParser

public void setParser(org.xmlpull.v1.XmlPullParser parser)

Sets the parser

Parameters:

parser - the parser to set

getState

public java.lang.Enum<Dsmlv2StatesEnum> getState()

Get the current grammar state

Specified by:

getState in interface Container

Returns:

the current grammar state

setState

public void setState(java.lang.Enum<Dsmlv2StatesEnum> state)

Set the new current state

Specified by:

setState in interface Container

Parameters:

state - the new state

getTransition

public java.lang.Enum<Dsmlv2StatesEnum> getTransition()

Get the transition

Specified by:

getTransition in interface Container

Returns:

the transition from the previous state to the new state

setTransition

public void setTransition(java.lang.Enum<Dsmlv2StatesEnum> transition)

Update the transition from a state to another

Specified by:

setTransition in interface Container

Parameters:

transition - the transition to set

getStates

public java.lang.Enum<Dsmlv2StatesEnum>[] getStates()

Get the states for this container's grammars

Specified by:

getStates in interface Container

Returns:

the states.

getGrammar

public AbstractGrammar getGrammar()

Gets the grammar

Returns:

the grammar

setGrammar

public void setGrammar(AbstractGrammar grammar)

Sets the Grammar

Parameters:

grammar - the grammar to set

getTransition

public GrammarTransition getTransition(java.lang.Enum<Dsmlv2StatesEnum> currentState,
                                       Tag currentTag)

Get the transition associated with the state and tag

Parameters:

currentState - the current state

currentTag - the current tag

Returns:

a valid transition if any, or null.