shibboleth-3.4.1
shibsp::LogoutInitiator Class Reference

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

#include <shibsp/handler/LogoutInitiator.h>

Inheritance diagram for shibsp::LogoutInitiator:
Collaboration diagram for shibsp::LogoutInitiator:

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.
 
const char * getEventType () const
 Get the type of event, as input to error handling in response to errors raised by this handler.
 
- Public Member Functions inherited from shibsp::Handler
virtual const XMLCh * getProtocolFamily () const
 Returns an identifier for the protocol family associated with the handler, if any.
 
virtual void generateMetadata (opensaml::saml2md::SPSSODescriptor &role, const char *handlerURL) const
 Generates and/or modifies metadata reflecting the Handler.
 
- Public Member Functions inherited from shibsp::PropertySet
virtual const PropertySetgetParent () const =0
 Returns parent of this PropertySet, if any.
 
virtual void setParent (const PropertySet *parent)=0
 Establishes a "parent" PropertySet to supply inherited settings.
 
virtual std::pair< bool, bool > getBool (const char *name, const char *ns=nullptr) const =0
 Returns a boolean-valued property.
 
virtual std::pair< bool, const char * > getString (const char *name, const char *ns=nullptr) const =0
 Returns a string-valued property.
 
virtual std::pair< bool, const XMLCh * > getXMLString (const char *name, const char *ns=nullptr) const =0
 Returns a Unicode string-valued property.
 
virtual std::pair< bool, unsigned int > getUnsignedInt (const char *name, const char *ns=nullptr) const =0
 Returns an unsigned integer-valued property.
 
virtual std::pair< bool, int > getInt (const char *name, const char *ns=nullptr) const =0
 Returns an integer-valued property.
 
virtual const PropertySetgetPropertySet (const char *name, const char *ns=shibspconstants::ASCII_SHIBSPCONFIG_NS) const =0
 Returns a nested property set.
 
virtual const xercesc::DOMElement * getElement () const =0
 Returns a DOM element representing the property container, if any.
 

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, 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 Member Functions inherited from shibsp::RemotedHandler
void setAddress (const char *address)
 Establishes message remoting using the supplied address.
 
virtual DDF send (const SPRequest &request, DDF &in) const
 Send a remoted message and return the response.
 
DDF wrap (const SPRequest &request, const std::vector< std::string > *headers=nullptr, bool certs=false) const
 Wraps a request by creating an outgoing data flow with the data needed to remote the request information.
 
virtual std::pair< bool, long > unwrap (SPRequest &request, DDF &out) const
 Unwraps a response by examining an incoming data flow to determine whether a response was produced by the remoted handler.
 
xmltooling::HTTPRequest * getRequest (const Application &app, DDF &in) const
 Builds a new request instance around a remoted data object.
 
xmltooling::HTTPResponse * getResponse (const Application &app, DDF &out) const
 Builds a new response instance around an outgoing data object.
 
xmltooling::HTTPRequest * getRequest (DDF &in) const
 @Deprecated
 
xmltooling::HTTPResponse * getResponse (DDF &out) const
 @Deprecated
 
- Protected Member Functions inherited from shibsp::Handler
virtual void log (SPRequest::SPLogLevel level, const std::string &msg) const
 Log using handler's specific logging object.
 
virtual void cleanRelayState (const Application &application, const xmltooling::HTTPRequest &request, xmltooling::HTTPResponse &response) const
 Prevents unused relay state from building up by cleaning old state from the client.
 
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.
 
- 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.
 
- Protected Attributes inherited from shibsp::RemotedHandler
std::string m_address
 Message address for remote half.
 

Detailed Description

Pluggable runtime functionality that handles initiating logout.

Member Function Documentation

◆ getType()

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: