saml/saml2/metadata/DynamicMetadataProvider.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file saml/saml2/metadata/DynamicMetadataProvider.h
  23  *
  24  * Simple implementation of a dynamic caching MetadataProvider.
  25  */
  26
  27 #ifndef __saml2_dynmetadataprov_h__
  28 #define __saml2_dynmetadataprov_h__
  29
  30 #include <saml/saml2/metadata/AbstractMetadataProvider.h>
  31
  32 namespace xmltooling {
  33     class XMLTOOL_API RWLock;
  34 };
  35
  36 namespace opensaml {
  37     namespace saml2md {
  38
  39         /**
  40          * Simple implementation of a dynamic, caching MetadataProvider.
  41          */
  42         class SAML_API DynamicMetadataProvider : public AbstractMetadataProvider
  43         {
  44         public:
  45             /**
  46              * Constructor.
  47              *
  48              * @param e DOM to supply configuration for provider
  49              */
  50             DynamicMetadataProvider(const xercesc::DOMElement* e=nullptr);
  51
  52             virtual ~DynamicMetadataProvider();
  53
  54             void init();
  55             xmltooling::Lockable* lock();
  56             void unlock();
  57             const char* getId() const;
  58             const xmltooling::XMLObject* getMetadata() const;
  59             std::pair<const EntityDescriptor*,const RoleDescriptor*> getEntityDescriptor(const Criteria& criteria) const;
  60
  61         protected:
  62             /** Controls XML schema validation. */
  63             bool m_validate;
  64
  65             /**
  66              * Resolves a metadata instance using the supplied criteria.
  67              *
  68              * @param criteria  lookup criteria
  69              * @return  a valid metadata instance
  70              */
  71             virtual EntityDescriptor* resolve(const Criteria& criteria) const;
  72
  73         private:
  74             std::string m_id;
  75             std::auto_ptr<xmltooling::RWLock> m_lock;
  76             double m_refreshDelayFactor;
  77             time_t m_minCacheDuration, m_maxCacheDuration;
  78             typedef std::map<xmltooling::xstring,time_t> cachemap_t;
  79             mutable cachemap_t m_cacheMap;
  80         };
  81
  82     };
  83 };
  84
  85 #endif /* __saml2_dynmetadataprov_h__ */