Public Member Functions |
const ServiceProvider & | getServiceProvider () const |
| Returns the owning ServiceProvider instance.
|
virtual const char * | getId () const |
| Returns the Application's ID.
|
virtual const char * | getHash () const =0 |
| Returns a unique hash for the Application.
|
virtual std::pair< std::string,
const char * > | getCookieNameProps (const char *prefix, time_t *lifetime=nullptr) const |
| Returns the name and cookie properties to use for this Application.
|
virtual
opensaml::saml2md::MetadataProvider * | getMetadataProvider (bool required=true) const =0 |
| Returns a MetadataProvider for use with this Application.
|
virtual xmltooling::TrustEngine * | getTrustEngine (bool required=true) const =0 |
| Returns a TrustEngine for use with this Application.
|
virtual AttributeExtractor * | getAttributeExtractor () const =0 |
| Returns an AttributeExtractor for use with this Application.
|
virtual AttributeFilter * | getAttributeFilter () const =0 |
| Returns an AttributeFilter for use with this Application.
|
virtual AttributeResolver * | getAttributeResolver () const =0 |
| Returns an AttributeResolver for use with this Application.
|
virtual
xmltooling::CredentialResolver * | getCredentialResolver () const =0 |
| Returns the CredentialResolver instance associated with this Application.
|
virtual const PropertySet * | getRelyingParty (const opensaml::saml2md::EntityDescriptor *provider) const =0 |
| Returns configuration properties governing security interactions with a peer.
|
virtual const PropertySet * | getRelyingParty (const XMLCh *entityID) const =0 |
| Returns configuration properties governing security interactions with a named peer.
|
virtual const std::vector
< const XMLCh * > * | getAudiences () const =0 |
virtual std::string | getNotificationURL (const char *request, bool front, unsigned int index) const =0 |
| Returns the designated notification URL, or an empty string if no more locations are specified.
|
virtual const std::vector
< std::string > & | getRemoteUserAttributeIds () const =0 |
| Returns an array of attribute IDs to use as a REMOTE_USER value, in order of preference.
|
virtual void | clearHeader (SPRequest &request, const char *rawname, const char *cginame) const |
| Ensures no value exists for a request header, allowing for application-specific customization.
|
virtual void | setHeader (SPRequest &request, const char *name, const char *value) const |
| Sets a value for a request header allowing for application-specific customization.
|
virtual std::string | getSecureHeader (const SPRequest &request, const char *name) const |
| Returns a non-spoofable request header value allowing for application-specific customization.
|
virtual void | clearAttributeHeaders (SPRequest &request) const |
| Clears any headers that may be used to hold attributes after export.
|
virtual const SessionInitiator * | getDefaultSessionInitiator () const =0 |
| Returns the default SessionInitiator when automatically requesting a session.
|
virtual const SessionInitiator * | getSessionInitiatorById (const char *id) const =0 |
| Returns a SessionInitiator with a particular ID when automatically requesting a session.
|
virtual const Handler * | getDefaultAssertionConsumerService () const =0 |
| Returns the default AssertionConsumerService Handler for use in AuthnRequest messages.
|
virtual const Handler * | getAssertionConsumerServiceByIndex (unsigned short index) const =0 |
| Returns an AssertionConsumerService Handler with a particular index for use in AuthnRequest messages.
|
virtual const Handler * | getAssertionConsumerServiceByProtocol (const XMLCh *protocol, const char *binding=nullptr) const |
| Returns an AssertionConsumerService Handler that supports a particular protocol "family" and optional binding.
|
virtual const std::vector
< const Handler * > & | getAssertionConsumerServicesByBinding (const XMLCh *binding) const =0 |
virtual const Handler * | getHandler (const char *path) const =0 |
| Returns the Handler associated with a particular path/location.
|
virtual void | getHandlers (std::vector< const Handler * > &handlers) const =0 |
| Returns all registered Handlers.
|
virtual void | limitRedirect (const xmltooling::GenericRequest &request, const char *url) const |
| Checks a proposed redirect URL against application-specific settings for legal redirects, such as same-host restrictions or whitelisted domains, and raises a SecurityPolicyException in the event of a violation.
|
virtual const PropertySet * | getParent () 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 void | getAll (std::map< std::string, const char * > &properties) const =0 |
| Returns a map of all known properties in string form.
|
virtual const PropertySet * | getPropertySet (const char *name, const char *ns=shibspconstants::ASCII_SHIB2SPCONFIG_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.
|
Interface to a Shibboleth Application instance.
An Application is a logical set of resources that act as a unit of session management and policy.