EntityResolver.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:8k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  * 
  4.  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  * 
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  * 
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer. 
  13.  * 
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  * 
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:  
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  * 
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written 
  29.  *    permission, please contact apache@apache.org.
  30.  * 
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  * 
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  * 
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Log: EntityResolver.hpp,v $
  58.  * Revision 1.6  2000/03/02 19:54:34  roddey
  59.  * This checkin includes many changes done while waiting for the
  60.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  61.  * available elsewhere.
  62.  *
  63.  * Revision 1.5  2000/02/24 20:12:55  abagchi
  64.  * Swat for removing Log from API docs
  65.  *
  66.  * Revision 1.4  2000/02/12 03:31:55  rahulj
  67.  * Removed duplicate CVS Log entries.
  68.  *
  69.  * Revision 1.3  2000/02/12 01:27:19  aruna1
  70.  * Documentation updated
  71.  *
  72.  * Revision 1.2  2000/02/06 07:47:57  rahulj
  73.  * Year 2K copyright swat.
  74.  *
  75.  * Revision 1.1.1.1  1999/11/09 01:07:44  twl
  76.  * Initial checkin
  77.  *
  78.  * Revision 1.3  1999/11/08 20:44:56  rahul
  79.  * Swat for adding in Product name and CVS comment log variable.
  80.  *
  81.  */
  82. #ifndef ENTITYRESOLVER_HPP
  83. #define ENTITYRESOLVER_HPP
  84. #include <util/XercesDefs.hpp>
  85. class InputSource;
  86. /**
  87.   * Basic interface for resolving entities.
  88.   *
  89.   * <p>If a SAX application needs to implement customized handling
  90.   * for external entities, it must implement this interface and
  91.   * register an instance with the SAX parser using the parser's
  92.   * setEntityResolver method.</p>
  93.   *
  94.   * <p>The parser will then allow the application to intercept any
  95.   * external entities (including the external DTD subset and external
  96.   * parameter entities, if any) before including them.</p>
  97.   *
  98.   * <p>Many SAX applications will not need to implement this interface,
  99.   * but it will be especially useful for applications that build
  100.   * XML documents from databases or other specialised input sources,
  101.   * or for applications that use URI types other than URLs.</p>
  102.   *
  103.   * <p>The following resolver would provide the application
  104.   * with a special character stream for the entity with the system
  105.   * identifier "http://www.myhost.com/today":</p>
  106.   *
  107.   *<pre>
  108.   *#include <sax/EntityResolver.hpp>
  109.   *#include <sax/InputSource.hpp>
  110.   *
  111.   *class MyResolver : public EntityResolver {
  112.   *  public:
  113.   *    InputSource resolveEntity (const XMLCh* const publicId, 
  114.   *                               const XMLCh* const systemId);
  115.   *   ...
  116.   *   };
  117.   *
  118.   *  MyResolver::resolveEntity {
  119.   *    if (XMLString::compareString(systemId, "http://www.myhost.com/today")) {
  120.   *      MyReader* reader = new MyReader();
  121.   *      return new InputSource(reader);
  122.   *    } else {
  123.   *      return null;
  124.   *    }
  125.   *  }
  126.   *
  127.   *</pre>
  128.   *
  129.   * <p>The application can also use this interface to redirect system
  130.   * identifiers to local URIs or to look up replacements in a catalog
  131.   * (possibly by using the public identifier).</p>
  132.   *
  133.   * <p>The HandlerBase class implements the default behaviour for
  134.   * this interface, which is simply always to return null (to request
  135.   * that the parser use the default system identifier).</p>
  136.   *
  137.   * @see Parser#setEntityResolver
  138.   * @see InputSource#InputSource
  139.   * @see HandlerBase#HandlerBase 
  140.   */
  141. class SAX_EXPORT EntityResolver
  142. {
  143. public:
  144.     /** @name Constructors and Destructor */
  145.     //@{
  146.     /** Default Constructor */
  147.     EntityResolver()
  148.     {
  149.     }
  150.     /** Destructor */
  151.     virtual ~EntityResolver()
  152.     {
  153.     }
  154.     //@}
  155.     /** @name The EntityResolver interface */
  156.     //@{
  157.   /**
  158.     * Allow the application to resolve external entities.
  159.     *
  160.     * <p>The Parser will call this method before opening any external
  161.     * entity except the top-level document entity (including the
  162.     * external DTD subset, external entities referenced within the
  163.     * DTD, and external entities referenced within the document
  164.     * element): the application may request that the parser resolve
  165.     * the entity itself, that it use an alternative URI, or that it
  166.     * use an entirely different input source.</p>
  167.     *
  168.     * <p>Application writers can use this method to redirect external
  169.     * system identifiers to secure and/or local URIs, to look up
  170.     * public identifiers in a catalogue, or to read an entity from a
  171.     * database or other input source (including, for example, a dialog
  172.     * box).</p>
  173.     *
  174.     * <p>If the system identifier is a URL, the SAX parser must
  175.     * resolve it fully before reporting it to the application.</p>
  176.     *
  177.     * @param publicId The public identifier of the external entity
  178.     *        being referenced, or null if none was supplied.
  179.     * @param systemId The system identifier of the external entity
  180.     *        being referenced.
  181.     * @return An InputSource object describing the new input source,
  182.     *         or null to request that the parser open a regular
  183.     *         URI connection to the system identifier.
  184.     * @exception SAXException Any SAX exception, possibly
  185.     *            wrapping another exception.
  186.     * @exception IOException An IO exception,
  187.     *            possibly the result of creating a new InputStream
  188.     *            or Reader for the InputSource.
  189.     * @see InputSource#InputSource
  190.     */
  191.     virtual InputSource* resolveEntity
  192.     (
  193.         const   XMLCh* const    publicId
  194.         , const XMLCh* const    systemId
  195.     ) = 0;
  196.     //@}
  197. private :
  198.     /* Unimplemented constructors and operators */
  199.     
  200.     /* Copy constructor */
  201.     EntityResolver(const EntityResolver&);
  202.     /* Assignment operator */
  203.     void operator=(const EntityResolver&);
  204. };
  205. #endif