#include <shibsp/handler/LogoutHandler.h>
Inheritance diagram for shibsp::LogoutHandler:
Public Member Functions | |
std::pair< bool, long > | run (SPRequest &request, bool isHandler=true) const |
The base method will iteratively attempt front-channel notification of logout of the current session, and after the final round trip will perform back-channel notification. | |
void | receive (DDF &in, std::ostream &out) |
A remoted procedure that will perform any necessary back-channel notifications. | |
const char * | getEventType () const |
Get the type of event, as input to error handling in response to errors raised by this handler. | |
Protected Member Functions | |
std::pair< bool, long > | notifyFrontChannel (const Application &application, const xmltooling::HTTPRequest &request, xmltooling::HTTPResponse &response, const std::map< std::string, std::string > *params=nullptr) const |
Perform front-channel logout notifications for an Application. | |
bool | notifyBackChannel (const Application &application, const char *requestURL, const std::vector< std::string > &sessions, bool local) const |
Perform back-channel logout notifications for an Application. | |
std::pair< bool, long > | sendLogoutPage (const Application &application, const xmltooling::HTTPRequest &request, xmltooling::HTTPResponse &response, bool local=true, const char *status=nullptr) const |
std::pair< bool, long > | sendLogoutPage (const Application &application, const xmltooling::HTTPRequest &request, xmltooling::HTTPResponse &response, const char *type) const |
Sends a response template to the user agent informing it of the results of a logout attempt. | |
virtual LogoutEvent * | newLogoutEvent (const Application &application, const xmltooling::HTTPRequest *request=nullptr, const Session *session=nullptr) const |
Creates a new LogoutEvent for the event log. | |
Protected Attributes | |
bool | m_initiator |
Flag indicating whether the subclass is acting as a LogoutInitiator. | |
std::vector< std::string > | m_preserve |
Array of query string parameters to preserve across front-channel notifications, if present. |
|
Get the type of event, as input to error handling in response to errors raised by this handler.
Reimplemented from shibsp::Handler. |
|
Creates a new LogoutEvent for the event log.
|
|
Perform back-channel logout notifications for an Application.
|
|
Perform front-channel logout notifications for an Application.
|
|
A remoted procedure that will perform any necessary back-channel notifications. The input structure must contain an "application_id" member, and a "sessions" list containing the session keys, along with an integer member called "notify" with a value of 1.
Implements shibsp::Remoted. |
|
The base method will iteratively attempt front-channel notification of logout of the current session, and after the final round trip will perform back-channel notification. Nothing will be done unless the handler detects that it is the "top" level logout handler. If the method returns false, then the specialized class should perform its work assuming that the notifications are completed. Note that the current session is NOT removed from the cache.
Implements shibsp::Handler. |
|
Sends a response template to the user agent informing it of the results of a logout attempt.
|
|
|