XMLURL.hpp Source File

| API Docs for SAX and DOM |

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# XMLURL.hpp

Go to the documentation of this file.

    00001 /*
    00002  * The Apache Software License, Version 1.1
    00003  *
    00004  * Copyright (c) 1999-2003 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: XMLURL.hpp,v 1.9 2003/05/18 14:02:05 knoaman Exp $
    00059  */
    00060
    00061 #if !defined(XMLURL_HPP)
    00062 #define XMLURL_HPP
    00063
    00064 #include <xercesc/util/PlatformUtils.hpp>
    00065
    00066 XERCES_CPP_NAMESPACE_BEGIN
    00067
    00068 class BinInputStream;
    00069
    00070 //
    00071 //  This class supports file, http, and ftp style URLs. All others are
    00072 //  rejected
    00073 //
    00074 class  XMLURL : public XMemory
    00075 {
    00076 public:
    00077     // -----------------------------------------------------------------------
    00078     //  Class types
    00079     //
    00080     //  And they must remain in this order because they are indexes into an
    00081     //  array internally!
    00082     // -----------------------------------------------------------------------
    00083     enum Protocols
    00084     {
    00085         File
    00086         , HTTP
    00087         , FTP
    00088
    00089         , Protocols_Count
    00090         , Unknown
    00091     };
    00092
    00093
    00094     // -----------------------------------------------------------------------
    00095     //  Public static methods
    00096     // -----------------------------------------------------------------------
    00097     static Protocols lookupByName(const XMLCh* const protoName);
    00098
    00099
    00100     // -----------------------------------------------------------------------
    00101     //  Constructors and Destructor
    00102     // -----------------------------------------------------------------------
    00103     XMLURL(MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
    00104     XMLURL
    00105     (
    00106         const   XMLCh* const    baseURL
    00107         , const XMLCh* const    relativeURL
    00108         , MemoryManager* const manager  = XMLPlatformUtils::fgMemoryManager
    00109     );
    00110     XMLURL
    00111     (
    00112         const   XMLCh* const    baseURL
    00113         , const char* const     relativeURL
    00114         , MemoryManager* const manager  = XMLPlatformUtils::fgMemoryManager
    00115     );
    00116     XMLURL
    00117     (
    00118         const   XMLURL&         baseURL
    00119         , const XMLCh* const    relativeURL
    00120     );
    00121     XMLURL
    00122     (
    00123         const   XMLURL&         baseURL
    00124         , const char* const     relativeURL
    00125     );
    00126     XMLURL
    00127     (
    00128         const   XMLCh* const    urlText
    00129         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
    00130     );
    00131     XMLURL
    00132     (
    00133         const   char* const     urlText
    00134         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
    00135     );
    00136     XMLURL(const XMLURL& toCopy);
    00137     virtual ~XMLURL();
    00138
    00139
    00140     // -----------------------------------------------------------------------
    00141     //  Operators
    00142     // -----------------------------------------------------------------------
    00143     XMLURL& operator=(const XMLURL& toAssign);
    00144     bool operator==(const XMLURL& toCompare) const;
    00145     bool operator!=(const XMLURL& toCompare) const;
    00146
    00147
    00148     // -----------------------------------------------------------------------
    00149     //  Getter methods
    00150     // -----------------------------------------------------------------------
    00151     const XMLCh* getFragment() const;
    00152     const XMLCh* getHost() const;
    00153     const XMLCh* getPassword() const;
    00154     const XMLCh* getPath() const;
    00155     unsigned int getPortNum() const;
    00156     Protocols getProtocol() const;
    00157     const XMLCh* getProtocolName() const;
    00158     const XMLCh* getQuery() const;
    00159     const XMLCh* getURLText() const;
    00160     const XMLCh* getUser() const;
    00161     MemoryManager* getMemoryManager() const;
    00162
    00163
    00164     // -----------------------------------------------------------------------
    00165     //  Setter methods
    00166     // -----------------------------------------------------------------------
    00167     void setURL(const XMLCh* const urlText);
    00168     void setURL
    00169     (
    00170         const   XMLCh* const    baseURL
    00171         , const XMLCh* const    relativeURL
    00172     );
    00173     void setURL
    00174     (
    00175         const   XMLURL&         baseURL
    00176         , const XMLCh* const    relativeURL
    00177     );
    00178
    00179
    00180     // -----------------------------------------------------------------------
    00181     //  Miscellaneous methods
    00182     // -----------------------------------------------------------------------
    00183     bool isRelative() const;
    00184     bool hasInvalidChar() const;
    00185     BinInputStream* makeNewStream() const;
    00186     void makeRelativeTo(const XMLCh* const baseURLText);
    00187     void makeRelativeTo(const XMLURL& baseURL);
    00188
    00189
    00190 private:
    00191     // -----------------------------------------------------------------------
    00192     //  Private helper methods
    00193     // -----------------------------------------------------------------------
    00194     void buildFullText();
    00195     void cleanup();
    00196     bool conglomerateWithBase(const XMLURL& baseURL, bool useExceptions=true);
    00197     void parse
    00198     (
    00199         const   XMLCh* const    urlText
    00200     );
    00201
    00202
    00203     // -----------------------------------------------------------------------
    00204     //  Data members
    00205     //
    00206     //  fFragment
    00207     //      The fragment part of the URL, if any. If none, its a null.
    00208     //
    00209     //  fHost
    00210     //      The host part of the URL that was parsed out. This one will often
    00211     //      be null (or "localhost", which also means the current machine.)
    00212     //
    00213     //  fPassword
    00214     //      The password found, if any. If none then its a null.
    00215     //
    00216     //  fPath
    00217     //      The path part of the URL that was parsed out, if any. If none,
    00218     //      then its a null.
    00219     //
    00220     //  fPortNum
    00221     //      The port that was indicated in the URL. If no port was provided
    00222     //      explicitly, then its left zero.
    00223     //
    00224     //  fProtocol
    00225     //      Indicates the type of the URL's source. The text of the prefix
    00226     //      can be gotten from this.
    00227     //
    00228     //  fQuery
    00229     //      The query part of the URL, if any. If none, then its a null.
    00230     //
    00231     //  fUser
    00232     //      The username found, if any. If none, then its a null.
    00233     //
    00234     //  fURLText
    00235     //      This is a copy of the URL text, after it has been taken apart,
    00236     //      made relative if needed, canonicalized, and then put back
    00237     //      together. Its only created upon demand.
    00238     //
    00239     //  fHasInvalidChar
    00240     //      This indicates if the URL Text contains invalid characters as per
    00241     //      RFC 2396 standard.
    00242     // -----------------------------------------------------------------------
    00243     MemoryManager*  fMemoryManager;
    00244     XMLCh*          fFragment;
    00245     XMLCh*          fHost;
    00246     XMLCh*          fPassword;
    00247     XMLCh*          fPath;
    00248     unsigned int    fPortNum;
    00249     Protocols       fProtocol;
    00250     XMLCh*          fQuery;
    00251     XMLCh*          fUser;
    00252     XMLCh*          fURLText;
    00253     bool            fHasInvalidChar;
    00254 };
    00255
    00256
    00257 // ---------------------------------------------------------------------------
    00258 //  XMLURL: Public operators
    00259 // ---------------------------------------------------------------------------
    00260 inline bool XMLURL::operator!=(const XMLURL& toCompare) const
    00261 {
    00262     return !operator==(toCompare);
    00263 }
    00264
    00265
    00266 // ---------------------------------------------------------------------------
    00267 //  XMLURL: Getter methods
    00268 // ---------------------------------------------------------------------------
    00269 inline const XMLCh* XMLURL::getFragment() const
    00270 {
    00271     return fFragment;
    00272 }
    00273
    00274 inline const XMLCh* XMLURL::getHost() const
    00275 {
    00276     return fHost;
    00277 }
    00278
    00279 inline const XMLCh* XMLURL::getPassword() const
    00280 {
    00281     return fPassword;
    00282 }
    00283
    00284 inline const XMLCh* XMLURL::getPath() const
    00285 {
    00286     return fPath;
    00287 }
    00288
    00289 inline XMLURL::Protocols XMLURL::getProtocol() const
    00290 {
    00291     return fProtocol;
    00292 }
    00293
    00294 inline const XMLCh* XMLURL::getQuery() const
    00295 {
    00296     return fQuery;
    00297 }
    00298
    00299 inline const XMLCh* XMLURL::getUser() const
    00300 {
    00301     return fUser;
    00302 }
    00303
    00304 inline const XMLCh* XMLURL::getURLText() const
    00305 {
    00306     //
    00307     //  Fault it in if not already. Since this is a const method and we
    00308     //  can't use mutable members due the compilers we have to support,
    00309     //  we have to cast off the constness.
    00310     //
    00311     if (!fURLText)
    00312         ((XMLURL*)this)->buildFullText();
    00313
    00314     return fURLText;
    00315 }
    00316
    00317 inline MemoryManager* XMLURL::getMemoryManager() const
    00318 {
    00319     return fMemoryManager;
    00320 }
    00321
    00322 MakeXMLException(MalformedURLException, )
    00323
    00324 XERCES_CPP_NAMESPACE_END
    00325
    00326
    00327 #endif

Copyright © 2000 The Apache Software Foundation. All Rights Reserved.