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 virtual ~SPConfig() {}
71 * Returns the global configuration object for the library.
73 * @return reference to the global library configuration object
75 static SPConfig& getConfig();
78 * Bitmask values representing subsystems of the library.
87 AttributeResolution = 32,
97 * Set a bitmask of subsystems to activate.
99 * @param enabled bitmask of component constants
101 void setFeatures(unsigned long enabled) {
102 m_features = enabled;
106 * Test whether a subsystem is enabled.
108 * @param feature subsystem/component to test
109 * @return true iff feature is enabled
111 bool isEnabled(components_t feature) {
112 return (m_features & feature)>0;
116 * Initializes library
118 * Each process using the library MUST call this function exactly once
119 * before using any library classes.
121 * @param catalog_path delimited set of schema catalog files to load
122 * @return true iff initialization was successful
124 virtual bool init(const char* catalog_path)=0;
129 * Each process using the library SHOULD call this function exactly once
130 * before terminating itself.
132 virtual void term()=0;
135 * Sets the global ServiceProvider instance.
136 * This method must be externally synchronized with any code that uses the object.
137 * Any previously set object is destroyed.
139 * @param serviceProvider new ServiceProvider instance to store
141 void setServiceProvider(ServiceProvider* serviceProvider);
144 * Returns the global ServiceProvider instance.
146 * @return global ServiceProvider or NULL
148 ServiceProvider* getServiceProvider() const {
149 return m_serviceProvider;
154 * Sets the global ArtifactResolver instance.
156 * <p>This method must be externally synchronized with any code that uses the object.
157 * Any previously set object is destroyed.
159 * @param artifactResolver new ArtifactResolver instance to store
161 void setArtifactResolver(opensaml::MessageDecoder::ArtifactResolver* artifactResolver) {
162 delete m_artifactResolver;
163 m_artifactResolver = artifactResolver;
167 * Returns the global ArtifactResolver instance.
169 * @return global ArtifactResolver or NULL
171 opensaml::MessageDecoder::ArtifactResolver* getArtifactResolver() const {
172 return m_artifactResolver;
176 /** Separator for serialized values of multi-valued attributes. */
177 char attribute_value_delimeter;
180 * Manages factories for AccessControl plugins.
182 xmltooling::PluginManager<AccessControl,std::string,const xercesc::DOMElement*> AccessControlManager;
186 * Manages factories for AttributeDecoder plugins.
188 xmltooling::PluginManager<AttributeDecoder,xmltooling::QName,const xercesc::DOMElement*> AttributeDecoderManager;
191 * Manages factories for AttributeExtractor plugins.
193 xmltooling::PluginManager<AttributeExtractor,std::string,const xercesc::DOMElement*> AttributeExtractorManager;
196 * Manages factories for AttributeFilter plugins.
198 xmltooling::PluginManager<AttributeFilter,std::string,const xercesc::DOMElement*> AttributeFilterManager;
201 * Manages factories for AttributeResolver plugins.
203 xmltooling::PluginManager<AttributeResolver,std::string,const xercesc::DOMElement*> AttributeResolverManager;
206 * Manages factories for MatchFunctor plugins.
208 xmltooling::PluginManager< MatchFunctor,xmltooling::QName,std::pair<const FilterPolicyContext*,const xercesc::DOMElement*> > MatchFunctorManager;
212 * Manages factories for Handler plugins that implement ArtifactResolutionService functionality.
214 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > ArtifactResolutionServiceManager;
217 * Manages factories for Handler plugins that implement AssertionConsumerService functionality.
219 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > AssertionConsumerServiceManager;
222 * Manages factories for Handler plugins that implement customized functionality.
224 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > HandlerManager;
227 * Manages factories for ListenerService plugins.
229 xmltooling::PluginManager<ListenerService,std::string,const xercesc::DOMElement*> ListenerServiceManager;
232 * Manages factories for Handler plugins that implement LogoutInitiator functionality.
234 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > LogoutInitiatorManager;
237 * Manages factories for Handler plugins that implement ManageNameIDService functionality.
239 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > ManageNameIDServiceManager;
242 * Manages factories for RequestMapper plugins.
244 xmltooling::PluginManager<RequestMapper,std::string,const xercesc::DOMElement*> RequestMapperManager;
247 * Manages factories for ServiceProvider plugins.
249 xmltooling::PluginManager<ServiceProvider,std::string,const xercesc::DOMElement*> ServiceProviderManager;
252 * Manages factories for SessionCache plugins.
254 xmltooling::PluginManager<SessionCache,std::string,const xercesc::DOMElement*> SessionCacheManager;
257 * Manages factories for Handler plugins that implement SessionInitiator functionality.
259 xmltooling::PluginManager< SessionInitiator,std::string,std::pair<const xercesc::DOMElement*,const char*> > SessionInitiatorManager;
262 * Manages factories for Handler plugins that implement SingleLogoutService functionality.
264 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > SingleLogoutServiceManager;
267 SPConfig() : attribute_value_delimeter(';'), m_serviceProvider(NULL),
269 m_artifactResolver(NULL),
273 /** Global ServiceProvider instance. */
274 ServiceProvider* m_serviceProvider;
277 /** Global ArtifactResolver instance. */
278 opensaml::MessageDecoder::ArtifactResolver* m_artifactResolver;
282 unsigned long m_features;
285 #if defined (_MSC_VER)
286 #pragma warning( pop )
291 #endif /* __shibsp_config_h__ */