1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/**
* 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.
*
* 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
*
* 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.
*/
/**
* @file saml/saml2/metadata/ObservableMetadataProvider.h
*
* A metadata provider that notifies interested parties of changes.
*/
#ifndef __saml2_obsmetadataprov_h__
#define __saml2_obsmetadataprov_h__
#include <saml/saml2/metadata/MetadataProvider.h>
namespace xmltooling {
class XMLTOOL_API Mutex;
};
namespace opensaml {
namespace saml2md {
#if defined (_MSC_VER)
#pragma warning( push )
#pragma warning( disable : 4251 )
#endif
/**
* A metadata provider that notifies interested parties of changes.
*/
class SAML_API ObservableMetadataProvider : public virtual MetadataProvider
{
protected:
/**
* Constructor.
*
* @param e DOM to supply configuration for provider
* @param deprecationSupport true iff deprecated features and settings should be supported
*/
ObservableMetadataProvider(const xercesc::DOMElement* e=nullptr, bool deprecationSupport=true);
/**
* Convenience method for notifying every registered Observer of an event.
*/
virtual void emitChangeEvent() const;
/**
* Convenience method for notifying every registered Observer of an event.
*/
virtual void emitChangeEvent(const EntityDescriptor& entity) const;
public:
virtual ~ObservableMetadataProvider();
/**
* An observer of metadata provider changes.
*/
class SAML_API Observer {
MAKE_NONCOPYABLE(Observer);
protected:
Observer();
public:
virtual ~Observer();
/**
* Called when a provider signals an event has occured.
* The provider is already locked.
*
* @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;
};
/**
* Adds a metadata observer.
*
* @param newObserver metadata observer to add
*/
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;
private:
boost::scoped_ptr<xmltooling::Mutex> m_observerLock;
mutable std::vector<const Observer*> m_observers;
};
#if defined (_MSC_VER)
#pragma warning( pop )
#endif
};
};
#endif /* __saml2_obsmetadataprov_h__ */
|
