2 * Copyright 2001-2007 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * XMLMetadataProvider.cpp
20 * Supplies metadata from an XML file
24 #include "saml2/metadata/Metadata.h"
25 #include "saml2/metadata/MetadataFilter.h"
26 #include "saml2/metadata/AbstractMetadataProvider.h"
28 #include <xmltooling/util/NDC.h>
29 #include <xmltooling/util/ReloadableXMLFile.h>
31 using namespace opensaml::saml2md;
32 using namespace xmltooling::logging;
33 using namespace xmltooling;
36 #if defined (_MSC_VER)
37 #pragma warning( push )
38 #pragma warning( disable : 4250 )
44 class SAML_DLLLOCAL XMLMetadataProvider : public AbstractMetadataProvider, public ReloadableXMLFile
47 XMLMetadataProvider(const DOMElement* e)
48 : AbstractMetadataProvider(e), ReloadableXMLFile(e, Category::getInstance(SAML_LOGCAT".MetadataProvider.XML")),
49 m_object(NULL), m_maxCacheDuration(m_reloadInterval) {
51 virtual ~XMLMetadataProvider() {
56 load(); // guarantees an exception or the metadata is loaded
59 const XMLObject* getMetadata() const {
64 pair<bool,DOMElement*> load();
67 using AbstractMetadataProvider::index;
71 time_t m_maxCacheDuration;
74 MetadataProvider* SAML_DLLLOCAL XMLMetadataProviderFactory(const DOMElement* const & e)
76 return new XMLMetadataProvider(e);
82 #if defined (_MSC_VER)
83 #pragma warning( pop )
86 pair<bool,DOMElement*> XMLMetadataProvider::load()
88 // Load from source using base class.
89 pair<bool,DOMElement*> raw = ReloadableXMLFile::load();
91 // If we own it, wrap it for now.
92 XercesJanitor<DOMDocument> docjanitor(raw.first ? raw.second->getOwnerDocument() : NULL);
94 // Unmarshall objects, binding the document.
95 auto_ptr<XMLObject> xmlObject(XMLObjectBuilder::buildOneFromElement(raw.second, true));
98 if (!dynamic_cast<const EntitiesDescriptor*>(xmlObject.get()) && !dynamic_cast<const EntityDescriptor*>(xmlObject.get()))
99 throw MetadataException(
100 "Root of metadata instance not recognized: $1", params(1,xmlObject->getElementQName().toString().c_str())
103 // Preprocess the metadata.
104 doFilters(*xmlObject.get());
105 xmlObject->releaseThisAndChildrenDOM();
106 xmlObject->setDocument(NULL);
109 bool changed = m_object!=NULL;
111 m_object = xmlObject.release();
116 // If a remote resource, reduce the reload interval if cacheDuration is set.
118 const CacheableSAMLObject* cacheable = dynamic_cast<const CacheableSAMLObject*>(m_object);
119 if (cacheable && cacheable->getCacheDuration() && cacheable->getCacheDurationEpoch() < m_maxCacheDuration)
120 m_reloadInterval = cacheable->getCacheDurationEpoch();
122 m_reloadInterval = m_maxCacheDuration;
125 return make_pair(false,(DOMElement*)NULL);
128 void XMLMetadataProvider::index()
130 clearDescriptorIndex();
131 EntitiesDescriptor* group=dynamic_cast<EntitiesDescriptor*>(m_object);
133 AbstractMetadataProvider::index(group, SAMLTIME_MAX);
136 EntityDescriptor* site=dynamic_cast<EntityDescriptor*>(m_object);
137 AbstractMetadataProvider::index(site, SAMLTIME_MAX);