shibboleth-2.5.5

shibsp::AbstractSPRequest Class Reference

Abstract base for SPRequest implementations. More...

#include <shibsp/AbstractSPRequest.h>

Inheritance diagram for shibsp::AbstractSPRequest:
shibsp::SPRequest

List of all members.

Public Member Functions

const ServiceProvidergetServiceProvider () const
 Returns the locked ServiceProvider processing the request.
RequestMapper::Settings getRequestSettings () const
 Returns RequestMapper Settings associated with the request, guaranteed to be valid for the request's duration.
const ApplicationgetApplication () const
 Returns the Application governing the request.
SessiongetSession (bool checkTimeout=true, bool ignoreAddress=false, bool cache=true)
 Returns a locked Session associated with the request.
const char * getRequestURI () const
const char * getRequestURL () const
std::string getRemoteAddr () const
const char * getParameter (const char *name) const
std::vector< const char * >
::size_type 
getParameters (const char *name, std::vector< const char * > &values) const
const char * getHandlerURL (const char *resource=nullptr) const
 Returns the effective base Handler URL for a resource, or the current request URL.
void log (SPLogLevel level, const std::string &msg) const
 Log to native server environment.
bool isPriorityEnabled (SPLogLevel level) const
 Test logging level.

Protected Member Functions

 AbstractSPRequest (const char *category)
 Constructor.
void setRequestURI (const char *uri)
 Stores a normalized request URI to ensure it contains no -encoded characters or other undesirable artifacts.

Detailed Description

Abstract base for SPRequest implementations.


Constructor & Destructor Documentation

shibsp::AbstractSPRequest::AbstractSPRequest ( const char *  category) [protected]

Constructor.

Parameters:
categorylogging category to use

Member Function Documentation

const Application& shibsp::AbstractSPRequest::getApplication ( ) const [virtual]

Returns the Application governing the request.

Returns:
reference to Application

Implements shibsp::SPRequest.

const char* shibsp::AbstractSPRequest::getHandlerURL ( const char *  resource = nullptr) const [virtual]

Returns the effective base Handler URL for a resource, or the current request URL.

Parameters:
resourceresource URL to compute handler for
Returns:
base location of handler

Implements shibsp::SPRequest.

RequestMapper::Settings shibsp::AbstractSPRequest::getRequestSettings ( ) const [virtual]

Returns RequestMapper Settings associated with the request, guaranteed to be valid for the request's duration.

Returns:
copy of settings

Implements shibsp::SPRequest.

const ServiceProvider& shibsp::AbstractSPRequest::getServiceProvider ( ) const [virtual]

Returns the locked ServiceProvider processing the request.

Returns:
reference to ServiceProvider

Implements shibsp::SPRequest.

Session* shibsp::AbstractSPRequest::getSession ( bool  checkTimeout = true,
bool  ignoreAddress = false,
bool  cache = true 
) [virtual]

Returns a locked Session associated with the request.

Parameters:
checkTimeouttrue iff the last-used timestamp should be updated and any timeout policy enforced
ignoreAddresstrue iff all address checking should be ignored, regardless of policy
cachetrue iff the request should hold the Session lock itself and unlock during cleanup
Returns:
pointer to Session, or nullptr

Implements shibsp::SPRequest.

bool shibsp::AbstractSPRequest::isPriorityEnabled ( SPLogLevel  level) const [virtual]

Test logging level.

Parameters:
levellogging level
Returns:
true iff logging level is enabled

Implements shibsp::SPRequest.

void shibsp::AbstractSPRequest::log ( SPLogLevel  level,
const std::string &  msg 
) const [virtual]

Log to native server environment.

Parameters:
levellogging level
msgmessage to log

Implements shibsp::SPRequest.

void shibsp::AbstractSPRequest::setRequestURI ( const char *  uri) [protected]

Stores a normalized request URI to ensure it contains no -encoded characters or other undesirable artifacts.

Parameters:
urithe request URI as obtained from the client

The documentation for this class was generated from the following file: