-/*
- * 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.
*/
/**
#define __saml2_obsmetadataprov_h__
#include <saml/saml2/metadata/MetadataProvider.h>
-#include <xmltooling/util/Threads.h>
+
+namespace xmltooling {
+ class XMLTOOL_API Mutex;
+};
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:
/**
*
* @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 Observer*>::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.
class SAML_API Observer {
MAKE_NONCOPYABLE(Observer);
protected:
- Observer() {}
+ Observer();
public:
- virtual ~Observer() {}
+ virtual ~Observer();
/**
* Called when a provider signals an event has occured.
*
* @param provider the provider being observed
*/
- virtual void onEvent(const MetadataProvider& provider) const=0;
+ 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;
};
/**
*
* @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.
* @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<const Observer*>::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<xmltooling::Mutex> m_observerLock;
mutable std::vector<const Observer*> m_observers;
};