2 * Copyright 2001-2009 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>
29 # include <saml/binding/MessageDecoder.h>
30 # include <saml/binding/MessageEncoder.h>
32 #include <xmltooling/PluginManager.h>
33 #include <xmltooling/QName.h>
34 #include <xercesc/dom/DOM.hpp>
38 * Shibboleth Service Provider Library
42 class SHIBSP_API AccessControl;
43 class SHIBSP_API Handler;
44 class SHIBSP_API ListenerService;
45 class SHIBSP_API RequestMapper;
46 class SHIBSP_API ServiceProvider;
47 class SHIBSP_API SessionCache;
48 class SHIBSP_API SessionInitiator;
51 class SHIBSP_API AttributeDecoder;
52 class SHIBSP_API AttributeExtractor;
53 class SHIBSP_API AttributeFilter;
54 class SHIBSP_API AttributeResolver;
55 class SHIBSP_API FilterPolicyContext;
56 class SHIBSP_API MatchFunctor;
59 #if defined (_MSC_VER)
60 #pragma warning( push )
61 #pragma warning( disable : 4250 4251 )
65 * Singleton object that manages library startup/shutdown.
67 class SHIBSP_API SPConfig
69 MAKE_NONCOPYABLE(SPConfig);
71 SPConfig() : attribute_value_delimeter(';'), m_serviceProvider(NULL),
73 m_artifactResolver(NULL),
75 m_features(0), m_configDoc(NULL) {
78 virtual ~SPConfig() {}
81 * Returns the global configuration object for the library.
83 * @return reference to the global library configuration object
85 static SPConfig& getConfig();
88 * Bitmask values representing subsystems of the library.
97 AttributeResolution = 32,
107 * Set a bitmask of subsystems to activate.
109 * @param enabled bitmask of component constants
111 void setFeatures(unsigned long enabled) {
112 m_features = enabled;
116 * Test whether a subsystem is enabled.
118 * @param feature subsystem/component to test
119 * @return true iff feature is enabled
121 bool isEnabled(components_t feature) {
122 return (m_features & feature)>0;
126 * Initializes library
128 * Each process using the library MUST call this function exactly once
129 * before using any library classes.
131 * @param catalog_path delimited set of schema catalog files to load
132 * @param inst_prefix installation prefix for software
133 * @return true iff initialization was successful
135 virtual bool init(const char* catalog_path=NULL, const char* inst_prefix=NULL);
140 * Each process using the library SHOULD call this function exactly once
141 * before terminating itself.
146 * Sets the global ServiceProvider instance.
147 * This method must be externally synchronized with any code that uses the object.
148 * Any previously set object is destroyed.
150 * @param serviceProvider new ServiceProvider instance to store
152 void setServiceProvider(ServiceProvider* serviceProvider);
155 * Returns the global ServiceProvider instance.
157 * @return global ServiceProvider or NULL
159 ServiceProvider* getServiceProvider() const {
160 return m_serviceProvider;
164 * Instantiates and installs a ServiceProvider instance based on an XML configuration string
165 * or a configuration pathname.
167 * @param config a snippet of XML to parse (it <strong>MUST</strong> contain a type attribute) or a pathname
168 * @param rethrow true iff caught exceptions should be rethrown instead of just returning the status
169 * @return true iff instantiation was successful
171 virtual bool instantiate(const char* config=NULL, bool rethrow=false);
175 * Sets the global ArtifactResolver instance.
177 * <p>This method must be externally synchronized with any code that uses the object.
178 * Any previously set object is destroyed.
180 * @param artifactResolver new ArtifactResolver instance to store
182 void setArtifactResolver(opensaml::MessageDecoder::ArtifactResolver* artifactResolver) {
183 delete m_artifactResolver;
184 m_artifactResolver = artifactResolver;
188 * Returns the global ArtifactResolver instance.
190 * @return global ArtifactResolver or NULL
192 const opensaml::MessageDecoder::ArtifactResolver* getArtifactResolver() const {
193 return m_artifactResolver;
197 /** Separator for serialized values of multi-valued attributes. */
198 char attribute_value_delimeter;
201 * Manages factories for AccessControl plugins.
203 xmltooling::PluginManager<AccessControl,std::string,const xercesc::DOMElement*> AccessControlManager;
207 * Manages factories for AttributeDecoder plugins.
209 xmltooling::PluginManager<AttributeDecoder,xmltooling::QName,const xercesc::DOMElement*> AttributeDecoderManager;
212 * Manages factories for AttributeExtractor plugins.
214 xmltooling::PluginManager<AttributeExtractor,std::string,const xercesc::DOMElement*> AttributeExtractorManager;
217 * Manages factories for AttributeFilter plugins.
219 xmltooling::PluginManager<AttributeFilter,std::string,const xercesc::DOMElement*> AttributeFilterManager;
222 * Manages factories for AttributeResolver plugins.
224 xmltooling::PluginManager<AttributeResolver,std::string,const xercesc::DOMElement*> AttributeResolverManager;
227 * Manages factories for MatchFunctor plugins.
229 xmltooling::PluginManager< MatchFunctor,xmltooling::QName,std::pair<const FilterPolicyContext*,const xercesc::DOMElement*> > MatchFunctorManager;
233 * Manages factories for Handler plugins that implement ArtifactResolutionService functionality.
235 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > ArtifactResolutionServiceManager;
238 * Manages factories for Handler plugins that implement AssertionConsumerService functionality.
240 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > AssertionConsumerServiceManager;
243 * Manages factories for Handler plugins that implement customized functionality.
245 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > HandlerManager;
248 * Manages factories for ListenerService plugins.
250 xmltooling::PluginManager<ListenerService,std::string,const xercesc::DOMElement*> ListenerServiceManager;
253 * Manages factories for Handler plugins that implement LogoutInitiator functionality.
255 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > LogoutInitiatorManager;
258 * Manages factories for Handler plugins that implement ManageNameIDService functionality.
260 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > ManageNameIDServiceManager;
263 * Manages factories for RequestMapper plugins.
265 xmltooling::PluginManager<RequestMapper,std::string,const xercesc::DOMElement*> RequestMapperManager;
268 * Manages factories for ServiceProvider plugins.
270 xmltooling::PluginManager<ServiceProvider,std::string,const xercesc::DOMElement*> ServiceProviderManager;
273 * Manages factories for SessionCache plugins.
275 xmltooling::PluginManager<SessionCache,std::string,const xercesc::DOMElement*> SessionCacheManager;
278 * Manages factories for Handler plugins that implement SessionInitiator functionality.
280 xmltooling::PluginManager< SessionInitiator,std::string,std::pair<const xercesc::DOMElement*,const char*> > SessionInitiatorManager;
283 * Manages factories for Handler plugins that implement SingleLogoutService functionality.
285 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > SingleLogoutServiceManager;
288 /** Global ServiceProvider instance. */
289 ServiceProvider* m_serviceProvider;
292 /** Global ArtifactResolver instance. */
293 opensaml::MessageDecoder::ArtifactResolver* m_artifactResolver;
297 unsigned long m_features;
298 xercesc::DOMDocument* m_configDoc;
301 #if defined (_MSC_VER)
302 #pragma warning( pop )
307 #endif /* __shibsp_config_h__ */