Dynamic metadata provider implementation.

[shibboleth/opensaml2.git] / saml / saml2 / metadata / MetadataProvider.h

diff --git a/saml/saml2/metadata/MetadataProvider.h b/saml/saml2/metadata/MetadataProvider.h
index 660d89c..2e9b4b9 100644 (file)
--- 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,10 +23,10 @@
 #ifndef __saml2_metadataprov_h__
 #define __saml2_metadataprov_h__
 
-#include <saml/saml2/metadata/MetadataFilter.h>
-
-#include <xmltooling/Lockable.h>
-#include <xmltooling/signature/KeyResolver.h>
+#include <saml/base.h>
+#include <xmltooling/exceptions.h>
+#include <xmltooling/XMLObject.h>
+#include <xmltooling/security/CredentialResolver.h>
 
 namespace opensaml {
     
@@ -36,7 +36,15 @@ namespace opensaml {
 
         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.
          * 
@@ -44,10 +52,9 @@ namespace opensaml {
          * dynamic lookup, can include local caching, etc. Providers
          * <strong>MUST</strong> 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.
@@ -70,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:
             /**
@@ -114,13 +121,6 @@ namespace opensaml {
             virtual void init()=0;
             
             /**
-             * Returns a KeyResolver associated with this metadata provider, if any.
-             * 
-             * @return an associated KeyResolver, or NULL
-             */
-            virtual const xmlsignature::KeyResolver* getKeyResolver() const=0;
-            
-            /**
              * Gets the entire metadata tree, after the registered filter has been applied.
              * The caller MUST unlock the provider when finished with the data.
              * 
@@ -198,17 +198,26 @@ namespace opensaml {
         private:
             std::vector<MetadataFilter*> m_filters;
         };
-        
+
+#if defined (_MSC_VER)
+        #pragma warning( pop )
+#endif
+
         /**
          * Registers MetadataProvider classes into the runtime.
          */
         void SAML_API registerMetadataProviders();
         
         /** MetadataProvider based on local or remote XML file */
-        #define XML_METADATA_PROVIDER  "org.opensaml.saml2.metadata.provider.XMLMetadataProvider"
+        #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  "org.opensaml.saml2.metadata.provider.ChainingMetadataProvider"
+        #define CHAINING_METADATA_PROVIDER  "Chaining"
+
+        DECL_XMLTOOLING_EXCEPTION(MetadataException,SAML_EXCEPTIONAPI(SAML_API),opensaml::saml2md,xmltooling::XMLToolingException,Exceptions related to metadata use);
     };
 };