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 <xercesc/util/XMLUniDefs.hpp>
28 #include <xmltooling/logging.h>
29 #include <xmltooling/util/XMLHelper.h>
32 using namespace opensaml::saml2md;
33 using namespace opensaml;
34 using namespace xmlsignature;
35 using namespace xmltooling::logging;
36 using namespace xmltooling;
41 MetadataProvider* SAML_DLLLOCAL ChainingMetadataProviderFactory(const DOMElement* const & e)
43 return new ChainingMetadataProvider(e);
48 static const XMLCh _MetadataProvider[] = UNICODE_LITERAL_16(M,e,t,a,d,a,t,a,P,r,o,v,i,d,e,r);
49 static const XMLCh type[] = UNICODE_LITERAL_4(t,y,p,e);
51 ChainingMetadataProvider::ChainingMetadataProvider(const DOMElement* e) : ObservableMetadataProvider(e), m_tlsKey(NULL)
53 Category& log=Category::getInstance(SAML_LOGCAT".Metadata.Chaining");
54 e = e ? XMLHelper::getFirstChildElement(e, _MetadataProvider) : NULL;
56 auto_ptr_char temp(e->getAttributeNS(NULL,type));
57 if (temp.get() && *temp.get()) {
59 log.info("building MetadataProvider of type %s", temp.get());
60 auto_ptr<MetadataProvider> provider(
61 SAMLConfig::getConfig().MetadataProviderManager.newPlugin(temp.get(), e)
63 ObservableMetadataProvider* obs = dynamic_cast<ObservableMetadataProvider*>(provider.get());
65 obs->addObserver(this);
66 m_providers.push_back(provider.get());
69 catch (exception& ex) {
70 log.error("error building MetadataProvider: %s", ex.what());
73 e = XMLHelper::getNextSiblingElement(e, _MetadataProvider);
75 m_tlsKey = ThreadKey::create(NULL);
78 ChainingMetadataProvider::~ChainingMetadataProvider()
81 for_each(m_providers.begin(), m_providers.end(), xmltooling::cleanup<MetadataProvider>());
84 void ChainingMetadataProvider::onEvent(const ObservableMetadataProvider& provider) const
89 void ChainingMetadataProvider::init()
91 for (vector<MetadataProvider*>::const_iterator i=m_providers.begin(); i!=m_providers.end(); ++i) {
95 catch (exception& ex) {
96 Category::getInstance(SAML_LOGCAT".Metadata").error("failure initializing MetadataProvider: %s", ex.what());
101 Lockable* ChainingMetadataProvider::lock()
103 return this; // we're not lockable ourselves...
106 void ChainingMetadataProvider::unlock()
108 // Check for a locked provider.
109 void* ptr=m_tlsKey->getData();
111 m_tlsKey->setData(NULL);
112 reinterpret_cast<MetadataProvider*>(ptr)->unlock();
116 const XMLObject* ChainingMetadataProvider::getMetadata() const
118 throw MetadataException("getMetadata operation not implemented on this provider.");
121 const EntitiesDescriptor* ChainingMetadataProvider::getEntitiesDescriptor(const char* name, bool requireValidMetadata) const
123 // Clear any existing lock.
124 const_cast<ChainingMetadataProvider*>(this)->unlock();
127 const EntitiesDescriptor* ret=NULL;
128 for (vector<MetadataProvider*>::const_iterator i=m_providers.begin(); i!=m_providers.end(); ++i) {
130 if (ret=(*i)->getEntitiesDescriptor(name,requireValidMetadata)) {
131 // Save locked provider.
132 m_tlsKey->setData(*i);
141 pair<const EntityDescriptor*,const RoleDescriptor*> ChainingMetadataProvider::getEntityDescriptor(const Criteria& criteria) const
143 // Clear any existing lock.
144 const_cast<ChainingMetadataProvider*>(this)->unlock();
147 pair<const EntityDescriptor*,const RoleDescriptor*> ret;
150 for (vector<MetadataProvider*>::const_iterator i=m_providers.begin(); i!=m_providers.end(); ++i) {
152 if ((ret=(*i)->getEntityDescriptor(criteria)).first) {
153 // Save locked provider.
154 m_tlsKey->setData(*i);
163 const Credential* ChainingMetadataProvider::resolve(const CredentialCriteria* criteria) const
165 // Check for a locked provider.
166 void* ptr=m_tlsKey->getData();
168 throw MetadataException("No locked MetadataProvider, where did the role object come from?");
170 return reinterpret_cast<MetadataProvider*>(ptr)->resolve(criteria);
173 vector<const Credential*>::size_type ChainingMetadataProvider::resolve(
174 vector<const Credential*>& results, const CredentialCriteria* criteria
177 // Check for a locked provider.
178 void* ptr=m_tlsKey->getData();
180 throw MetadataException("No locked MetadataProvider, where did the role object come from?");
182 return reinterpret_cast<MetadataProvider*>(ptr)->resolve(results, criteria);