xmltooling/io/HTTPRequest.h

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