#include <shibsp/SPRequest.h>
Inheritance diagram for shibsp::SPRequest:
Public Types | |
enum | SPLogLevel { SPDebug, SPInfo, SPWarn, SPError, SPCrit } |
Portable logging levels. | |
Public Member Functions | |
virtual const ServiceProvider & | getServiceProvider () const =0 |
Returns the locked ServiceProvider processing the request. | |
virtual RequestMapper::Settings | getRequestSettings () const =0 |
Returns RequestMapper Settings associated with the request, guaranteed to be valid for the request's duration. | |
virtual const Application & | getApplication () const =0 |
Returns the Application governing the request. | |
virtual Session * | getSession (bool checkTimeout=true, bool ignoreAddress=false, bool cache=true)=0 |
Returns a locked Session associated with the request. | |
virtual const char * | getHandlerURL (const char *resource=nullptr) const =0 |
Returns the effective base Handler URL for a resource, or the current request URL. | |
virtual std::string | getSecureHeader (const char *name) const |
Returns a non-spoofable request header value, if possible. | |
virtual void | clearHeader (const char *rawname, const char *cginame)=0 |
Ensures no value exists for a request header. | |
virtual void | setHeader (const char *name, const char *value)=0 |
Sets a value for a request header. | |
virtual void | setRemoteUser (const char *user)=0 |
Establish REMOTE_USER identity in request. | |
virtual void | setAuthType (const char *authtype) |
Establish AUTH_TYPE for request. | |
virtual void | log (SPLogLevel level, const std::string &msg) const =0 |
Log to native server environment. | |
virtual bool | isPriorityEnabled (SPLogLevel level) const =0 |
Test logging level. | |
virtual long | returnDecline ()=0 |
Indicates that processing was declined, meaning no action is required during this phase of processing. | |
virtual long | returnOK ()=0 |
Indicates that processing was completed. |
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.
|
Ensures no value exists for a request header.
|
|
Returns the Application governing the request.
Implemented in shibsp::AbstractSPRequest. |
|
Returns the effective base Handler URL for a resource, or the current request URL.
Implemented in shibsp::AbstractSPRequest. |
|
Returns RequestMapper Settings associated with the request, guaranteed to be valid for the request's duration.
Implemented in shibsp::AbstractSPRequest. |
|
Returns a non-spoofable request header value, if possible. Platforms that support environment export can redirect header lookups by overriding this method.
|
|
Returns the locked ServiceProvider processing the request.
Implemented in shibsp::AbstractSPRequest. |
|
Returns a locked Session associated with the request.
Implemented in shibsp::AbstractSPRequest. |
|
Test logging level.
|
|
Log to native server environment.
|
|
Indicates that processing was declined, meaning no action is required during this phase of processing.
|
|
Indicates that processing was completed.
|
|
Establish AUTH_TYPE for request.
|
|
Sets a value for a request header.
|
|
Establish REMOTE_USER identity in request.
|