org.apache.directory.api.dsmlv2

Class Dsmlv2ResponseParser

java.lang.Object

org.apache.directory.api.dsmlv2.Dsmlv2ResponseParser

public class Dsmlv2ResponseParser
extends java.lang.Object

This class represents the DSMLv2 Parser. It can be used to parse a DSMLv2 Response input.

Field Summary

Fields

Modifier and Type	Field and Description
private Dsmlv2Container	container The associated DSMLv2 container

Constructor Summary

Constructors

Constructor and Description
Dsmlv2ResponseParser(LdapApiService codec) Creates a new instance of Dsmlv2ResponseParser.

Method Summary

Modifier and Type	Method and Description
BatchResponseDsml	getBatchResponse() Gets the Batch Response or null if the it has not been parsed yet
DsmlDecorator<? extends Response>	getNextResponse() Returns the next Request or null if there's no more request
void	parse() Launches the parsing on the input
void	parseAllResponses() Parses all the responses
void	parseBatchResponse() Launches the parsing of the Batch Response only
private static void	processTag(Dsmlv2Container container, int tagType) Processes the task required in the grammar to the given tag type
void	setInput(java.io.InputStream inputStream, java.lang.String inputEncoding) Sets the input stream the parser is going to process
void	setInput(java.lang.String str) Sets the input string the parser is going to parse
void	setInputFile(java.lang.String fileName) Sets the input file the parser is going to parse.

Methods inherited from class java.lang.Object

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

Field Detail

container

private Dsmlv2Container container

The associated DSMLv2 container

Constructor Detail

Dsmlv2ResponseParser

public Dsmlv2ResponseParser(LdapApiService codec)
                     throws org.xmlpull.v1.XmlPullParserException

Creates a new instance of Dsmlv2ResponseParser.

Throws:

org.xmlpull.v1.XmlPullParserException - if an error occurs while the initialization of the parser

Method Detail

setInput

public void setInput(java.lang.String str)
              throws org.xmlpull.v1.XmlPullParserException

Sets the input string the parser is going to parse

Parameters:

str - the string the parser is going to parse

Throws:

org.xmlpull.v1.XmlPullParserException - if an error occurs in the parser

setInputFile

public void setInputFile(java.lang.String fileName)
                  throws java.io.FileNotFoundException,
                         org.xmlpull.v1.XmlPullParserException

Sets the input file the parser is going to parse. Default charset is used.

Parameters:

fileName - the name of the file

Throws:

java.io.FileNotFoundException - if the file does not exist

org.xmlpull.v1.XmlPullParserException - if an error occurs in the parser

setInput

public void setInput(java.io.InputStream inputStream,
                     java.lang.String inputEncoding)
              throws org.xmlpull.v1.XmlPullParserException

Sets the input stream the parser is going to process

Parameters:

inputStream - contains a raw byte input stream of possibly unknown encoding (when inputEncoding is null)

inputEncoding - if not null it MUST be used as encoding for inputStream

Throws:

org.xmlpull.v1.XmlPullParserException - if an error occurs in the parser

parse

public void parse()
           throws org.xmlpull.v1.XmlPullParserException,
                  java.io.IOException

Launches the parsing on the input

Throws:

org.xmlpull.v1.XmlPullParserException - when an unrecoverable error occurs

java.io.IOException - when an IO exception occurs

parseBatchResponse

public void parseBatchResponse()
                        throws org.xmlpull.v1.XmlPullParserException

Launches the parsing of the Batch Response only

Throws:

org.xmlpull.v1.XmlPullParserException - if an error occurs in the parser

processTag

private static void processTag(Dsmlv2Container container,
                               int tagType)
                        throws org.xmlpull.v1.XmlPullParserException

Processes the task required in the grammar to the given tag type

Parameters:

container - the DSML container

tagType - the tag type

Throws:

org.xmlpull.v1.XmlPullParserException - when an error occurs during the parsing

getBatchResponse

public BatchResponseDsml getBatchResponse()

Gets the Batch Response or null if the it has not been parsed yet

Returns:

the Batch Response or null if the it has not been parsed yet

getNextResponse

public DsmlDecorator<? extends Response> getNextResponse()
                                                  throws org.xmlpull.v1.XmlPullParserException

Returns the next Request or null if there's no more request

Returns:

the next Request or null if there's no more request

Throws:

org.xmlpull.v1.XmlPullParserException - when an error occurs during the parsing

parseAllResponses

public void parseAllResponses()
                       throws org.xmlpull.v1.XmlPullParserException

Parses all the responses

Throws:

org.xmlpull.v1.XmlPullParserException - when an error occurs during the parsing