| /* |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 1999-2000 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Xerces" and "Apache Software Foundation" must |
| * not be used to endorse or promote products derived from this |
| * software without prior written permission. For written |
| * permission, please contact apache\@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * nor may "Apache" appear in their name, without prior written |
| * permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation, and was |
| * originally based on software copyright (c) 1999, International |
| * Business Machines, Inc., http://www.ibm.com . For more information |
| * on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| /* |
| * $Log$ |
| * Revision 1.8 2000/12/14 18:49:56 tng |
| * Fix API document generation warning: "Warning: end of member group without matching begin" |
| * |
| * Revision 1.7 2000/02/24 20:00:22 abagchi |
| * Swat for removing Log from API docs |
| * |
| * Revision 1.6 2000/02/15 23:59:07 roddey |
| * More updated documentation of Framework classes. |
| * |
| * Revision 1.5 2000/02/15 01:21:30 roddey |
| * Some initial documentation improvements. More to come... |
| * |
| * Revision 1.4 2000/02/06 07:47:46 rahulj |
| * Year 2K copyright swat. |
| * |
| * Revision 1.3 2000/01/26 18:56:02 roddey |
| * Needed to include XMLURL.hpp so that it compiles standalone. |
| * |
| * Revision 1.2 2000/01/15 01:26:16 rahulj |
| * Added support for HTTP to the parser using libWWW 5.2.8. |
| * Renamed URL.[ch]pp to XMLURL.[ch]pp and like wise for the class name. |
| * Only tested under NT 4.0 SP 5. |
| * Removed URL.hpp from files where it was not used. |
| * |
| * Revision 1.1 2000/01/12 00:13:26 roddey |
| * These were moved from internal/ to framework/, which was something that should have |
| * happened long ago. They are really framework type of classes. |
| * |
| * Revision 1.1.1.1 1999/11/09 01:08:18 twl |
| * Initial checkin |
| * |
| * Revision 1.2 1999/11/08 20:44:44 rahul |
| * Swat for adding in Product name and CVS comment log variable. |
| * |
| */ |
| |
| |
| |
| #if !defined(URLINPUTSOURCE_HPP) |
| #define URLINPUTSOURCE_HPP |
| |
| #include <util/XMLURL.hpp> |
| #include <sax/InputSource.hpp> |
| |
| class BinInputStream; |
| |
| /** |
| * This class is a derivative of the standard InputSource class. It provides |
| * for the parser access to data which is referenced via a URL, as apposed to |
| * a local file name. The URL can be provided via an XMLURL class, as a fully |
| * qualified system id, or a base system id and a system id which may be |
| * fully qualified or may be relative to the base. |
| * |
| * As with all InputSource derivatives. The primary objective of an input |
| * source is to create an input stream via which the parser can spool in |
| * data from the referenced source. |
| * |
| * Note that the parse system does not necessarily support URL based XML |
| * entities out of the box. Support for socket based access is optional and |
| * controlled by the per-platform support. |
| */ |
| class XMLPARSER_EXPORT URLInputSource : public InputSource |
| { |
| public : |
| // ----------------------------------------------------------------------- |
| // Constructors and Destructor |
| // ----------------------------------------------------------------------- |
| |
| /** @name Constructors */ |
| //@{ |
| |
| /** |
| * This constructor accepts an already built URL. It is assumed that |
| * it is correct and it will be used as is. In this case, no public id |
| * accepted, but it can still be set via the parent class' setPublicId() |
| * method. |
| * |
| * @param urlId The URL which holds the system id of the entity |
| * to parse. |
| */ |
| URLInputSource(const XMLURL& urlId); |
| |
| |
| /** |
| * This constructor takes a base system id URL and a possibly relative |
| * system id. The relative part is parsed and, if it is indeed relative, |
| * it will be made relative to the passed base id. Otherwise, it will be |
| * taken as is. |
| * |
| * @param baseId The base system id URL which provides the base |
| * for any relative id part. |
| * |
| * @param systemId The possibly relative system id URL. If its relative |
| * its based on baseId, else its taken as is. |
| */ |
| URLInputSource |
| ( |
| const XMLCh* const baseId |
| , const XMLCh* const systemId |
| ); |
| |
| /** |
| * This constructor is indentical to the previous one, except that it also |
| * allows you to set a public id if you want to. |
| * |
| * @param baseId The base system id URL which provides the base |
| * for any relative id part. |
| * |
| * @param systemId The possibly relative system id URL. If its relative |
| * its based on baseId, else its taken as is. |
| * |
| * @param publicId The optional public id to set. This is just passed |
| * on to the parent class for storage. |
| */ |
| URLInputSource |
| ( |
| const XMLCh* const baseId |
| , const XMLCh* const systemId |
| , const XMLCh* const publicId |
| ); |
| |
| |
| /** |
| * This constructor is identical to the second constructor above, except that |
| * it accepts the relative system id part as a local code page string and |
| * just transcodes it internally, as a convenience. |
| * |
| * @param baseId The base system id URL which provides the base |
| * for any relative id part. |
| * |
| * @param systemId The possibly relative system id URL. If its relative |
| * its based on baseId, else its taken as is. |
| */ |
| URLInputSource |
| ( |
| const XMLCh* const baseId |
| , const char* const systemId |
| ); |
| |
| /** |
| * This constructor is identical to the third constructor above, except that |
| * it accepts the relative and public ids as local code page strings and just |
| * transcodes them internally, as a convenience. |
| * |
| * @param baseId The base system id URL which provides the base |
| * for any relative id part. |
| * |
| * @param systemId The possibly relative system id URL. If its relative |
| * its based on baseId, else its taken as is. |
| * |
| * @param publicId The optional public id to set. This is just passed |
| * on to the parent class for storage. |
| * on to the parent class for storage. |
| */ |
| URLInputSource |
| ( |
| const XMLCh* const baseId |
| , const char* const systemId |
| , const char* const publicId |
| ); |
| |
| //@} |
| |
| /** @name Destructor */ |
| //@{ |
| ~URLInputSource(); |
| //@} |
| |
| |
| // ----------------------------------------------------------------------- |
| // Virtual input source interface |
| // ----------------------------------------------------------------------- |
| |
| /** @name Virtual methods */ |
| //@{ |
| |
| /** |
| * This method will return a binary input stream derivative that will |
| * parse from the source refered to by the URL system id. |
| */ |
| BinInputStream* makeStream() const; |
| |
| //@} |
| |
| |
| // ----------------------------------------------------------------------- |
| // Getter methods |
| // ----------------------------------------------------------------------- |
| |
| /** @name Getter methods */ |
| //@{ |
| |
| /** |
| * This method will return a const reference to the URL member which |
| * contains the system id in pre-parsed URL form. If you just want the |
| * string format, call getSystemId() on the parent class. |
| * |
| * @return A const reference to a URL object that contains the current |
| * system id set for this input source. |
| */ |
| const XMLURL& urlSrc() const; |
| |
| //@} |
| |
| |
| private : |
| // ----------------------------------------------------------------------- |
| // Private data members |
| // |
| // fURL |
| // This is the URL created from the passed ids. |
| // ----------------------------------------------------------------------- |
| XMLURL fURL; |
| }; |
| |
| |
| inline const XMLURL& URLInputSource::urlSrc() const |
| { |
| return fURL; |
| } |
| |
| #endif |
