shibboleth-3.2.3
|
Abstract base for SPRequest implementations. More...
#include <shibsp/AbstractSPRequest.h>
Public Member Functions | |
const ServiceProvider & | getServiceProvider () const |
Returns the locked ServiceProvider processing the request. More... | |
RequestMapper::Settings | getRequestSettings () const |
Returns RequestMapper Settings associated with the request, guaranteed to be valid for the request's duration. More... | |
const Application & | getApplication () const |
Returns the Application governing the request. More... | |
Session * | getSession (bool checkTimeout=true, bool ignoreAddress=false, bool cache=true) |
Returns a locked Session associated with the request. More... | |
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. More... | |
std::string | getSecureHeader (const char *name) const |
Returns a non-spoofable request header value, if possible. More... | |
const char * | getCookie (const char *name) const |
void | setAuthType (const char *authtype) |
Establish AUTH_TYPE for request. More... | |
void | setCookie (const char *name, const char *value, time_t expires=0, samesite_t sameSite=SAMESITE_ABSENT) |
void | log (SPLogLevel level, const std::string &msg) const |
Log to native server environment. More... | |
bool | isPriorityEnabled (SPLogLevel level) const |
Test logging level. More... | |
![]() | |
virtual void | clearHeader (const char *rawname, const char *cginame)=0 |
Ensures no value exists for a request header. More... | |
virtual void | setHeader (const char *name, const char *value)=0 |
Sets a value for a request header. More... | |
virtual void | setRemoteUser (const char *user)=0 |
Establish REMOTE_USER identity in request. More... | |
virtual long | returnDecline ()=0 |
Indicates that processing was declined, meaning no action is required during this phase of processing. More... | |
virtual long | returnOK ()=0 |
Indicates that processing was completed. More... | |
Protected Member Functions | |
AbstractSPRequest (const char *category) | |
Constructor. More... | |
void | setRequestURI (const char *uri) |
Stores a normalized request URI to ensure it contains no %-encoded characters or other undesirable artifacts. More... | |
Additional Inherited Members | |
![]() | |
enum | SPLogLevel { SPDebug, SPInfo, SPWarn, SPError, SPCrit } |
Portable logging levels. More... | |
Abstract base for SPRequest implementations.
|
protected |
Constructor.
category | logging category to use |
|
virtual |
Returns the Application governing the request.
Implements shibsp::SPRequest.
|
virtual |
Returns the effective base Handler URL for a resource, or the current request URL.
resource | resource URL to compute handler for |
Implements shibsp::SPRequest.
|
virtual |
Returns RequestMapper Settings associated with the request, guaranteed to be valid for the request's duration.
Implements shibsp::SPRequest.
|
virtual |
Returns a non-spoofable request header value, if possible.
Platforms that support environment export can redirect header lookups by overriding this method.
name | the name of the secure header to return |
Implements shibsp::SPRequest.
|
virtual |
Returns the locked ServiceProvider processing the request.
Implements shibsp::SPRequest.
|
virtual |
Returns a locked Session associated with the request.
checkTimeout | true iff the last-used timestamp should be updated and any timeout policy enforced |
ignoreAddress | true iff all address checking should be ignored, regardless of policy |
cache | true iff the request should hold the Session lock itself and unlock during cleanup |
Implements shibsp::SPRequest.
|
virtual |
Test logging level.
level | logging level |
Implements shibsp::SPRequest.
|
virtual |
Log to native server environment.
level | logging level |
msg | message to log |
Implements shibsp::SPRequest.
|
virtual |
Establish AUTH_TYPE for request.
authtype | AUTH_TYPE value to set or nullptr to clear |
Implements shibsp::SPRequest.
|
protected |
Stores a normalized request URI to ensure it contains no %-encoded characters or other undesirable artifacts.
uri | the request URI as obtained from the client |