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 namespace xmltooling {
  29
  30     /**
  31      * Interface to HTTP requests.
  32      *
  33      * <p>To supply information from the surrounding web server environment,
  34      * a shim must be supplied in the form of this interface to adapt the
  35      * library to different proprietary server APIs.
  36      *
  37      * <p>This interface need not be threadsafe.
  38      */
  39     class XMLTOOL_API HTTPRequest : public GenericRequest {
  40     protected:
  41         HTTPRequest() {}
  42     public:
  43         virtual ~HTTPRequest() {}
  44
  45         bool isSecure() const {
  46             return strcmp(getScheme(),"https")==0;
  47         }
  48
  49         /**
  50          * Returns the HTTP method of the request (GET, POST, etc.)
  51          *
  52          * @return the HTTP method
  53          */
  54         virtual const char* getMethod() const=0;
  55
  56         /**
  57          * Returns the request URI.
  58          *
  59          * @return the request URI
  60          */
  61         virtual const char* getRequestURI() const=0;
  62
  63         /**
  64          * Returns the complete request URL, including scheme, host, port, and URI.
  65          *
  66          * @return the request URL
  67          */
  68         virtual const char* getRequestURL() const=0;
  69
  70         /**
  71          * Returns the HTTP query string appened to the request. The query
  72          * string is returned without any decoding applied, everything found
  73          * after the ? delimiter.
  74          *
  75          * @return the query string
  76          */
  77         virtual const char* getQueryString() const=0;
  78
  79         /**
  80          * Returns a request header value.
  81          *
  82          * @param name  the name of the header to return
  83          * @return the header's value, or an empty string
  84          */
  85         virtual std::string getHeader(const char* name) const=0;
  86     };
  87 };
  88
  89 #endif /* __xmltooling_httpreq_h__ */