Public Member Functions | |
XMLConfig (const xercesc::DOMElement *e, bool deprecationSupport=true) | |
void | init () |
Loads a configuration and prepares the instance for use. | |
const XMLCh * | getConfigurationNamespace () const |
Get the "active" XML namespace of the underlying configuration. | |
xmltooling::Lockable * | lock () |
void | unlock () |
const PropertySet * | getParent () const |
Returns parent of this PropertySet, if any. | |
void | setParent (const PropertySet *parent) |
std::pair< bool, bool > | getBool (const char *name, const char *ns=nullptr) const |
Returns a boolean-valued property. | |
std::pair< bool, const char * > | getString (const char *name, const char *ns=nullptr) const |
Returns a string-valued property. | |
std::pair< bool, const XMLCh * > | getXMLString (const char *name, const char *ns=nullptr) const |
Returns a Unicode string-valued property. | |
std::pair< bool, unsigned int > | getUnsignedInt (const char *name, const char *ns=nullptr) const |
Returns an unsigned integer-valued property. | |
std::pair< bool, int > | getInt (const char *name, const char *ns=nullptr) const |
Returns an integer-valued property. | |
const PropertySet * | getPropertySet (const char *name, const char *ns=shibspconstants::ASCII_SHIBSPCONFIG_NS) const |
Returns a nested property set. | |
const xercesc::DOMElement * | getElement () const |
Returns a DOM element representing the property container, if any. | |
void | receive (DDF &in, std::ostream &out) |
Remoted classes implement this method to process incoming messages. | |
TransactionLog * | getTransactionLog () const |
Returns a TransactionLog instance. | |
xmltooling::StorageService * | getStorageService (const char *id) const |
Returns a StorageService instance based on an ID. | |
ListenerService * | getListenerService (bool required=true) const |
Returns a ListenerService instance. | |
SessionCache * | getSessionCache (bool required=true) const |
Returns a SessionCache instance. | |
RequestMapper * | getRequestMapper (bool required=true) const |
Returns a RequestMapper instance. | |
const Application * | getApplication (const char *applicationId) const |
Returns an Application instance matching the specified ID. | |
SecurityPolicyProvider * | getSecurityPolicyProvider (bool required=true) const |
Returns a SecurityPolicyProvider instance. | |
bool | setTransportOptions (xmltooling::SOAPTransport &transport) const |
Sets implementation-specific transport options. | |
void | regListener (const char *address, Remoted *svc) |
Register for a message. | |
bool | unregListener (const char *address, Remoted *current) |
Unregisters service from an address, possibly restoring an original. | |
Remoted * | lookupListener (const char *address) const |
Returns current service registered at an address, if any. | |
Protected Member Functions | |
std::pair< bool, xercesc::DOMElement * > | background_load () |
Friends | |
class | XMLConfigImpl |
const Application* shibsp::XMLConfig::getApplication | ( | const char * | applicationId | ) | const [virtual] |
Returns an Application instance matching the specified ID.
applicationId | the ID of the application, or nullptr for the default |
Implements shibsp::ServiceProvider.
std::pair<bool, bool> shibsp::XMLConfig::getBool | ( | const char * | name, | |
const char * | ns = nullptr | |||
) | const [inline, virtual] |
Returns a boolean-valued property.
name | property name | |
ns | property namespace, or nullptr |
Implements shibsp::PropertySet.
const XMLCh* shibsp::XMLConfig::getConfigurationNamespace | ( | ) | const [inline, virtual] |
Get the "active" XML namespace of the underlying configuration.
This accomodates multiple supported configuration schemas at runtime by allowing components to tailor their behavior to the specific format in use.
Implements shibsp::ServiceProvider.
const xercesc::DOMElement* shibsp::XMLConfig::getElement | ( | ) | const [inline, virtual] |
Returns a DOM element representing the property container, if any.
Implements shibsp::PropertySet.
std::pair<bool, int> shibsp::XMLConfig::getInt | ( | const char * | name, | |
const char * | ns = nullptr | |||
) | const [inline, virtual] |
Returns an integer-valued property.
name | property name | |
ns | property namespace, or nullptr |
Implements shibsp::PropertySet.
ListenerService* shibsp::XMLConfig::getListenerService | ( | bool | required = true |
) | const [inline, virtual] |
Returns a ListenerService instance.
required | true iff an exception should be thrown if no ListenerService is available |
Implements shibsp::ServiceProvider.
const PropertySet* shibsp::XMLConfig::getParent | ( | ) | const [inline, virtual] |
Returns parent of this PropertySet, if any.
Implements shibsp::PropertySet.
const PropertySet* shibsp::XMLConfig::getPropertySet | ( | const char * | name, | |
const char * | ns = shibspconstants::ASCII_SHIBSPCONFIG_NS | |||
) | const [inline, virtual] |
Returns a nested property set.
name | nested property set name | |
ns | nested property set namespace, or nullptr |
Implements shibsp::PropertySet.
RequestMapper* shibsp::XMLConfig::getRequestMapper | ( | bool | required = true |
) | const [inline, virtual] |
Returns a RequestMapper instance.
required | true iff an exception should be thrown if no RequestMapper is available |
Implements shibsp::ServiceProvider.
SecurityPolicyProvider* shibsp::XMLConfig::getSecurityPolicyProvider | ( | bool | required = true |
) | const [inline, virtual] |
Returns a SecurityPolicyProvider instance.
required | true iff an exception should be thrown if no SecurityPolicyProvider is available |
Implements shibsp::ServiceProvider.
SessionCache* shibsp::XMLConfig::getSessionCache | ( | bool | required = true |
) | const [inline, virtual] |
Returns a SessionCache instance.
required | true iff an exception should be thrown if no SessionCache is available |
Implements shibsp::ServiceProvider.
xmltooling::StorageService* shibsp::XMLConfig::getStorageService | ( | const char * | id | ) | const [virtual] |
Returns a StorageService instance based on an ID.
id | a nullptr-terminated key identifying the StorageService to the configuration |
Implements shibsp::ServiceProvider.
std::pair<bool, const char*> shibsp::XMLConfig::getString | ( | const char * | name, | |
const char * | ns = nullptr | |||
) | const [inline, virtual] |
Returns a string-valued property.
name | property name | |
ns | property namespace, or nullptr |
Implements shibsp::PropertySet.
TransactionLog* shibsp::XMLConfig::getTransactionLog | ( | ) | const [inline, virtual] |
Returns a TransactionLog instance.
Implements shibsp::ServiceProvider.
std::pair<bool, unsigned int> shibsp::XMLConfig::getUnsignedInt | ( | const char * | name, | |
const char * | ns = nullptr | |||
) | const [inline, virtual] |
Returns an unsigned integer-valued property.
name | property name | |
ns | property namespace, or nullptr |
Implements shibsp::PropertySet.
std::pair<bool, const XMLCh*> shibsp::XMLConfig::getXMLString | ( | const char * | name, | |
const char * | ns = nullptr | |||
) | const [inline, virtual] |
Returns a Unicode string-valued property.
name | property name | |
ns | property namespace, or nullptr |
Implements shibsp::PropertySet.
void shibsp::XMLConfig::init | ( | ) | [inline, 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.
Implements shibsp::ServiceProvider.
Remoted* shibsp::XMLConfig::lookupListener | ( | const char * | address | ) | const [virtual] |
Returns current service registered at an address, if any.
address | message address to access |
Implements shibsp::ServiceProvider.
void shibsp::XMLConfig::receive | ( | DDF & | in, | |
std::ostream & | out | |||
) | [virtual] |
Remoted classes implement this method to process incoming messages.
Implements shibsp::Remoted.
void shibsp::XMLConfig::regListener | ( | const char * | address, | |
Remoted * | svc | |||
) | [virtual] |
Register for a message.
address | message address to register | |
svc | pointer to remote service |
Implements shibsp::ServiceProvider.
bool shibsp::XMLConfig::setTransportOptions | ( | xmltooling::SOAPTransport & | transport | ) | const [virtual] |
Sets implementation-specific transport options.
transport | a SOAPTransport object |
Implements shibsp::ServiceProvider.
bool shibsp::XMLConfig::unregListener | ( | const char * | address, | |
Remoted * | current | |||
) | [virtual] |
Unregisters service from an address, possibly restoring an original.
address | message address to modify | |
current | pointer to unregistering service |
Implements shibsp::ServiceProvider.