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

#include <shibsp/handler/SessionInitiator.h>

Inheritance diagram for shibsp::SessionInitiator:

Public Member Functions
virtual std::pair< bool, long >	run (SPRequest &request, std::string &entityID, bool isHandler=true) const =0
	Executes an incoming request.
std::pair< bool, long >	run (SPRequest &request, bool isHandler=true) const
	Executes handler functionality as an incoming request.
const char *	getType () const
	Returns the "type" of the Handler plugin.
Static Protected Attributes
static std::map< std::string, std::string >	m_remapper
	Property remapper for configuration compatibility.
Friends
void	registerSessionInitiators ()
	Registers SessionInitiator implementations.

Detailed Description

Pluggable runtime functionality that handles initiating sessions.

By default, SessionInitiators look for an entityID on the incoming request and pass control to the specialized run method.

Member Function Documentation

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

Returns the "type" of the Handler plugin.

Reimplemented from shibsp::Handler.

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

Executes an incoming request.

SessionInitiators can be run either directly by incoming web requests or indirectly/implicitly during other SP processing.

Parameters:

	request	SP request context
	entityID	the name of an IdP to request a session from, if known
	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

std::pair<bool,long> shibsp::SessionInitiator::run	(	SPRequest &	request,
		bool	isHandler = `true`
	)			const `[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

void registerSessionInitiators ( ) [friend]

Registers SessionInitiator implementations.

std::map<std::string,std::string> shibsp::SessionInitiator::m_remapper [static, protected]

Property remapper for configuration compatibility.

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