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

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: URLInputSource.hpp,v $
  58.  * Revision 1.8  2000/12/14 18:49:56  tng
  59.  * Fix API document generation warning: "Warning: end of member group without matching begin"
  60.  *
  61.  * Revision 1.7  2000/02/24 20:00:22  abagchi
  62.  * Swat for removing Log from API docs
  63.  *
  64.  * Revision 1.6  2000/02/15 23:59:07  roddey
  65.  * More updated documentation of Framework classes.
  66.  *
  67.  * Revision 1.5  2000/02/15 01:21:30  roddey
  68.  * Some initial documentation improvements. More to come...
  69.  *
  70.  * Revision 1.4  2000/02/06 07:47:46  rahulj
  71.  * Year 2K copyright swat.
  72.  *
  73.  * Revision 1.3  2000/01/26 18:56:02  roddey
  74.  * Needed to include XMLURL.hpp so that it compiles standalone.
  75.  *
  76.  * Revision 1.2  2000/01/15 01:26:16  rahulj
  77.  * Added support for HTTP to the parser using libWWW 5.2.8.
  78.  * Renamed URL.[ch]pp to XMLURL.[ch]pp and like wise for the class name.
  79.  * Only tested under NT 4.0 SP 5.
  80.  * Removed URL.hpp from files where it was not used.
  81.  *
  82.  * Revision 1.1  2000/01/12 00:13:26  roddey
  83.  * These were moved from internal/ to framework/, which was something that should have
  84.  * happened long ago. They are really framework type of classes.
  85.  *
  86.  * Revision 1.1.1.1  1999/11/09 01:08:18  twl
  87.  * Initial checkin
  88.  *
  89.  * Revision 1.2  1999/11/08 20:44:44  rahul
  90.  * Swat for adding in Product name and CVS comment log variable.
  91.  *
  92.  */
  93. #if !defined(URLINPUTSOURCE_HPP)
  94. #define URLINPUTSOURCE_HPP
  95. #include <util/XMLURL.hpp>
  96. #include <sax/InputSource.hpp>
  97. class BinInputStream;
  98. /**
  99.  *  This class is a derivative of the standard InputSource class. It provides
  100.  *  for the parser access to data which is referenced via a URL, as apposed to
  101.  *  a local file name. The URL can be provided via an XMLURL class, as a fully
  102.  *  qualified system id, or a base system id and a system id which may be
  103.  *  fully qualified or may be relative to the base.
  104.  *
  105.  *  As with all InputSource derivatives. The primary objective of an input
  106.  *  source is to create an input stream via which the parser can spool in
  107.  *  data from the referenced source.
  108.  *
  109.  *  Note that the parse system does not necessarily support URL based XML
  110.  *  entities out of the box. Support for socket based access is optional and
  111.  *  controlled by the per-platform support.
  112.  */
  113. class XMLPARSER_EXPORT URLInputSource : public InputSource
  114. {
  115. public :
  116.     // -----------------------------------------------------------------------
  117.     //  Constructors and Destructor
  118.     // -----------------------------------------------------------------------
  119.     /** @name Constructors */
  120.     //@{
  121.     /**
  122.       * This constructor accepts an already built URL. It is assumed that
  123.       * it is correct and it will be used as is. In this case, no public id
  124.       * accepted, but it can still be set via the parent class' setPublicId()
  125.       * method.
  126.       *
  127.       * @param  urlId   The URL which holds the system id of the entity
  128.       *                 to parse.
  129.       */
  130.     URLInputSource(const XMLURL& urlId);
  131.     /**
  132.      *  This constructor takes a base system id URL and a possibly relative
  133.      *  system id. The relative part is parsed and, if it is indeed relative,
  134.      *  it will be made relative to the passed base id. Otherwise, it will be
  135.      *  taken as is.
  136.      *
  137.      *  @param  baseId      The base system id URL which provides the base
  138.      *                      for any relative id part.
  139.      *
  140.      *  @param  systemId    The possibly relative system id URL. If its relative
  141.      *                      its based on baseId, else its taken as is.
  142.      */
  143.     URLInputSource
  144.     (
  145.         const   XMLCh* const    baseId
  146.         , const XMLCh* const    systemId
  147.     );
  148.     /**
  149.      *  This constructor is indentical to the previous one, except that it also
  150.      *  allows you to set a public id if you want to.
  151.      *
  152.      *  @param  baseId      The base system id URL which provides the base
  153.      *                      for any relative id part.
  154.      *
  155.      *  @param  systemId    The possibly relative system id URL. If its relative
  156.      *                      its based on baseId, else its taken as is.
  157.      *
  158.      *  @param  publicId    The optional public id to set. This is just passed
  159.      *                      on to the parent class for storage.
  160.      */
  161.     URLInputSource
  162.     (
  163.         const   XMLCh* const    baseId
  164.         , const XMLCh* const    systemId
  165.         , const XMLCh* const    publicId
  166.     );
  167.     /**
  168.      *  This constructor is identical to the second constructor above, except that
  169.      *  it accepts the relative system id part as a local code page string and
  170.      *  just transcodes it internally, as a convenience.
  171.      *
  172.      *  @param  baseId      The base system id URL which provides the base
  173.      *                      for any relative id part.
  174.      *
  175.      *  @param  systemId    The possibly relative system id URL. If its relative
  176.      *                      its based on baseId, else its taken as is.
  177.      */
  178.     URLInputSource
  179.     (
  180.         const   XMLCh* const    baseId
  181.         , const char* const     systemId
  182.     );
  183.     /**
  184.      *  This constructor is identical to the third constructor above, except that
  185.      *  it accepts the relative and public ids as local code page strings and just
  186.      *  transcodes them internally, as a convenience.
  187.      *
  188.      *  @param  baseId      The base system id URL which provides the base
  189.      *                      for any relative id part.
  190.      *
  191.      *  @param  systemId    The possibly relative system id URL. If its relative
  192.      *                      its based on baseId, else its taken as is.
  193.      *
  194.      *  @param  publicId    The optional public id to set. This is just passed
  195.      *                      on to the parent class for storage.
  196.      *                      on to the parent class for storage.
  197.      */
  198.     URLInputSource
  199.     (
  200.         const   XMLCh* const    baseId
  201.         , const char* const     systemId
  202.         , const char* const     publicId
  203.     );
  204.     //@}
  205.     /** @name Destructor */
  206.     //@{
  207.     ~URLInputSource();
  208.     //@}
  209.     // -----------------------------------------------------------------------
  210.     //  Virtual input source interface
  211.     // -----------------------------------------------------------------------
  212.     /** @name Virtual methods */
  213.     //@{
  214.     /**
  215.      * This method will return a binary input stream derivative that will
  216.      * parse from the source refered to by the URL system id.
  217.      */
  218.     BinInputStream* makeStream() const;
  219.     //@}
  220.     // -----------------------------------------------------------------------
  221.     //  Getter methods
  222.     // -----------------------------------------------------------------------
  223.     /** @name Getter methods */
  224.     //@{
  225.     /**
  226.       * This method will return a const reference to the URL member which
  227.       * contains the system id in pre-parsed URL form. If you just want the
  228.       * string format, call getSystemId() on the parent class.
  229.       *
  230.       * @return A const reference to a URL object that contains the current
  231.       *         system id set for this input source.
  232.       */
  233.     const XMLURL& urlSrc() const;
  234.     //@}
  235. private :
  236.     // -----------------------------------------------------------------------
  237.     //  Private data members
  238.     //
  239.     //  fURL
  240.     //      This is the URL created from the passed ids.
  241.     // -----------------------------------------------------------------------
  242.     XMLURL fURL;
  243. };
  244. inline const XMLURL& URLInputSource::urlSrc() const
  245. {
  246.     return fURL;
  247. }
  248. #endif