xmltooling::HTTPRequest Class Reference

Interface to HTTP requests. More...

#include <xmltooling/io/HTTPRequest.h>

Inheritance diagram for xmltooling::HTTPRequest:

xmltooling::GenericRequest List of all members.

Public Member Functions

bool isSecure () const
 Returns true iff the request is over a confidential channel.
virtual const char * getMethod () const =0
 Returns the HTTP method of the request (GET, POST, etc.
virtual const char * getRequestURI () const =0
 Returns the request URI.
virtual const char * getRequestURL () const =0
 Returns the complete request URL, including scheme, host, port, and URI.
virtual const char * getQueryString () const =0
 Returns the HTTP query string appened to the request.
virtual std::string getHeader (const char *name) const =0
 Returns a request header value.
virtual const char * getCookie (const char *name) const
 Get a cookie value supplied by the client.

Detailed Description

Interface to HTTP requests.

To supply information from the surrounding web server environment, a shim must be supplied in the form of this interface to adapt the library to different proprietary server APIs.

This interface need not be threadsafe.


Member Function Documentation

virtual const char* xmltooling::HTTPRequest::getCookie ( const char *  name  )  const [virtual]

Get a cookie value supplied by the client.

Parameters:
name name of cookie
Returns:
cookie value or NULL

virtual std::string xmltooling::HTTPRequest::getHeader ( const char *  name  )  const [pure virtual]

Returns a request header value.

Parameters:
name the name of the header to return
Returns:
the header's value, or an empty string

virtual const char* xmltooling::HTTPRequest::getMethod (  )  const [pure virtual]

Returns the HTTP method of the request (GET, POST, etc.

)

Returns:
the HTTP method

virtual const char* xmltooling::HTTPRequest::getQueryString (  )  const [pure virtual]

Returns the HTTP query string appened to the request.

The query string is returned without any decoding applied, everything found after the ? delimiter.

Returns:
the query string

virtual const char* xmltooling::HTTPRequest::getRequestURI (  )  const [pure virtual]

Returns the request URI.

Returns:
the request URI

virtual const char* xmltooling::HTTPRequest::getRequestURL (  )  const [pure virtual]

Returns the complete request URL, including scheme, host, port, and URI.

Returns:
the request URL

bool xmltooling::HTTPRequest::isSecure (  )  const [inline, virtual]

Returns true iff the request is over a confidential channel.

Returns:
confidential channel indicator

Implements xmltooling::GenericRequest.


The documentation for this class was generated from the following file:
Generated on Mon Oct 19 14:18:34 2009 for xmltooling by  doxygen 1.4.7