XMLNetAccessor.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  * $Id: XMLNetAccessor.hpp,v 1.9 2000/05/04 02:43:45 aruna1 Exp $

00059  */
00060 
00061 #if !defined(XMLNETACCESSOR_HPP)
00062 #define XMLNETACCESSOR_HPP
00063 
00064 #include <util/XercesDefs.hpp>
00065 #include <util/XMLURL.hpp>
00066 #include <util/XMLException.hpp>
00067 
00068 
00069 class BinInputStream;
00070 
00071 
00072 MakeXMLException(NetAccessorException, )
00073 
00074 
00075 
00076 //
00077 //  This class is an abstract interface via which the URL class accesses
00078 //  net access services. When any source URL is not in effect a local file
00079 //  path, then the URL class is used to look at it. Then the URL class can
00080 //  be asked to make a binary input stream via which the referenced resource
00081 //  can be read in.
00082 //
00083 //  The URL class will use an object derived from this class to create a
00084 //  binary stream for the URL to return. The object it uses is provided by
00085 //  the platform utils, and is actually provided by the per-platform init
00086 //  code so each platform can decide what actual implementation it wants to
00087 //  use.
00088 //
00089 class  XMLNetAccessor
00090 {
00091 public :
00092     // -----------------------------------------------------------------------
00093     //  Virtual destructor
00094     // -----------------------------------------------------------------------
00095     virtual ~XMLNetAccessor()

00096     {
00097     }
00098 
00099 
00100     // -----------------------------------------------------------------------
00101     //  The virtual net accessor interface
00102     // -----------------------------------------------------------------------
00103     virtual const XMLCh* getId() const = 0;
00104 
00105     virtual BinInputStream* makeNew
00106     (
00107         const   XMLURL&                 urlSrc
00108     ) = 0;
00109 
00110 
00111 protected :
00112     // -----------------------------------------------------------------------
00113     //  Hidden constructors
00114     // -----------------------------------------------------------------------
00115     XMLNetAccessor()

00116     {
00117     }
00118 
00119 
00120 private :
00121     // -----------------------------------------------------------------------
00122     //  Unimplemented constructors and operators
00123     // -----------------------------------------------------------------------
00124     XMLNetAccessor(const XMLNetAccessor&);
00125     void operator=(const XMLNetAccessor&);
00126 };
00127 
00128 #endif