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

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