xmltooling/io/HTTPRequest.h

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file xmltooling/io/HTTPRequest.h
  19  *
  20  * Interface to HTTP requests
  21  */
  22
  23 #ifndef __xmltooling_httpreq_h__
  24 #define __xmltooling_httpreq_h__
  25
  26 #include <xmltooling/io/GenericRequest.h>
  27
  28 #include <map>
  29
  30 namespace xmltooling {
  31
  32 #if defined (_MSC_VER)
  33     #pragma warning( push )
  34     #pragma warning( disable : 4251 )
  35 #endif
  36
  37     /**
  38      * Interface to HTTP requests.
  39      *
  40      * <p>To supply information from the surrounding web server environment,
  41      * a shim must be supplied in the form of this interface to adapt the
  42      * library to different proprietary server APIs.
  43      *
  44      * <p>This interface need not be threadsafe.
  45      */
  46     class XMLTOOL_API HTTPRequest : public GenericRequest {
  47     protected:
  48         HTTPRequest() {}
  49     public:
  50         virtual ~HTTPRequest() {}
  51
  52         bool isSecure() const {
  53             return strcmp(getScheme(),"https")==0;
  54         }
  55
  56         /**
  57          * Returns the HTTP method of the request (GET, POST, etc.)
  58          *
  59          * @return the HTTP method
  60          */
  61         virtual const char* getMethod() const=0;
  62
  63         /**
  64          * Returns the request URI.
  65          *
  66          * @return the request URI
  67          */
  68         virtual const char* getRequestURI() const=0;
  69
  70         /**
  71          * Returns the complete request URL, including scheme, host, port, and URI.
  72          *
  73          * @return the request URL
  74          */
  75         virtual const char* getRequestURL() const=0;
  76
  77         /**
  78          * Returns the HTTP query string appened to the request. The query
  79          * string is returned without any decoding applied, everything found
  80          * after the ? delimiter.
  81          *
  82          * @return the query string
  83          */
  84         virtual const char* getQueryString() const=0;
  85
  86         /**
  87          * Returns a request header value.
  88          *
  89          * @param name  the name of the header to return
  90          * @return the header's value, or an empty string
  91          */
  92         virtual std::string getHeader(const char* name) const=0;
  93
  94         /**
  95          * Get a cookie value supplied by the client.
  96          *
  97          * @param name  name of cookie
  98          * @return  cookie value or NULL
  99          */
 100         virtual const char* getCookie(const char* name) const;
 101
 102     private:
 103         mutable std::map<std::string,std::string> m_cookieMap;
 104     };
 105
 106 #if defined (_MSC_VER)
 107     #pragma warning( pop )
 108 #endif
 109
 110 };
 111
 112 #endif /* __xmltooling_httpreq_h__ */