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

#include <shibsp/handler/Handler.h>

Inheritance diagram for shibsp::Handler:

Collaboration 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.

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 `[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

virtual const XMLCh* shibsp::Handler::getProtocolFamily ( ) const [virtual]

Returns an identifier for the protocol family associated with the handler, if any.

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

Returns the "type" of the Handler plugin.

virtual void shibsp::Handler::log	(	SPRequest::SPLogLevel	level,
		const std::string &	msg
	)			const `[protected, virtual]`

Log using handler's specific logging object.

Parameters:

	level	logging level
	msg	message to log

virtual void shibsp::Handler::preserveRelayState	(	const Application &	application,
		xmltooling::HTTPResponse &	response,
		std::string &	relayState
	)			const `[protected, virtual]`

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.

Parameters:

	application	the associated Application
	response	outgoing HTTP response
	relayState	RelayState token to supply with message

virtual void shibsp::Handler::recoverRelayState	(	const Application &	application,
		const xmltooling::HTTPRequest &	request,
		xmltooling::HTTPResponse &	response,
		std::string &	relayState,
		bool	clear = `true`
	)			const `[protected, virtual]`

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.

Parameters:

	application	the associated Application
	request	incoming HTTP request
	response	outgoing HTTP response
	relayState	RelayState token supplied with message
	clear	true iff the token state should be cleared

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

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