X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=saml%2Fsaml2%2Fmetadata%2FObservableMetadataProvider.h;h=fab712bbe73301c6d66049a50e8d46264ec92815;hb=HEAD;hp=3bdc04320825d04780b856ed67268e61cb5f23af;hpb=193d726a21522f8f2978b4e578733bae4a279c78;p=shibboleth%2Fcpp-opensaml.git diff --git a/saml/saml2/metadata/ObservableMetadataProvider.h b/saml/saml2/metadata/ObservableMetadataProvider.h index 3bdc043..fab712b 100644 --- a/saml/saml2/metadata/ObservableMetadataProvider.h +++ b/saml/saml2/metadata/ObservableMetadataProvider.h @@ -1,17 +1,21 @@ -/* - * 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. * - * http://www.apache.org/licenses/LICENSE-2.0 + * 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 * - * 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. + * 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. */ /** @@ -24,7 +28,10 @@ #define __saml2_obsmetadataprov_h__ #include -#include + +namespace xmltooling { + class XMLTOOL_API Mutex; +}; namespace opensaml { @@ -37,7 +44,7 @@ namespace opensaml { /** * A metadata provider that notifies interested parties of changes. */ - class SAML_API ObservableMetadataProvider : public MetadataProvider + class SAML_API ObservableMetadataProvider : public virtual MetadataProvider { protected: /** @@ -45,24 +52,20 @@ namespace opensaml { * * @param e DOM to supply configuration for provider */ - ObservableMetadataProvider(const DOMElement* e=NULL) - : MetadataProvider(e), m_observerLock(xmltooling::Mutex::create()) { - } + ObservableMetadataProvider(const xercesc::DOMElement* e=nullptr); /** * Convenience method for notifying every registered Observer of an event. */ - virtual void emitChangeEvent() const { - xmltooling::Lock lock(m_observerLock); - for (std::vector::const_iterator i=m_observers.begin(); i!=m_observers.end(); i++) { - (*i)->onEvent(*this); - } - } + virtual void emitChangeEvent() const; + + /** + * Convenience method for notifying every registered Observer of an event. + */ + virtual void emitChangeEvent(const EntityDescriptor& entity) const; public: - virtual ~ObservableMetadataProvider() { - delete m_observerLock; - } + virtual ~ObservableMetadataProvider(); /** * An observer of metadata provider changes. @@ -70,9 +73,9 @@ namespace opensaml { class SAML_API Observer { MAKE_NONCOPYABLE(Observer); protected: - Observer() {} + Observer(); public: - virtual ~Observer() {} + virtual ~Observer(); /** * Called when a provider signals an event has occured. @@ -81,6 +84,15 @@ namespace opensaml { * @param provider the provider being observed */ virtual void onEvent(const ObservableMetadataProvider& provider) const=0; + + /** + * Called when a provider signals an event has occured. + * The provider is already locked. + * + * @param provider the provider being observed + * @param entity the entity that underwent modification + */ + virtual void onEvent(const ObservableMetadataProvider& provider, const EntityDescriptor& entity) const; }; /** @@ -88,10 +100,7 @@ namespace opensaml { * * @param newObserver metadata observer to add */ - virtual void addObserver(const Observer* newObserver) const { - xmltooling::Lock lock(m_observerLock); - m_observers.push_back(newObserver); - } + virtual void addObserver(const Observer* newObserver) const; /** * Removes a metadata observer. @@ -99,19 +108,10 @@ namespace opensaml { * @param oldObserver metadata observer to remove * @return the old observer */ - virtual const Observer* removeObserver(const Observer* oldObserver) const { - xmltooling::Lock lock(m_observerLock); - for (std::vector::iterator i=m_observers.begin(); i!=m_observers.end(); i++) { - if (oldObserver==(*i)) { - m_observers.erase(i); - return oldObserver; - } - } - return NULL; - } + virtual const Observer* removeObserver(const Observer* oldObserver) const; private: - mutable xmltooling::Mutex* m_observerLock; + mutable std::auto_ptr m_observerLock; mutable std::vector m_observers; };