saml/saml2/metadata/ObservableMetadataProvider.h

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * @file saml/saml2/metadata/ObservableMetadataProvider.h
  19  *
  20  * A metadata provider that notifies interested parties of changes.
  21  */
  22
  23 #ifndef __saml2_obsmetadataprov_h__
  24 #define __saml2_obsmetadataprov_h__
  25
  26 #include <saml/saml2/metadata/MetadataProvider.h>
  27
  28 namespace opensaml {
  29
  30     namespace saml2md {
  31
  32         /**
  33          * A metadata provider that notifies interested parties of changes.
  34          */
  35         class SAML_API ObservableMetadataProvider : public MetadataProvider
  36         {
  37         protected:
  38             /**
  39              * Constructor.
  40              *
  41              * @param e DOM to supply configuration for provider
  42              */
  43             ObservableMetadataProvider(const DOMElement* e=NULL) : MetadataProvider(e) {}
  44
  45             /**
  46              * Convenience method for notifying every registered Observer of an event.
  47              */
  48             virtual void emitChangeEvent();
  49
  50         public:
  51             /**
  52              * Destructor will delete any installed filters.
  53              */
  54             virtual ~ObservableMetadataProvider();
  55
  56             /**
  57              * An observer of metadata provider changes.
  58              */
  59             class SAML_API Observer {
  60                 MAKE_NONCOPYABLE(Observer);
  61             protected:
  62                 Observer() {}
  63             public:
  64                 virtual ~Observer() {}
  65
  66                 /**
  67                  * Called when a provider signals an event has occured.
  68                  * The provider is already locked.
  69                  *
  70                  * @param provider the provider being observed
  71                  */
  72                 virtual void onEvent(MetadataProvider& provider)=0;
  73             };
  74
  75             /**
  76              * Adds a metadata observer.
  77              *
  78              * @param newObserver metadata observer to add
  79              */
  80             virtual void addObserver(Observer* newObserver) {
  81                 m_observers.push_back(newObserver);
  82             }
  83
  84             /**
  85              * Removes a metadata observer. The caller must delete the observer if necessary.
  86              *
  87              * @param oldObserver metadata observer to remove
  88              * @return  the old observer
  89              */
  90             virtual Observer* removeObserver(Observer* oldObserver) {
  91                 for (std::vector<Observer*>::iterator i=m_observers.begin(); i!=m_observers.end(); i++) {
  92                     if (oldObserver==(*i)) {
  93                         m_observers.erase(i);
  94                         return oldObserver;
  95                     }
  96                 }
  97                 return NULL;
  98             }
  99
 100         private:
 101             std::vector<Observer*> m_observers;
 102         };
 103     };
 104 };
 105
 106 #endif /* __saml2_obsmetadataprov_h__ */