Remove extra reference to doc/api.
[shibboleth/cpp-opensaml.git] / saml / saml2 / metadata / ChainingMetadataProvider.h
index d71a254..1310374 100644 (file)
-/*\r
- *  Copyright 2001-2006 Internet2\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- *     http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * @file saml/security/ChainingMetadataProvider.h\r
- * \r
- * MetadataProvider that uses multiple providers in sequence.\r
- */\r
-\r
-#ifndef __saml_chainmeta_h__\r
-#define __saml_chainmeta_h__\r
-\r
-#include <saml/saml2/metadata/ObservableMetadataProvider.h>\r
-#include <xmltooling/util/Threads.h>\r
-\r
-namespace opensaml {\r
-    namespace saml2md {\r
-        \r
-        /**\r
-         * MetadataProvider that uses multiple providers in sequence.\r
-         */\r
-        class SAML_API ChainingMetadataProvider\r
-            : public ObservableMetadataProvider, public ObservableMetadataProvider::Observer {\r
-        public:\r
-            /**\r
-             * Constructor.\r
-             * \r
-             * If a DOM is supplied, the following XML content is supported:\r
-             * \r
-             * <ul>\r
-             *  <li>&lt;MetadataProvider&gt; elements with a type attribute\r
-             * </ul>\r
-             * \r
-             * XML namespaces are ignored in the processing of this content.\r
-             * \r
-             * @param e DOM to supply configuration for provider\r
-             */\r
-            ChainingMetadataProvider(const DOMElement* e=NULL);\r
-            \r
-            /**\r
-             * Destructor will delete any embedded engines.\r
-             */\r
-            virtual ~ChainingMetadataProvider();\r
-    \r
-            /**\r
-             * Adds a provider for future calls. The provider <strong>MUST</strong> be\r
-             * initialized before adding it. \r
-             * \r
-             * @param newProvider provider to add\r
-             */\r
-            void addMetadataProvider(MetadataProvider* newProvider) {\r
-                m_providers.push_back(newProvider);\r
-            }\r
-    \r
-            /**\r
-             * Removes a provider. The caller must delete the provider if necessary.\r
-             * \r
-             * @param oldProvider provider to remove\r
-             * @return  the old provider\r
-             */\r
-            MetadataProvider* removeMetadataProvider(MetadataProvider* oldProvider) {\r
-                for (std::vector<MetadataProvider*>::iterator i=m_providers.begin(); i!=m_providers.end(); i++) {\r
-                    if (oldProvider==(*i)) {\r
-                        m_providers.erase(i);\r
-                        return oldProvider;\r
-                    }\r
-                }\r
-                return NULL;\r
-            }\r
-\r
-            xmltooling::Lockable* lock();\r
-            void unlock();\r
-            void init();\r
-            const xmlsignature::KeyResolver* getKeyResolver() const;\r
-            const xmltooling::XMLObject* getMetadata() const;\r
-            const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const;\r
-            const EntityDescriptor* getEntityDescriptor(const char* id, bool requireValidMetadata=true) const;\r
-            const EntityDescriptor* getEntityDescriptor(const SAMLArtifact* artifact) const;\r
-            void onEvent(MetadataProvider& provider);\r
-    \r
-        private:\r
-            xmltooling::ThreadKey* m_tlsKey;\r
-            std::vector<MetadataProvider*> m_providers;\r
-        };\r
-    };    \r
-};\r
-\r
-#endif /* __saml_chainmeta_h__ */\r
+/*
+ *  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.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @file saml/saml2/metadata/ChainingMetadataProvider.h
+ * 
+ * MetadataProvider that uses multiple providers in sequence.
+ */
+
+#ifndef __saml_chainmeta_h__
+#define __saml_chainmeta_h__
+
+#include <saml/saml2/metadata/ObservableMetadataProvider.h>
+#include <xmltooling/logging.h>
+#include <xmltooling/util/Threads.h>
+
+namespace opensaml {
+    namespace saml2md {
+
+#if defined (_MSC_VER)
+        #pragma warning( push )
+        #pragma warning( disable : 4251 )
+#endif
+
+        /**
+         * MetadataProvider that uses multiple providers in sequence.
+         */
+        class SAML_API ChainingMetadataProvider
+            : public ObservableMetadataProvider, public ObservableMetadataProvider::Observer {
+        public:
+            /**
+             * Constructor.
+             * 
+             * If a DOM is supplied, the following XML content is supported:
+             * 
+             * <ul>
+             *  <li>&lt;MetadataProvider&gt; elements with a type attribute
+             * </ul>
+             * 
+             * XML namespaces are ignored in the processing of this content.
+             * 
+             * @param e DOM to supply configuration for provider
+             */
+            ChainingMetadataProvider(const xercesc::DOMElement* e=NULL);
+            
+            /**
+             * Destructor will delete any embedded engines.
+             */
+            virtual ~ChainingMetadataProvider();
+    
+            /**
+             * Adds a provider for future calls. The provider <strong>MUST</strong> be
+             * initialized before adding it. 
+             * 
+             * @param newProvider provider to add
+             */
+            void addMetadataProvider(MetadataProvider* newProvider) {
+                m_providers.push_back(newProvider);
+            }
+    
+            /**
+             * Removes a provider. The caller must delete the provider if necessary.
+             * 
+             * @param oldProvider provider to remove
+             * @return  the old provider
+             */
+            MetadataProvider* removeMetadataProvider(MetadataProvider* oldProvider) {
+                for (std::vector<MetadataProvider*>::iterator i=m_providers.begin(); i!=m_providers.end(); i++) {
+                    if (oldProvider==(*i)) {
+                        m_providers.erase(i);
+                        return oldProvider;
+                    }
+                }
+                return NULL;
+            }
+
+            using MetadataProvider::getEntityDescriptor;
+            using MetadataProvider::getEntitiesDescriptor;
+
+            xmltooling::Lockable* lock();
+            void unlock();
+            void init();
+            const xmltooling::XMLObject* getMetadata() const;
+            const EntitiesDescriptor* getEntitiesDescriptor(const char* name, bool requireValidMetadata=true) const;
+            std::pair<const EntityDescriptor*,const RoleDescriptor*> getEntityDescriptor(const Criteria& criteria) const;
+            void onEvent(const ObservableMetadataProvider& provider) 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;
+
+        private:
+            bool m_firstMatch;
+            xmltooling::ThreadKey* m_tlsKey;
+            std::vector<MetadataProvider*> m_providers;
+            xmltooling::logging::Category& m_log;
+        };
+
+#if defined (_MSC_VER)
+        #pragma warning( pop )
+#endif
+
+    };
+};
+
+#endif /* __saml_chainmeta_h__ */