Change license header, remove stale pkg files.

[shibboleth/cpp-opensaml.git] / saml / saml2 / metadata / DynamicMetadataProvider.h

diff --git a/saml/saml2/metadata/DynamicMetadataProvider.h b/saml/saml2/metadata/DynamicMetadataProvider.h
index 7ca322c..26c8f2a 100644 (file)
--- a/saml/saml2/metadata/DynamicMetadataProvider.h
+++ b/saml/saml2/metadata/DynamicMetadataProvider.h
@@ -1,22 +1,26 @@
-/*
- *  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
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you 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
+ * 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.
+ * 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/DynamicMetadataProvider.h
- * 
+ *
  * Simple implementation of a dynamic caching MetadataProvider.
  */
 
@@ -25,6 +29,10 @@
 
 #include <saml/saml2/metadata/AbstractMetadataProvider.h>
 
+namespace xmltooling {
+    class XMLTOOL_API RWLock;
+};
+
 namespace opensaml {
     namespace saml2md {
 
@@ -36,29 +44,17 @@ namespace opensaml {
         public:
             /**
              * Constructor.
-             * 
+             *
              * @param e DOM to supply configuration for provider
              */
-            DynamicMetadataProvider(const xercesc::DOMElement* e=NULL);
+            DynamicMetadataProvider(const xercesc::DOMElement* e=nullptr);
 
             virtual ~DynamicMetadataProvider();
 
-            xmltooling::Lockable* lock() {
-                m_lock->rdlock();
-                return this;
-            }
-
-            void unlock() {
-                m_lock->unlock();
-            }
-
-            void init() {
-            }
-
-            const xmltooling::XMLObject* getMetadata() const {
-                throw MetadataException("getMetadata operation not implemented on this provider.");
-            }
-
+            void init();
+            xmltooling::Lockable* lock();
+            void unlock();
+            const xmltooling::XMLObject* getMetadata() const;
             std::pair<const EntityDescriptor*,const RoleDescriptor*> getEntityDescriptor(const Criteria& criteria) const;
 
         protected:
@@ -66,17 +62,21 @@ namespace opensaml {
             bool m_validate;
 
             /**
-             * Resolves an entityID into a metadata instance for that entity.
-             * 
-             * @param entityID      entity ID to resolve
+             * Resolves a metadata instance using the supplied criteria.
+             *
+             * @param criteria  lookup criteria
              * @return  a valid metadata instance
              */
-            virtual EntityDescriptor* resolve(const char* entityID) const;
+            virtual EntityDescriptor* resolve(const Criteria& criteria) const;
 
         private:
             mutable xmltooling::RWLock* m_lock;
+            double m_refreshDelayFactor;
+            time_t m_minCacheDuration, m_maxCacheDuration;
+            typedef std::map<xmltooling::xstring,time_t> cachemap_t;
+            mutable cachemap_t m_cacheMap;
         };
-        
+
     };
 };