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 * @file saml/saml2/metadata/ObservableMetadataProvider.h
20 * A metadata provider that notifies interested parties of changes.
23 #ifndef __saml2_obsmetadataprov_h__
24 #define __saml2_obsmetadataprov_h__
26 #include <saml/saml2/metadata/MetadataProvider.h>
32 #if defined (_MSC_VER)
33 #pragma warning( push )
34 #pragma warning( disable : 4251 )
37 * A metadata provider that notifies interested parties of changes.
39 class SAML_API ObservableMetadataProvider : public MetadataProvider
45 * @param e DOM to supply configuration for provider
47 ObservableMetadataProvider(const DOMElement* e=NULL) : MetadataProvider(e) {}
50 * Convenience method for notifying every registered Observer of an event.
52 virtual void emitChangeEvent();
56 * Destructor will delete any installed filters.
58 virtual ~ObservableMetadataProvider();
61 * An observer of metadata provider changes.
63 class SAML_API Observer {
64 MAKE_NONCOPYABLE(Observer);
68 virtual ~Observer() {}
71 * Called when a provider signals an event has occured.
72 * The provider is already locked.
74 * @param provider the provider being observed
76 virtual void onEvent(MetadataProvider& provider)=0;
80 * Adds a metadata observer.
82 * @param newObserver metadata observer to add
84 virtual void addObserver(Observer* newObserver) {
85 m_observers.push_back(newObserver);
89 * Removes a metadata observer. The caller must delete the observer if necessary.
91 * @param oldObserver metadata observer to remove
92 * @return the old observer
94 virtual Observer* removeObserver(Observer* oldObserver) {
95 for (std::vector<Observer*>::iterator i=m_observers.begin(); i!=m_observers.end(); i++) {
96 if (oldObserver==(*i)) {
105 std::vector<Observer*> m_observers;
108 #if defined (_MSC_VER)
109 #pragma warning( pop )
115 #endif /* __saml2_obsmetadataprov_h__ */