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.8  2000/12/14 18:49:56  tng

00060  * Fix API document generation warning: "Warning: end of member group without matching begin"

00061  *
00062  * Revision 1.7  2000/02/24 20:00:22  abagchi

00063  * Swat for removing Log from API docs

00064  *
00065  * Revision 1.6  2000/02/15 23:59:07  roddey

00066  * More updated documentation of Framework classes.

00067  *
00068  * Revision 1.5  2000/02/15 01:21:30  roddey

00069  * Some initial documentation improvements. More to come...

00070  *
00071  * Revision 1.4  2000/02/06 07:47:46  rahulj

00072  * Year 2K copyright swat.

00073  *
00074  * Revision 1.3  2000/01/26 18:56:02  roddey

00075  * Needed to include XMLURL.hpp so that it compiles standalone.

00076  *
00077  * Revision 1.2  2000/01/15 01:26:16  rahulj

00078  * Added support for HTTP to the parser using libWWW 5.2.8.

00079  * Renamed URL.[ch]pp to XMLURL.[ch]pp and like wise for the class name.

00080  * Only tested under NT 4.0 SP 5.

00081  * Removed URL.hpp from files where it was not used.

00082  *
00083  * Revision 1.1  2000/01/12 00:13:26  roddey

00084  * These were moved from internal/ to framework/, which was something that should have

00085  * happened long ago. They are really framework type of classes.

00086  *
00087  * Revision 1.1.1.1  1999/11/09 01:08:18  twl

00088  * Initial checkin

00089  *
00090  * Revision 1.2  1999/11/08 20:44:44  rahul

00091  * Swat for adding in Product name and CVS comment log variable.

00092  *
00093  */
00094 
00095 
00096 
00097 #if !defined(URLINPUTSOURCE_HPP)
00098 #define URLINPUTSOURCE_HPP
00099 
00100 #include <util/XMLURL.hpp>
00101 #include <sax/InputSource.hpp>
00102 
00103 class BinInputStream;
00104 
00120 class  URLInputSource : public InputSource
00121 {
00122 public :
00123     // -----------------------------------------------------------------------
00124     //  Constructors and Destructor
00125     // -----------------------------------------------------------------------
00126 
00129 
00139     URLInputSource(const XMLURL& urlId);
00140 
00141 
00154     URLInputSource
00155     (
00156         const   XMLCh* const    baseId
00157         , const XMLCh* const    systemId
00158     );
00159 
00173     URLInputSource
00174     (
00175         const   XMLCh* const    baseId
00176         , const XMLCh* const    systemId
00177         , const XMLCh* const    publicId
00178     );
00179 
00180 
00192     URLInputSource
00193     (
00194         const   XMLCh* const    baseId
00195         , const char* const     systemId
00196     );
00197 
00213     URLInputSource
00214     (
00215         const   XMLCh* const    baseId
00216         , const char* const     systemId
00217         , const char* const     publicId
00218     );
00219 
00221 
00224     ~URLInputSource();
00226 
00227 
00228     // -----------------------------------------------------------------------
00229     //  Virtual input source interface
00230     // -----------------------------------------------------------------------
00231 
00234 
00239     BinInputStream* makeStream() const;
00240 
00242 
00243 
00244     // -----------------------------------------------------------------------
00245     //  Getter methods
00246     // -----------------------------------------------------------------------
00247 
00250 
00259     const XMLURL& urlSrc() const;
00260 
00262 
00263 
00264 private :
00265     // -----------------------------------------------------------------------
00266     //  Private data members
00267     //
00268     //  fURL
00269     //      This is the URL created from the passed ids.
00270     // -----------------------------------------------------------------------
00271     XMLURL fURL;
00272 };
00273 
00274 
00275 inline const XMLURL& URLInputSource::urlSrc() const

00276 {
00277     return fURL;
00278 }
00279 
00280 #endif