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.
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 * @file xmltooling/io/HTTPRequest.h
24 * Interface to HTTP requests.
27 #ifndef __xmltooling_httpreq_h__
28 #define __xmltooling_httpreq_h__
30 #include <xmltooling/io/GenericRequest.h>
35 namespace xmltooling {
37 #if defined (_MSC_VER)
38 #pragma warning( push )
39 #pragma warning( disable : 4251 )
43 * Interface to HTTP requests.
45 * <p>To supply information from the surrounding web server environment,
46 * a shim must be supplied in the form of this interface to adapt the
47 * library to different proprietary server APIs.
49 * <p>This interface need not be threadsafe.
51 class XMLTOOL_API HTTPRequest : public GenericRequest {
55 virtual ~HTTPRequest();
57 bool isSecure() const;
60 * Returns the HTTP method of the request (GET, POST, etc.)
62 * @return the HTTP method
64 virtual const char* getMethod() const=0;
67 * Returns the request URI.
69 * @return the request URI
71 virtual const char* getRequestURI() const=0;
74 * Returns the complete request URL, including scheme, host, port, and URI.
76 * @return the request URL
78 virtual const char* getRequestURL() const=0;
81 * Returns the HTTP query string appened to the request. The query
82 * string is returned without any decoding applied, everything found
83 * after the ? delimiter.
85 * @return the query string
87 virtual const char* getQueryString() const=0;
90 * Returns a request header value.
92 * @param name the name of the header to return
93 * @return the header's value, or an empty string
95 virtual std::string getHeader(const char* name) const=0;
98 * Get a cookie value supplied by the client.
100 * @param name name of cookie
101 * @return cookie value or nullptr
103 virtual const char* getCookie(const char* name) const;
106 mutable std::map<std::string,std::string> m_cookieMap;
109 #if defined (_MSC_VER)
110 #pragma warning( pop )
115 #endif /* __xmltooling_httpreq_h__ */