Home | History | Annotate | Download | only in jbosh
      1 /*
      2  * Copyright 2009 Mike Cumings
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *   http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 package com.kenai.jbosh;
     18 
     19 /**
     20  * Interface for parser implementations to implement in order to abstract the
     21  * business of XML parsing out of the Body class.  This allows us to leverage
     22  * a variety of parser implementations to gain performance advantages.
     23  */
     24 interface BodyParser {
     25 
     26     /**
     27      * Parses the XML message, extracting the useful data from the initial
     28      * body element and returning it in a results object.
     29      *
     30      * @param xml XML to parse
     31      * @return useful data parsed out of the XML
     32      * @throws BOSHException on parse error
     33      */
     34     BodyParserResults parse(String xml) throws BOSHException;
     35 
     36 }
     37