src/URL.h

   1 /*
   2  * $Id$
   3  *
   4  *
   5  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   6  * ----------------------------------------------------------
   7  *
   8  *  Squid is the result of efforts by numerous individuals from
   9  *  the Internet community; see the CONTRIBUTORS file for full
  10  *  details.   Many organizations have provided support for Squid's
  11  *  development; see the SPONSORS file for full details.  Squid is
  12  *  Copyrighted (C) 2001 by the Regents of the University of
  13  *  California; see the COPYRIGHT file for full details.  Squid
  14  *  incorporates software developed and/or copyrighted by other
  15  *  sources; see the CREDITS file for full details.
  16  *
  17  *  This program is free software; you can redistribute it and/or modify
  18  *  it under the terms of the GNU General Public License as published by
  19  *  the Free Software Foundation; either version 2 of the License, or
  20  *  (at your option) any later version.
  21  *
  22  *  This program is distributed in the hope that it will be useful,
  23  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  *  You should have received a copy of the GNU General Public License
  28  *  along with this program; if not, write to the Free Software
  29  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  30  *
  31  */
  32
  33 #ifndef SQUID_SRC_URL_H
  34 #define SQUID_SRC_URL_H
  35
  36 #include "MemPool.h"
  37 #include "URLScheme.h"
  38
  39 /**
  40  \ingroup POD
  41  *
  42  * The URL class represents a Uniform Resource Location
  43  */
  44 class URL
  45 {
  46
  47 public:
  48
  49     MEMPROXY_CLASS(URL);
  50     URL();
  51     URL(URLScheme const &);
  52     URLScheme const & getScheme() const {return scheme; }
  53
  54 private:
  55     /**
  56      \par
  57      * The scheme of this URL. This has the 'type code' smell about it.
  58      * In future we may want to make the methods that dispatch based on
  59      * the scheme virtual and have a class per protocol.
  60      \par
  61      * On the other hand, having Protocol as an explicit concept is useful,
  62      * see for instance the ACLProtocol acl type. One way to represent this
  63      * is to have one prototype URL with no host etc for each scheme,
  64      * another is to have an explicit scheme class, and then each URL class
  65      * could be a subclass of the scheme. Another way is one instance of
  66      * a URLScheme class instance for each URLScheme we support, and one URL
  67      * class for each manner of treating the scheme : a Hierarchical URL, a
  68      * non-hierarchical URL etc.
  69      \par
  70      * Deferring the decision, its a type code for now. RBC 20060507.
  71      \par
  72      * In order to make taking any of these routes easy, scheme is private
  73      * and immutable, only settable at construction time,
  74      */
  75     URLScheme const scheme;
  76 };
  77
  78 MEMPROXY_CLASS_INLINE(URL);
  79
  80 #endif /* SQUID_SRC_URL_H_H */