#include <shibsp/handler/Handler.h>
Inheritance diagram for shibsp::Handler:
Public Member Functions | |
virtual const XMLCh * | getProtocolFamily () const |
Returns an identifier for the protocol family associated with the handler, if any. | |
virtual std::pair< bool, long > | run (SPRequest &request, bool isHandler=true) const =0 |
Executes handler functionality as an incoming request. | |
virtual void | generateMetadata (opensaml::saml2md::SPSSODescriptor &role, const char *handlerURL) const |
Generates and/or modifies metadata reflecting the Handler. | |
virtual const char * | getType () const |
Returns the "type" of the Handler plugin. | |
Protected Member Functions | |
virtual void | log (SPRequest::SPLogLevel level, const std::string &msg) const |
Log using handler's specific logging object. | |
virtual void | preserveRelayState (const Application &application, xmltooling::HTTPResponse &response, std::string &relayState) const |
Implements various mechanisms to preserve RelayState, such as cookies or StorageService-backed keys. | |
virtual void | recoverRelayState (const Application &application, const xmltooling::HTTPRequest &request, xmltooling::HTTPResponse &response, std::string &relayState, bool clear=true) const |
Implements various mechanisms to recover RelayState, such as cookies or StorageService-backed keys. |
|
Generates and/or modifies metadata reflecting the Handler. The default implementation does nothing.
Reimplemented in shibsp::AssertionConsumerService, and shibsp::SessionInitiator. |
|
Returns an identifier for the protocol family associated with the handler, if any.
Reimplemented in shibsp::AssertionConsumerService. |
|
Returns the "type" of the Handler plugin.
Reimplemented in shibsp::AssertionConsumerService, shibsp::LogoutInitiator, and shibsp::SessionInitiator. |
|
Log using handler's specific logging object.
Reimplemented in shibsp::AbstractHandler. |
|
Implements various mechanisms to preserve RelayState, such as cookies or StorageService-backed keys. If a supported mechanism can be identified, the input parameter will be replaced with a suitable state key.
|
|
Implements various mechanisms to recover RelayState, such as cookies or StorageService-backed keys. If a supported mechanism can be identified, the input parameter will be replaced with the recovered state information.
|
|
Executes handler functionality as an incoming request. Handlers can be run either directly by incoming web requests or indirectly/implicitly during other SP processing.
Implemented in shibsp::AssertionConsumerService, shibsp::LogoutHandler, and shibsp::SessionInitiator. |