X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=saml%2Fsaml2%2Fmetadata%2FMetadataProvider.h;h=2e9b4b953b155e44a130fa624b508a48c439af9f;hb=c089f03a9b08dc947a815be624654ca401c6b369;hp=1c2765ee3eacf07e1639b53da0999394037dc8d0;hpb=a42579b64f02825b677e9464b67674243d2c4693;p=shibboleth%2Fopensaml2.git diff --git a/saml/saml2/metadata/MetadataProvider.h b/saml/saml2/metadata/MetadataProvider.h index 1c2765e..2e9b4b9 100644 --- a/saml/saml2/metadata/MetadataProvider.h +++ b/saml/saml2/metadata/MetadataProvider.h @@ -1,5 +1,5 @@ /* - * Copyright 2001-2006 Internet2 + * Copyright 2001-2007 Internet2 * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,15 +23,28 @@ #ifndef __saml2_metadataprov_h__ #define __saml2_metadataprov_h__ -#include -#include +#include +#include +#include +#include namespace opensaml { class SAML_API SAMLArtifact; namespace saml2md { - + + class SAML_API EntityDescriptor; + class SAML_API EntitiesDescriptor; + class SAML_API RoleDescriptor; + class SAML_API MetadataCredentialResolver; + class SAML_API MetadataFilter; + +#if defined (_MSC_VER) + #pragma warning( push ) + #pragma warning( disable : 4251 ) +#endif + /** * Supplies an individual source of metadata. * @@ -39,21 +52,24 @@ namespace opensaml { * dynamic lookup, can include local caching, etc. Providers * MUST be locked before any lookup operations. */ - class SAML_API MetadataProvider : public virtual xmltooling::Lockable + class SAML_API MetadataProvider : public virtual xmltooling::CredentialResolver { MAKE_NONCOPYABLE(MetadataProvider); - protected: /** - * Constructor. If a DOM is supplied, a set of default logic will be - * used to identify and build MetadataFilter plugins and install them - * into the provider. The following XML content is supported: + * Constructor. + * + * If a DOM is supplied, a set of default logic will be used to identify + * and build MetadataFilter plugins and install them into the provider. + * + * The following XML content is supported: * *
    - *
  • <MetadataFilter> elements with a type attribute + *
  • <MetadataFilter> elements with a type attribute and type-specific content *
  • <Exclude> elements representing a BlacklistMetadataFilter *
  • <BlacklistMetadataFilter> element containing <Exclude> elements *
  • <Include> elements representing a WhitelistMetadataFilter + *
  • <SignatureMetadataFilter> element containing a <KeyResolver> element *
  • <WhitelistMetadataFilter> element containing <Include> elements *
* @@ -61,7 +77,7 @@ namespace opensaml { * * @param e DOM to supply configuration for provider */ - MetadataProvider(const DOMElement* e=NULL); + MetadataProvider(const xercesc::DOMElement* e=NULL); public: /** @@ -134,7 +150,7 @@ namespace opensaml { * * @return the entity's metadata or NULL if there is no metadata or no valid metadata */ - virtual const EntityDescriptor* getEntityDescriptor(const char* id, bool requireValidMetadata=true) const; + virtual const EntityDescriptor* getEntityDescriptor(const char* id, bool requireValidMetadata=true) const=0; /** * Gets the metadata for an entity that issued a SAML artifact. If a valid entity is returned, @@ -145,7 +161,7 @@ namespace opensaml { * * @return the entity's metadata or NULL if there is no valid metadata */ - virtual const EntityDescriptor* getEntityDescriptor(const SAMLArtifact* artifact) const; + virtual const EntityDescriptor* getEntityDescriptor(const SAMLArtifact* artifact) const=0; /** * Gets the metadata for a given group of entities. If a valid group is returned, @@ -169,7 +185,7 @@ namespace opensaml { * * @return the group's metadata or NULL if there is no metadata or no valid metadata */ - virtual const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const; + virtual const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const=0; protected: /** @@ -179,45 +195,29 @@ namespace opensaml { */ void doFilters(xmltooling::XMLObject& xmlObject) const; - /** - * 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 - */ - virtual void index(EntityDescriptor* site, time_t validUntil); - - /** - * Loads a group of entities into the cache for faster lookup. - * - * @param group group definition - * @param validUntil expiration time of the group definition - */ - virtual void index(EntitiesDescriptor* group, time_t validUntil); - - /** - * Clear the cache of known entities and groups. - */ - virtual void clearDescriptorIndex(); - private: std::vector m_filters; - - typedef std::multimap sitemap_t; - typedef std::multimap groupmap_t; - sitemap_t m_sites; - sitemap_t m_sources; - groupmap_t m_groups; }; - + +#if defined (_MSC_VER) + #pragma warning( pop ) +#endif + /** * Registers MetadataProvider classes into the runtime. */ void SAML_API registerMetadataProviders(); - /** MetadataProvider based on local XML files */ - #define FILESYSTEM_METADATA_PROVIDER "org.opensaml.saml2.metadata.provider.FilesystemMetadataProvider" + /** MetadataProvider based on local or remote XML file */ + #define XML_METADATA_PROVIDER "XML" + + /** MetadataProvider based on dynamic resolution */ + #define DYNAMIC_METADATA_PROVIDER "Dynamic" + + /** MetadataProvider that wraps a sequence of metadata providers. */ + #define CHAINING_METADATA_PROVIDER "Chaining" + + DECL_XMLTOOLING_EXCEPTION(MetadataException,SAML_EXCEPTIONAPI(SAML_API),opensaml::saml2md,xmltooling::XMLToolingException,Exceptions related to metadata use); }; };