/*
- * Copyright 2001-2007 Internet2
+ * Copyright 2001-2009 Internet2
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <saml/saml2/metadata/ObservableMetadataProvider.h>
-namespace opensaml {
+#include <xmltooling/security/Credential.h>
+#include <xmltooling/security/CredentialCriteria.h>
+#include <xmltooling/util/Threads.h>
+
+namespace xmltooling {
+ class XMLTOOL_API KeyInfoResolver;
+};
+namespace opensaml {
namespace saml2md {
+ class SAML_API MetadataFilter;
+
/**
* Base class for caching metadata providers.
*/
* Constructor.
*
* If a DOM is supplied, a set of default logic will be used to identify
- * and build a KeyResolver plugin and install it into the provider.
+ * and build a KeyInfoResolver plugin and install it into the provider.
*
* The following XML content is supported:
*
* <ul>
- * <li><KeyResolver> elements with a type attribute
+ * <li><KeyInfoResolver> elements with a type attribute
* </ul>
*
* XML namespaces are ignored in the processing of these elements.
*
* @param e DOM to supply configuration for provider
*/
- AbstractMetadataProvider(const DOMElement* e=NULL);
-
- void emitChangeEvent();
+ AbstractMetadataProvider(const xercesc::DOMElement* e=NULL);
public:
virtual ~AbstractMetadataProvider();
- virtual const xmlsignature::KeyResolver* getKeyResolver() const {
- return m_resolver;
- }
-
- virtual const EntityDescriptor* getEntityDescriptor(const char* id, bool requireValidMetadata=true) const;
- virtual const EntityDescriptor* getEntityDescriptor(const SAMLArtifact* artifact) const;
- virtual const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const;
+ using MetadataProvider::getEntityDescriptor;
+ using MetadataProvider::getEntitiesDescriptor;
+
+ void emitChangeEvent() const;
+ std::pair<const EntityDescriptor*,const RoleDescriptor*> getEntityDescriptor(const Criteria& criteria) const;
+ const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const;
+ const xmltooling::Credential* resolve(const xmltooling::CredentialCriteria* criteria=NULL) const;
+ std::vector<const xmltooling::Credential*>::size_type resolve(
+ std::vector<const xmltooling::Credential*>& results, const xmltooling::CredentialCriteria* criteria=NULL
+ ) const;
protected:
- /** Embedded KeyResolver instance. */
- xmlsignature::KeyResolver* m_resolver;
+ /** Embedded KeyInfoResolver instance. */
+ xmltooling::KeyInfoResolver* m_resolver;
/**
* Loads an entity into the cache for faster lookup. This includes
* processing known reverse lookup strategies for artifacts.
*
* @param site entity definition
- * @param validUntil expiration time of the entity definition
+ * @param validUntil maximum expiration time of the entity definition
+ * @param replace true iff existing entries for the same entity should be cleared/replaced
*/
- virtual void index(EntityDescriptor* site, time_t validUntil);
+ virtual void index(EntityDescriptor* site, time_t validUntil, bool replace=false) const;
/**
* Loads a group of entities into the cache for faster lookup.
*
* @param group group definition
- * @param validUntil expiration time of the group definition
+ * @param validUntil maximum expiration time of the group definition
*/
- virtual void index(EntitiesDescriptor* group, time_t validUntil);
+ virtual void index(EntitiesDescriptor* group, time_t validUntil) const;
/**
* Clear the cache of known entities and groups.
+ *
+ * @param freeSites true iff the objects cached in the site map should be freed.
*/
- virtual void clearDescriptorIndex();
-
- private:
- std::vector<MetadataFilter*> m_filters;
+ virtual void clearDescriptorIndex(bool freeSites=false);
+ private:
typedef std::multimap<std::string,const EntityDescriptor*> sitemap_t;
typedef std::multimap<std::string,const EntitiesDescriptor*> groupmap_t;
- sitemap_t m_sites;
- sitemap_t m_sources;
- groupmap_t m_groups;
+ mutable sitemap_t m_sites;
+ mutable sitemap_t m_sources;
+ mutable groupmap_t m_groups;
+
+ mutable xmltooling::Mutex* m_credentialLock;
+ typedef std::map< const RoleDescriptor*, std::vector<xmltooling::Credential*> > credmap_t;
+ mutable credmap_t m_credentialMap;
+ const credmap_t::mapped_type& resolveCredentials(const RoleDescriptor& role) const;
};
};