org.apache.directory.shared.dsmlv2
Class Dsmlv2ResponseParser

java.lang.Object
  extended by org.apache.directory.shared.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.

Version:
$Rev$, $Date$
Author:
Apache Directory Project

Constructor Summary
Dsmlv2ResponseParser()
          Creates a new instance of Dsmlv2ResponseParser.
 
Method Summary
 BatchResponse getBatchResponse()
          Gets the Batch Response or null if the it has not been parsed yet
 LdapResponseCodec 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
 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
 

Constructor Detail

Dsmlv2ResponseParser

public Dsmlv2ResponseParser()
                     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 java.io.FileNotFoundException,
                     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
java.io.FileNotFoundException

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

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

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

getBatchResponse

public BatchResponse 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 LdapResponseCodec 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


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.