shibsp::ServiceProvider Class Reference
Interface to a Shibboleth ServiceProvider instance.
More...
#include <shibsp/ServiceProvider.h>
List of all members.
Detailed Description
Interface to a Shibboleth ServiceProvider instance.
A ServiceProvider exposes configuration and infrastructure services required by the SP implementation, allowing a flexible configuration format.
Member Function Documentation
virtual std::pair<bool,long> shibsp::ServiceProvider::doAuthentication |
( |
SPRequest & |
request, |
|
|
bool |
handler = false | |
|
) |
| | const [virtual] |
Enforces requirements for an authenticated session.
If the return value's first member is true, then request processing should terminate with the second member as a status value. If false, processing can continue.
- Parameters:
-
| request | SP request interface |
| handler | true iff a request to a registered Handler location can be directly executed |
- Returns:
- a pair containing a "request completed" indicator and a server-specific response code
virtual std::pair<bool,long> shibsp::ServiceProvider::doAuthorization |
( |
SPRequest & |
request |
) |
const [virtual] |
Enforces authorization requirements based on the authenticated session.
If the return value's first member is true, then request processing should terminate with the second member as a status value. If false, processing can continue.
- Parameters:
-
| request | SP request interface |
- Returns:
- a pair containing a "request completed" indicator and a server-specific response code
virtual std::pair<bool,long> shibsp::ServiceProvider::doExport |
( |
SPRequest & |
request, |
|
|
bool |
requireSession = true | |
|
) |
| | const [virtual] |
Publishes session contents to the request in the form of headers or environment variables.
If the return value's first member is true, then request processing should terminate with the second member as a status value. If false, processing can continue.
- Parameters:
-
| request | SP request interface |
| requireSession | set to true iff an error should result if no session exists |
- Returns:
- a pair containing a "request completed" indicator and a server-specific response code
virtual std::pair<bool,long> shibsp::ServiceProvider::doHandler |
( |
SPRequest & |
request |
) |
const [virtual] |
Services requests for registered Handler locations.
If the return value's first member is true, then request processing should terminate with the second member as a status value. If false, processing can continue.
- Parameters:
-
| request | SP request interface |
- Returns:
- a pair containing a "request completed" indicator and a server-specific response code
virtual const Application* shibsp::ServiceProvider::getApplication |
( |
const char * |
applicationId |
) |
const [pure virtual] |
Returns an Application instance matching the specified ID.
- Parameters:
-
| applicationId | the ID of the application |
- Returns:
- pointer to the application, or NULL
virtual ListenerService* shibsp::ServiceProvider::getListenerService |
( |
bool |
required = true |
) |
const [pure virtual] |
virtual const std::vector<const opensaml::SecurityPolicyRule*>& shibsp::ServiceProvider::getPolicyRules |
( |
const char * |
id |
) |
const [pure virtual] |
Returns the security policy rules for an identified policy.
- Parameters:
-
| id | identifies the policy to return |
- Returns:
- an array of policy rules
virtual const PropertySet* shibsp::ServiceProvider::getPolicySettings |
( |
const char * |
id |
) |
const [pure virtual] |
Returns the security policy settings for an identified policy.
- Parameters:
-
| id | identifies the policy to return |
- Returns:
- a PropertySet
virtual RequestMapper* shibsp::ServiceProvider::getRequestMapper |
( |
bool |
required = true |
) |
const [pure virtual] |
virtual SessionCache* shibsp::ServiceProvider::getSessionCache |
( |
bool |
required = true |
) |
const [pure virtual] |
virtual xmltooling::StorageService* shibsp::ServiceProvider::getStorageService |
( |
const char * |
id |
) |
const [pure virtual] |
Returns a StorageService instance based on an ID.
- Parameters:
-
| id | a NULL-terminated key identifying the StorageService to the configuration |
- Returns:
- a StorageService if available, or NULL
virtual TransactionLog* shibsp::ServiceProvider::getTransactionLog |
( |
|
) |
const [pure virtual] |
virtual void shibsp::ServiceProvider::init |
( |
|
) |
[pure virtual] |
Loads a configuration and prepares the instance for use.
Implemented as a separate method so that services can rely on other services while they initialize by accessing the ServiceProvider from the SPConfig singleton.
virtual bool shibsp::ServiceProvider::setTransportOptions |
( |
xmltooling::SOAPTransport & |
transport |
) |
const [pure virtual] |
Sets implementation-specific transport options.
- Parameters:
-
| transport | a SOAPTransport object |
- Returns:
- true iff all options were successfully set
The documentation for this class was generated from the following file: