shibsp::Handler Class Reference

Pluggable runtime functionality that implement protocols and services. More...

#include <shibsp/handler/Handler.h>

Inheritance diagram for shibsp::Handler:

List of all members.

Public Member Functions
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.

---

Detailed Description

Pluggable runtime functionality that implement protocols and services.

---

Member Function Documentation

virtual void shibsp::Handler::generateMetadata (  opensaml::saml2md::SPSSODescriptor &  role, const char *  handlerURL )  const [inline, virtual]

Generates and/or modifies metadata reflecting the Handler. The default implementation does nothing. Parameters: role  metadata role to decorate handlerURL  base location of handler's endpoint Reimplemented in shibsp::AssertionConsumerService.

virtual const char* shibsp::Handler::getType (   )  const [virtual]

Returns the "type" of the Handler plugin. Returns: a Handler type Reimplemented in shibsp::AssertionConsumerService, and shibsp::SessionInitiator.

virtual std::pair<bool,long> shibsp::Handler::run (  SPRequest &  request, bool  isHandler = true )  const [pure virtual]

Executes handler functionality as an incoming request. Handlers can be run either directly by incoming web requests or indirectly/implicitly during other SP processing. Parameters: request  SP request context isHandler  true iff executing in the context of a direct handler invocation Returns: a pair containing a "request completed" indicator and a server-specific response code Implemented in shibsp::AssertionConsumerService, shibsp::LogoutHandler, and shibsp::SessionInitiator.

---

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

• shibsp/handler/Handler.h

---