xmltooling::GenericRequest Class Reference

Interface to generic protocol requests that transport XML messages. More...

#include <xmltooling/io/GenericRequest.h>

Inheritance diagram for xmltooling::GenericRequest:

xmltooling::HTTPRequest List of all members.

Public Member Functions

virtual const char * getScheme () const =0
 Returns the URL scheme of the request (http, https, ftp, ldap, etc.
virtual bool isSecure () const =0
 Returns true iff the request is over a confidential channel.
virtual const char * getHostname () const =0
 Returns hostname of service that received request.
virtual int getPort () const =0
 Returns incoming port.
virtual std::string getContentType () const =0
 Returns the MIME type of the request, if known.
virtual long getContentLength () const =0
 Returns the length of the request body, if known.
virtual const char * getRequestBody () const =0
 Returns the raw request body.
virtual const char * getParameter (const char *name) const =0
 Returns a decoded named parameter value from the request.
virtual std::vector< const
char * >::size_type 
getParameters (const char *name, std::vector< const char * > &values) const =0
 Returns all of the decoded values of a named parameter from the request.
virtual std::string getRemoteUser () const =0
 Returns the transport-authenticated identity associated with the request, if authentication is solely handled by the transport.
virtual std::string getAuthType () const
 Gets the authentication type associated with the request.
virtual std::string getRemoteAddr () const =0
 Returns the IP address of the client.
virtual const std::vector<
XSECCryptoX509 * > & 
getClientCertificates () const =0
 Returns the chain of certificates sent by the client.

Detailed Description

Interface to generic protocol requests that transport XML messages.

This interface need not be threadsafe.


Member Function Documentation

virtual std::string xmltooling::GenericRequest::getAuthType (  )  const [inline, virtual]

Gets the authentication type associated with the request.

Returns:
the authentication type or NULL

virtual const std::vector<XSECCryptoX509*>& xmltooling::GenericRequest::getClientCertificates (  )  const [pure virtual]

Returns the chain of certificates sent by the client.

They are not guaranteed to be valid according to any particular definition.

Returns:
the client's certificate chain

virtual long xmltooling::GenericRequest::getContentLength (  )  const [pure virtual]

Returns the length of the request body, if known.

Returns:
the content length, or -1 if unknown

virtual std::string xmltooling::GenericRequest::getContentType (  )  const [pure virtual]

Returns the MIME type of the request, if known.

Returns:
the MIME type, or an empty string

virtual const char* xmltooling::GenericRequest::getHostname (  )  const [pure virtual]

Returns hostname of service that received request.

Returns:
hostname of service

virtual const char* xmltooling::GenericRequest::getParameter ( const char *  name  )  const [pure virtual]

Returns a decoded named parameter value from the request.

If a parameter has multiple values, only one will be returned.

Parameters:
name the name of the parameter to return
Returns:
a single parameter value or NULL

virtual std::vector<const char*>::size_type xmltooling::GenericRequest::getParameters ( const char *  name,
std::vector< const char * > &  values 
) const [pure virtual]

Returns all of the decoded values of a named parameter from the request.

All values found will be returned.

Parameters:
name the name of the parameter to return
values a vector in which to return pointers to the decoded values
Returns:
the number of values returned

virtual int xmltooling::GenericRequest::getPort (  )  const [pure virtual]

Returns incoming port.

Returns:
incoming port

virtual std::string xmltooling::GenericRequest::getRemoteAddr (  )  const [pure virtual]

Returns the IP address of the client.

Returns:
the client's IP address

virtual std::string xmltooling::GenericRequest::getRemoteUser (  )  const [pure virtual]

Returns the transport-authenticated identity associated with the request, if authentication is solely handled by the transport.

Returns:
the authenticated username or an empty string

virtual const char* xmltooling::GenericRequest::getRequestBody (  )  const [pure virtual]

Returns the raw request body.

Returns:
the request body, or NULL

virtual const char* xmltooling::GenericRequest::getScheme (  )  const [pure virtual]

Returns the URL scheme of the request (http, https, ftp, ldap, etc.

)

Returns:
the URL scheme

virtual bool xmltooling::GenericRequest::isSecure (  )  const [pure virtual]

Returns true iff the request is over a confidential channel.

Returns:
confidential channel indicator

Implemented in xmltooling::HTTPRequest.


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