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 * ChainingMetadataProvider.cpp
20 * MetadataProvider that uses multiple providers in sequence.
24 #include "exceptions.h"
25 #include "saml2/metadata/ChainingMetadataProvider.h"
27 #include <log4cpp/Category.hh>
28 #include <xmltooling/util/XMLHelper.h>
29 #include <xercesc/util/XMLUniDefs.hpp>
31 using namespace opensaml::saml2md;
32 using namespace opensaml;
33 using namespace xmlsignature;
34 using namespace xmltooling;
35 using namespace log4cpp;
40 MetadataProvider* SAML_DLLLOCAL ChainingMetadataProviderFactory(const DOMElement* const & e)
42 return new ChainingMetadataProvider(e);
47 static const XMLCh _MetadataProvider[] = UNICODE_LITERAL_16(M,e,t,a,d,a,t,a,P,r,o,v,i,d,e,r);
48 static const XMLCh type[] = UNICODE_LITERAL_4(t,y,p,e);
50 ChainingMetadataProvider::ChainingMetadataProvider(const DOMElement* e) : ObservableMetadataProvider(e), m_tlsKey(NULL)
52 Category& log=Category::getInstance(SAML_LOGCAT".Metadata");
53 e = e ? XMLHelper::getFirstChildElement(e, _MetadataProvider) : NULL;
55 auto_ptr_char temp(e->getAttributeNS(NULL,type));
56 if (temp.get() && *temp.get()) {
58 log.info("building MetadataProvider of type %s", temp.get());
59 auto_ptr<MetadataProvider> provider(
60 SAMLConfig::getConfig().MetadataProviderManager.newPlugin(temp.get(), e)
62 ObservableMetadataProvider* obs = dynamic_cast<ObservableMetadataProvider*>(provider.get());
64 obs->addObserver(this);
65 m_providers.push_back(provider.get());
68 catch (exception& ex) {
69 log.error("error building MetadataProvider: %s", ex.what());
72 e = XMLHelper::getNextSiblingElement(e, _MetadataProvider);
74 m_tlsKey = ThreadKey::create(NULL);
77 ChainingMetadataProvider::~ChainingMetadataProvider()
80 for_each(m_providers.begin(), m_providers.end(), xmltooling::cleanup<MetadataProvider>());
83 void ChainingMetadataProvider::onEvent(const ObservableMetadataProvider& provider) const
88 void ChainingMetadataProvider::init()
90 for (vector<MetadataProvider*>::const_iterator i=m_providers.begin(); i!=m_providers.end(); ++i) {
94 catch (exception& ex) {
95 Category::getInstance(SAML_LOGCAT".Metadata").error("failure initializing MetadataProvider: %s", ex.what());
100 Lockable* ChainingMetadataProvider::lock()
102 return this; // we're not lockable ourselves...
105 void ChainingMetadataProvider::unlock()
107 // Check for a locked provider.
108 void* ptr=m_tlsKey->getData();
110 m_tlsKey->setData(NULL);
111 reinterpret_cast<MetadataProvider*>(ptr)->unlock();
115 const XMLObject* ChainingMetadataProvider::getMetadata() const
117 throw XMLToolingException("getMetadata operation not implemented on this provider.");
120 const EntitiesDescriptor* ChainingMetadataProvider::getEntitiesDescriptor(const char* name, bool requireValidMetadata) const
122 // Clear any existing lock.
123 const_cast<ChainingMetadataProvider*>(this)->unlock();
126 const EntitiesDescriptor* ret=NULL;
127 for (vector<MetadataProvider*>::const_iterator i=m_providers.begin(); i!=m_providers.end(); ++i) {
129 if (ret=(*i)->getEntitiesDescriptor(name,requireValidMetadata)) {
130 // Save locked provider.
131 m_tlsKey->setData(*i);
140 const EntityDescriptor* ChainingMetadataProvider::getEntityDescriptor(const char* id, bool requireValidMetadata) const
142 // Clear any existing lock.
143 const_cast<ChainingMetadataProvider*>(this)->unlock();
146 const EntityDescriptor* ret=NULL;
147 for (vector<MetadataProvider*>::const_iterator i=m_providers.begin(); i!=m_providers.end(); ++i) {
149 if (ret=(*i)->getEntityDescriptor(id,requireValidMetadata)) {
150 // Save locked provider.
151 m_tlsKey->setData(*i);
160 const EntityDescriptor* ChainingMetadataProvider::getEntityDescriptor(const SAMLArtifact* artifact) const
162 // Clear any existing lock.
163 const_cast<ChainingMetadataProvider*>(this)->unlock();
166 const EntityDescriptor* ret=NULL;
167 for (vector<MetadataProvider*>::const_iterator i=m_providers.begin(); i!=m_providers.end(); ++i) {
169 if (ret=(*i)->getEntityDescriptor(artifact)) {
170 // Save locked provider.
171 m_tlsKey->setData(*i);
180 const Credential* ChainingMetadataProvider::resolve(const CredentialCriteria* criteria) const
182 // Check for a locked provider.
183 void* ptr=m_tlsKey->getData();
185 throw MetadataException("No locked MetadataProvider, where did the role object come from?");
187 return reinterpret_cast<MetadataProvider*>(ptr)->resolve(criteria);
190 vector<const Credential*>::size_type ChainingMetadataProvider::resolve(
191 vector<const Credential*>& results, const CredentialCriteria* criteria
194 // Check for a locked provider.
195 void* ptr=m_tlsKey->getData();
197 throw MetadataException("No locked MetadataProvider, where did the role object come from?");
199 return reinterpret_cast<MetadataProvider*>(ptr)->resolve(results, criteria);