URLInputSource.hpp Source File

00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Xerces" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache\@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation, and was
00051  * originally based on software copyright (c) 1999, International
00052  * Business Machines, Inc., http://www.ibm.com .  For more information
00053  * on the Apache Software Foundation, please see
00054  * <http://www.apache.org/>.
00055  */
00056 
00057 /*
00058  * $Log: URLInputSource.hpp,v $
00059  * Revision 1.4  2003/12/01 23:23:25  neilg
00060  * fix for bug 25118; thanks to Jeroen Witmond
00061  *
00062  * Revision 1.3  2003/05/16 21:36:55  knoaman
00063  * Memory manager implementation: Modify constructors to pass in the memory manager.
00064  *
00065  * Revision 1.2  2002/11/04 15:00:21  tng
00066  * C++ Namespace Support.
00067  *
00068  * Revision 1.1.1.1  2002/02/01 22:21:50  peiyongz
00069  * sane_include
00070  *
00071  * Revision 1.8  2000/12/14 18:49:56  tng
00072  * Fix API document generation warning: "Warning: end of member group without matching begin"
00073  *
00074  * Revision 1.7  2000/02/24 20:00:22  abagchi
00075  * Swat for removing Log from API docs
00076  *
00077  * Revision 1.6  2000/02/15 23:59:07  roddey
00078  * More updated documentation of Framework classes.
00079  *
00080  * Revision 1.5  2000/02/15 01:21:30  roddey
00081  * Some initial documentation improvements. More to come...
00082  *
00083  * Revision 1.4  2000/02/06 07:47:46  rahulj
00084  * Year 2K copyright swat.
00085  *
00086  * Revision 1.3  2000/01/26 18:56:02  roddey
00087  * Needed to include XMLURL.hpp so that it compiles standalone.
00088  *
00089  * Revision 1.2  2000/01/15 01:26:16  rahulj
00090  * Added support for HTTP to the parser using libWWW 5.2.8.
00091  * Renamed URL.[ch]pp to XMLURL.[ch]pp and like wise for the class name.
00092  * Only tested under NT 4.0 SP 5.
00093  * Removed URL.hpp from files where it was not used.
00094  *
00095  * Revision 1.1  2000/01/12 00:13:26  roddey
00096  * These were moved from internal/ to framework/, which was something that should have
00097  * happened long ago. They are really framework type of classes.
00098  *
00099  * Revision 1.1.1.1  1999/11/09 01:08:18  twl
00100  * Initial checkin
00101  *
00102  * Revision 1.2  1999/11/08 20:44:44  rahul
00103  * Swat for adding in Product name and CVS comment log variable.
00104  *
00105  */
00106 
00107 
00108 
00109 #if !defined(URLINPUTSOURCE_HPP)
00110 #define URLINPUTSOURCE_HPP
00111 
00112 #include <xercesc/util/XMLURL.hpp>
00113 #include <xercesc/sax/InputSource.hpp>
00114 
00115 XERCES_CPP_NAMESPACE_BEGIN
00116 
00117 class BinInputStream;
00118 
00134 class  URLInputSource : public InputSource
00135 {
00136 public :
00137     // -----------------------------------------------------------------------
00138     //  Constructors and Destructor
00139     // -----------------------------------------------------------------------
00140 
00143 
00155     URLInputSource
00156     (
00157         const XMLURL& urlId
00158         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
00159     );
00160 
00161 
00176     URLInputSource
00177     (
00178         const   XMLCh* const    baseId
00179         , const XMLCh* const    systemId
00180         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
00181     );
00182 
00199     URLInputSource
00200     (
00201         const   XMLCh* const    baseId
00202         , const XMLCh* const    systemId
00203         , const XMLCh* const    publicId
00204         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
00205     );
00206 
00207 
00222     URLInputSource
00223     (
00224         const   XMLCh* const    baseId
00225         , const char* const     systemId
00226         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
00227     );
00228 
00247     URLInputSource
00248     (
00249         const   XMLCh* const    baseId
00250         , const char* const     systemId
00251         , const char* const     publicId
00252         , MemoryManager* const  manager = XMLPlatformUtils::fgMemoryManager
00253     );
00254 
00256 
00259     ~URLInputSource();
00261 
00262 
00263     // -----------------------------------------------------------------------
00264     //  Virtual input source interface
00265     // -----------------------------------------------------------------------
00266 
00269 
00274     BinInputStream* makeStream() const;
00275 
00277 
00278 
00279     // -----------------------------------------------------------------------
00280     //  Getter methods
00281     // -----------------------------------------------------------------------
00282 
00285 
00294     const XMLURL& urlSrc() const;
00295 
00297 
00298 
00299 private :
00300     // -----------------------------------------------------------------------
00301     //  Private data members
00302     //
00303     //  fURL
00304     //      This is the URL created from the passed ids.
00305     // -----------------------------------------------------------------------
00306     XMLURL fURL;
00307 };
00308 
00309 
00310 inline const XMLURL& URLInputSource::urlSrc() const
00311 {
00312     return fURL;
00313 }
00314 
00315 XERCES_CPP_NAMESPACE_END
00316 
00317 #endif