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 shibsp/SPConfig.h
20 * Library configuration
23 #ifndef __shibsp_config_h__
24 #define __shibsp_config_h__
26 #include <shibsp/base.h>
28 # include <saml/binding/MessageDecoder.h>
30 #include <xmltooling/PluginManager.h>
31 #include <xercesc/dom/DOM.hpp>
35 * Shibboleth Service Provider Library
39 class SHIBSP_API AccessControl;
40 class SHIBSP_API Handler;
41 class SHIBSP_API ListenerService;
42 class SHIBSP_API RequestMapper;
43 class SHIBSP_API ServiceProvider;
44 class SHIBSP_API SessionCache;
45 class SHIBSP_API SessionInitiator;
48 class SHIBSP_API AttributeDecoder;
49 class SHIBSP_API AttributeExtractor;
50 class SHIBSP_API AttributeFilter;
51 class SHIBSP_API AttributeResolver;
52 class SHIBSP_API FilterPolicyContext;
53 class SHIBSP_API MatchFunctor;
56 #if defined (_MSC_VER)
57 #pragma warning( push )
58 #pragma warning( disable : 4250 4251 )
62 * Singleton object that manages library startup/shutdown.
64 class SHIBSP_API SPConfig
66 MAKE_NONCOPYABLE(SPConfig);
68 SPConfig() : attribute_value_delimeter(';'), m_serviceProvider(NULL),
70 m_artifactResolver(NULL),
74 virtual ~SPConfig() {}
77 * Returns the global configuration object for the library.
79 * @return reference to the global library configuration object
81 static SPConfig& getConfig();
84 * Bitmask values representing subsystems of the library.
93 AttributeResolution = 32,
103 * Set a bitmask of subsystems to activate.
105 * @param enabled bitmask of component constants
107 void setFeatures(unsigned long enabled) {
108 m_features = enabled;
112 * Test whether a subsystem is enabled.
114 * @param feature subsystem/component to test
115 * @return true iff feature is enabled
117 bool isEnabled(components_t feature) {
118 return (m_features & feature)>0;
122 * Initializes library
124 * Each process using the library MUST call this function exactly once
125 * before using any library classes.
127 * @param catalog_path delimited set of schema catalog files to load
128 * @param inst_prefix installation prefix for software
129 * @return true iff initialization was successful
131 virtual bool init(const char* catalog_path=NULL, const char* inst_prefix=NULL);
136 * Each process using the library SHOULD call this function exactly once
137 * before terminating itself.
142 * Sets the global ServiceProvider instance.
143 * This method must be externally synchronized with any code that uses the object.
144 * Any previously set object is destroyed.
146 * @param serviceProvider new ServiceProvider instance to store
148 void setServiceProvider(ServiceProvider* serviceProvider);
151 * Returns the global ServiceProvider instance.
153 * @return global ServiceProvider or NULL
155 ServiceProvider* getServiceProvider() const {
156 return m_serviceProvider;
161 * Sets the global ArtifactResolver instance.
163 * <p>This method must be externally synchronized with any code that uses the object.
164 * Any previously set object is destroyed.
166 * @param artifactResolver new ArtifactResolver instance to store
168 void setArtifactResolver(opensaml::MessageDecoder::ArtifactResolver* artifactResolver) {
169 delete m_artifactResolver;
170 m_artifactResolver = artifactResolver;
174 * Returns the global ArtifactResolver instance.
176 * @return global ArtifactResolver or NULL
178 opensaml::MessageDecoder::ArtifactResolver* getArtifactResolver() const {
179 return m_artifactResolver;
183 /** Separator for serialized values of multi-valued attributes. */
184 char attribute_value_delimeter;
187 * Manages factories for AccessControl plugins.
189 xmltooling::PluginManager<AccessControl,std::string,const xercesc::DOMElement*> AccessControlManager;
193 * Manages factories for AttributeDecoder plugins.
195 xmltooling::PluginManager<AttributeDecoder,xmltooling::QName,const xercesc::DOMElement*> AttributeDecoderManager;
198 * Manages factories for AttributeExtractor plugins.
200 xmltooling::PluginManager<AttributeExtractor,std::string,const xercesc::DOMElement*> AttributeExtractorManager;
203 * Manages factories for AttributeFilter plugins.
205 xmltooling::PluginManager<AttributeFilter,std::string,const xercesc::DOMElement*> AttributeFilterManager;
208 * Manages factories for AttributeResolver plugins.
210 xmltooling::PluginManager<AttributeResolver,std::string,const xercesc::DOMElement*> AttributeResolverManager;
213 * Manages factories for MatchFunctor plugins.
215 xmltooling::PluginManager< MatchFunctor,xmltooling::QName,std::pair<const FilterPolicyContext*,const xercesc::DOMElement*> > MatchFunctorManager;
219 * Manages factories for Handler plugins that implement ArtifactResolutionService functionality.
221 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > ArtifactResolutionServiceManager;
224 * Manages factories for Handler plugins that implement AssertionConsumerService functionality.
226 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > AssertionConsumerServiceManager;
229 * Manages factories for Handler plugins that implement customized functionality.
231 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > HandlerManager;
234 * Manages factories for ListenerService plugins.
236 xmltooling::PluginManager<ListenerService,std::string,const xercesc::DOMElement*> ListenerServiceManager;
239 * Manages factories for Handler plugins that implement LogoutInitiator functionality.
241 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > LogoutInitiatorManager;
244 * Manages factories for Handler plugins that implement ManageNameIDService functionality.
246 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > ManageNameIDServiceManager;
249 * Manages factories for RequestMapper plugins.
251 xmltooling::PluginManager<RequestMapper,std::string,const xercesc::DOMElement*> RequestMapperManager;
254 * Manages factories for ServiceProvider plugins.
256 xmltooling::PluginManager<ServiceProvider,std::string,const xercesc::DOMElement*> ServiceProviderManager;
259 * Manages factories for SessionCache plugins.
261 xmltooling::PluginManager<SessionCache,std::string,const xercesc::DOMElement*> SessionCacheManager;
264 * Manages factories for Handler plugins that implement SessionInitiator functionality.
266 xmltooling::PluginManager< SessionInitiator,std::string,std::pair<const xercesc::DOMElement*,const char*> > SessionInitiatorManager;
269 * Manages factories for Handler plugins that implement SingleLogoutService functionality.
271 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > SingleLogoutServiceManager;
274 /** Global ServiceProvider instance. */
275 ServiceProvider* m_serviceProvider;
278 /** Global ArtifactResolver instance. */
279 opensaml::MessageDecoder::ArtifactResolver* m_artifactResolver;
283 unsigned long m_features;
286 #if defined (_MSC_VER)
287 #pragma warning( pop )
292 #endif /* __shibsp_config_h__ */