shibboleth-2.5.1
shibsp::LogoutInitiator Class Reference

Pluggable runtime functionality that handles initiating logout. More...

#include <shibsp/handler/LogoutInitiator.h>

Inheritance diagram for shibsp::LogoutInitiator:
shibsp::LogoutHandler shibsp::RemotedHandler shibsp::Handler shibsp::Remoted shibsp::PropertySet

Public Member Functions

const char * getType () const
 Returns the "type" of the Handler plugin.
 
- Public Member Functions inherited from shibsp::LogoutHandler
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.
 

Additional Inherited Members

- Static Public Member Functions inherited from shibsp::RemotedHandler
static void addRemotedHeader (const char *header)
 Ensures that a request header will be remoted.
 
- Protected Member Functions inherited from shibsp::LogoutHandler
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 LogoutEventnewLogoutEvent (const Application &application, const xmltooling::HTTPRequest *request=nullptr, const Session *session=nullptr) const
 Creates a new LogoutEvent for the event log.
 
- Protected Attributes inherited from shibsp::LogoutHandler
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.
 

Detailed Description

Pluggable runtime functionality that handles initiating logout.

Member Function Documentation

const char* shibsp::LogoutInitiator::getType ( ) const
virtual

Returns the "type" of the Handler plugin.

Returns
a Handler type

Reimplemented from shibsp::Handler.


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