/* * Copyright 2001-2004 The Apache Software Foundation. *  * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at *  *      http://www.apache.org/licenses/LICENSE-2.0 *  * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. *//* * $Id: XMLUri.hpp,v 1.18 2004/09/08 13:56:25 peiyongz Exp $ * $Log: XMLUri.hpp,v $ * Revision 1.18  2004/09/08 13:56:25  peiyongz * Apache License Version 2.0 * * Revision 1.17  2004/05/25 18:11:47  peiyongz * normalizeURI() added * * Revision 1.16  2004/01/12 22:01:02  cargilld * Minor performance change for handling reserved and unreserved characters. * * Revision 1.15  2003/12/17 00:18:35  cargilld * Update to memory management so that the static memory manager (one used to call Initialize) is only for static data. * * Revision 1.14  2003/12/11 22:21:25  neilg * fixes for the URI implementation to take registry names into account; much thanks to Michael Glavassevich * * Revision 1.13  2003/12/02 17:50:21  neilg * additional fix for bug 25118; once again, thanks to Jeroen Whitmond * * Revision 1.12  2003/10/01 00:20:41  knoaman * Add a static method to check whether a given string is a valid URI. * * Revision 1.11  2003/09/25 22:23:25  peiyongz * Implementation of Serialization/Deserialization * * Revision 1.10  2003/07/25 10:15:16  gareth * Patch by Michael Glavassevich * * The patch fixes Bugzilla #19787, #20006, #20009, #20010 and #20287, and * several other issues. A summary of the changes is listed below: * * 1. Added '[' and ']' to reserved characters as per RFC 2732. * 2. '[' and ']' added in RFC 2732, are not allowed in path segments, but * may appear in the opaque part. * 3. No URI can begin with a ':'. * 4. URI has no scheme if ':' occurs in a URI after '?' or '#', it's part of * the query string or fragment. * 5. Whitespace (even escaped as %20) is not permitted in the authority * portion of a URI. * 6. IPv4 addresses must match 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT "." * 1*3DIGIT. Since RFC 2732. * 7. IPv4 addresses are 32-bit, therefore no segment may be larger than 255. * This isn't expressed by the grammar. * 8. Hostnames cannot end with a '-'. * 9. Labels in a hostname must be 63 bytes or less [RFC 1034]. * 10. Hostnames may be no longer than 255 bytes [RFC 1034]. (That * restriction was already there. I just moved it inwards. * 11. Added support for IPv6 references added in RFC 2732. URIs such as * http://[::ffff:1.2.3.4] are valid. The BNF in RFC 2373 isn't correct. IPv6 * addresses are read according to section 2.2 of RFC 2373. * * Revision 1.9  2003/05/16 06:01:53  knoaman * Partial implementation of the configurable memory manager. * * Revision 1.8  2003/05/15 19:07:46  knoaman * Partial implementation of the configurable memory manager. * * Revision 1.7  2003/01/06 19:43:18  tng * New feature StandardUriConformant to force strict standard uri conformance. * * Revision 1.6  2002/11/21 15:42:39  gareth * Implemented copy constructor and operator =. Patch by Jennifer Schachter. * * Revision 1.5  2002/11/04 15:22:05  tng * C++ Namespace Support. * * Revision 1.4  2002/09/23 18:41:00  tng * DOM L3: Support baseURI.   Add fURIText to XMLUri.   Added by Gareth Reakes and Thomas Ford. * * Revision 1.3  2002/08/23 20:45:24  tng * .Memory leak fix: XMLUri data not deleted if constructor failed. * * Revision 1.2  2002/02/20 18:17:02  tng * [Bug 5977] Warnings on generating apiDocs. * * Revision 1.1.1.1  2002/02/01 22:22:17  peiyongz * sane_include * * Revision 1.3  2001/08/29 19:03:03  peiyongz * Bugzilla# 2816:on AIX 4.2, xlC 3 r ev.1, Compilation error on inline method * * Revision 1.2  2001/08/16 14:09:44  peiyongz * Removed unused ctors and methods * * Revision 1.1  2001/08/10 16:23:41  peiyongz * XMLUri: creation * * */#if !defined(XMLURI_HPP)#define XMLURI_HPP#include <xercesc/util/XMemory.hpp>#include <xercesc/util/XMLString.hpp>#include <xercesc/internal/XSerializable.hpp>#include <xercesc/framework/XMLBuffer.hpp>XERCES_CPP_NAMESPACE_BEGIN/* * This class is a direct port of Java's URI class, to distinguish * itself from the XMLURL, we use the name XMLUri instead of * XMLURI. * * TODO: how to relate XMLUri and XMLURL since URL is part of URI. * */class XMLUTIL_EXPORT XMLUri : public XSerializable, public XMemory{public:    // -----------------------------------------------------------------------    //  Constructors and Destructor    // -----------------------------------------------------------------------    /**     * Construct a new URI from a URI specification string.     *     * If the specification follows the "generic URI" syntax, (two slashes     * following the first colon), the specification will be parsed     * accordingly - setting the     *                           scheme,     *                           userinfo,     *                           host,     *                           port,     *                           path,     *                           querystring and     *                           fragment     * fields as necessary.     *     * If the specification does not follow the "generic URI" syntax,     * the specification is parsed into a     *                           scheme and     *                           scheme-specific part (stored as the path) only.     *     * @param uriSpec the URI specification string (cannot be null or empty)     *     * @param manager Pointer to the memory manager to be used to     *                allocate objects.     *     * ctor# 2     *     */    XMLUri(const XMLCh* const    uriSpec,           MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);    /**     * Construct a new URI from a base URI and a URI specification string.     * The URI specification string may be a relative URI.     *     * @param baseURI the base URI (cannot be null if uriSpec is null or     *                empty)     *     * @param uriSpec the URI specification string (cannot be null or     *                empty if base is null)     *     * @param manager Pointer to the memory manager to be used to     *                allocate objects.     *     * ctor# 7 relative ctor     *     */    XMLUri(const XMLUri* const  baseURI         , const XMLCh* const   uriSpec         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);    /**     * Copy constructor     */    XMLUri(const XMLUri& toCopy);    XMLUri& operator=(const XMLUri& toAssign);    virtual ~XMLUri();    // -----------------------------------------------------------------------    //  Getter methods    // -----------------------------------------------------------------------    /**     * Get the URI as a string specification. See RFC 2396 Section 5.2.     *     * @return the URI string specification     */    const XMLCh* getUriText() const;    /**     * Get the scheme for this URI.     *     * @return the scheme for this URI     */     const XMLCh* getScheme() const;    /**     * Get the userinfo for this URI.     *     * @return the userinfo for this URI (null if not specified).     */     const XMLCh* getUserInfo() const;    /**     * Get the host for this URI.     *     * @return the host for this URI (null if not specified).     */     const XMLCh* getHost() const;    /**     * Get the port for this URI.     *     * @return the port for this URI (-1 if not specified).     */     int getPort() const;         /**     * Get the registry based authority for this URI.     *      * @return the registry based authority (null if not specified).     */     const XMLCh* getRegBasedAuthority() const;    /**     * Get the path for this URI. Note that the value returned is the path     * only and does not include the query string or fragment.     *     * @return the path for this URI.     */     const XMLCh* getPath() const;    /**     * Get the query string for this URI.     *     * @return the query string for this URI. Null is returned if there     *         was no "?" in the URI spec, empty string if there was a     *         "?" but no query string following it.     */     const XMLCh* getQueryString() const;    /**     * Get the fragment for this URI.     *     * @return the fragment for this URI. Null is returned if there     *         was no "#" in the URI spec, empty string if there was a     *         "#" but no fragment following it.     */     const XMLCh* getFragment() const;    // -----------------------------------------------------------------------    //  Setter methods    // -----------------------------------------------------------------------    /**     * Set the scheme for this URI. The scheme is converted to lowercase     * before it is set.     *     * @param newScheme the scheme for this URI (cannot be null)     *     */     void setScheme(const XMLCh* const newScheme);    /**     * Set the userinfo for this URI. If a non-null value is passed in and     * the host value is null, then an exception is thrown.     *     * @param newUserInfo the userinfo for this URI     *     */     void setUserInfo(const XMLCh* const newUserInfo);    /**     * Set the host for this URI. If null is passed in, the userinfo     * field is also set to null and the port is set to -1.     *     * Note: This method overwrites registry based authority if it     * previously existed in this URI.     *     * @param newHost the host for this URI     *     */     void setHost(const XMLCh* const newHost);    /**     * Set the port for this URI. -1 is used to indicate that the port is     * not specified, otherwise valid port numbers are  between 0 and 65535.     * If a valid port number is passed in and the host field is null,     * an exception is thrown.     *     * @param newPort the port number for this URI     *     */     void setPort(int newPort);         /**     * Sets the registry based authority for this URI.     *      * Note: This method overwrites server based authority     * if it previously existed in this URI.     *      * @param newRegAuth the registry based authority for this URI     */     void setRegBasedAuthority(const XMLCh* const newRegAuth);    /**     * Set the path for this URI.     *     * If the supplied path is null, then the     * query string and fragment are set to null as well.     *     * If the supplied path includes a query string and/or fragment,     * these fields will be parsed and set as well.     *     * Note:     *     * For URIs following the "generic URI" syntax, the path     * specified should start with a slash.     *     * For URIs that do not follow the generic URI syntax, this method     * sets the scheme-specific part.     *     * @param newPath the path for this URI (may be null)     *     */     void setPath(const XMLCh* const newPath);    /**     * Set the query string for this URI. A non-null value is valid only     * if this is an URI conforming to the generic URI syntax and     * the path value is not null.     *     * @param newQueryString the query string for this URI     *     */     void setQueryString(const XMLCh* const newQueryString);    /**     * Set the fragment for this URI. A non-null value is valid only     * if this is a URI conforming to the generic URI syntax and     * the path value is not null.     *     * @param newFragment the fragment for this URI     *     */     void setFragment(const XMLCh* const newFragment);     // -----------------------------------------------------------------------    //  Miscellaneous methods    // -----------------------------------------------------------------------    /**     * Determine whether a given string contains only URI characters (also     * called "uric" in RFC 2396). uric consist of all reserved     * characters, unreserved characters and escaped characters.     *     * @return true if the string is comprised of uric, false otherwise     */