2 * Copyright 2001-2010 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>
30 # include <saml/binding/MessageDecoder.h>
31 # include <saml/binding/MessageEncoder.h>
33 #include <xmltooling/PluginManager.h>
34 #include <xmltooling/QName.h>
35 #include <xercesc/dom/DOM.hpp>
39 * Shibboleth Service Provider Library
43 class SHIBSP_API AccessControl;
44 class SHIBSP_API Handler;
45 class SHIBSP_API ListenerService;
46 class SHIBSP_API RequestMapper;
47 class SHIBSP_API ServiceProvider;
48 class SHIBSP_API SessionCache;
49 class SHIBSP_API SessionInitiator;
52 class SHIBSP_API AttributeDecoder;
53 class SHIBSP_API AttributeExtractor;
54 class SHIBSP_API AttributeFilter;
55 class SHIBSP_API AttributeResolver;
56 class SHIBSP_API FilterPolicyContext;
57 class SHIBSP_API MatchFunctor;
58 class SHIBSP_API SecurityPolicyProvider;
61 #if defined (_MSC_VER)
62 #pragma warning( push )
63 #pragma warning( disable : 4250 4251 )
67 * Singleton object that manages library startup/shutdown.
69 class SHIBSP_API SPConfig
71 MAKE_NONCOPYABLE(SPConfig);
78 * Returns the global configuration object for the library.
80 * @return reference to the global library configuration object
82 static SPConfig& getConfig();
85 * Bitmask values representing subsystems of the library.
94 AttributeResolution = 32,
104 * Set a bitmask of subsystems to activate.
106 * @param enabled bitmask of component constants
108 void setFeatures(unsigned long enabled);
111 * Test whether a subsystem is enabled.
113 * @param feature subsystem/component to test
114 * @return true iff feature is enabled
116 bool isEnabled(components_t feature);
119 * Initializes library
121 * Each process using the library MUST call this function exactly once
122 * before using any library classes.
124 * @param catalog_path delimited set of schema catalog files to load
125 * @param inst_prefix installation prefix for software
126 * @return true iff initialization was successful
128 virtual bool init(const char* catalog_path=nullptr, const char* inst_prefix=nullptr);
133 * Each process using the library SHOULD call this function exactly once
134 * before terminating itself.
139 * Sets the global ServiceProvider instance.
140 * This method must be externally synchronized with any code that uses the object.
141 * Any previously set object is destroyed.
143 * @param serviceProvider new ServiceProvider instance to store
145 void setServiceProvider(ServiceProvider* serviceProvider);
148 * Returns the global ServiceProvider instance.
150 * @return global ServiceProvider or nullptr
152 ServiceProvider* getServiceProvider() const;
155 * Instantiates and installs a ServiceProvider instance based on an XML configuration string
156 * or a configuration pathname.
158 * @param config a snippet of XML to parse (it <strong>MUST</strong> contain a type attribute) or a pathname
159 * @param rethrow true iff caught exceptions should be rethrown instead of just returning the status
160 * @return true iff instantiation was successful
162 virtual bool instantiate(const char* config=nullptr, bool rethrow=false);
166 * Sets the global ArtifactResolver instance.
168 * <p>This method must be externally synchronized with any code that uses the object.
169 * Any previously set object is destroyed.
171 * @param artifactResolver new ArtifactResolver instance to store
173 void setArtifactResolver(opensaml::MessageDecoder::ArtifactResolver* artifactResolver);
176 * Returns the global ArtifactResolver instance.
178 * @return global ArtifactResolver or nullptr
180 const opensaml::MessageDecoder::ArtifactResolver* getArtifactResolver() const;
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;
218 * Manages factories for SecurityPolicyProvider plugins.
220 xmltooling::PluginManager<SecurityPolicyProvider,std::string,const xercesc::DOMElement*> SecurityPolicyProviderManager;
224 * Manages factories for Handler plugins that implement ArtifactResolutionService functionality.
226 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > ArtifactResolutionServiceManager;
229 * Manages factories for Handler plugins that implement AssertionConsumerService functionality.
231 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > AssertionConsumerServiceManager;
234 * Manages factories for Handler plugins that implement customized functionality.
236 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > HandlerManager;
239 * Manages factories for ListenerService plugins.
241 xmltooling::PluginManager<ListenerService,std::string,const xercesc::DOMElement*> ListenerServiceManager;
244 * Manages factories for Handler plugins that implement LogoutInitiator functionality.
246 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > LogoutInitiatorManager;
249 * Manages factories for Handler plugins that implement ManageNameIDService functionality.
251 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > ManageNameIDServiceManager;
254 * Manages factories for RequestMapper plugins.
256 xmltooling::PluginManager<RequestMapper,std::string,const xercesc::DOMElement*> RequestMapperManager;
259 * Manages factories for ServiceProvider plugins.
261 xmltooling::PluginManager<ServiceProvider,std::string,const xercesc::DOMElement*> ServiceProviderManager;
264 * Manages factories for SessionCache plugins.
266 xmltooling::PluginManager<SessionCache,std::string,const xercesc::DOMElement*> SessionCacheManager;
269 * Manages factories for Handler plugins that implement SessionInitiator functionality.
271 xmltooling::PluginManager< SessionInitiator,std::string,std::pair<const xercesc::DOMElement*,const char*> > SessionInitiatorManager;
274 * Manages factories for Handler plugins that implement SingleLogoutService functionality.
276 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > SingleLogoutServiceManager;
279 /** Global ServiceProvider instance. */
280 ServiceProvider* m_serviceProvider;
283 /** Global ArtifactResolver instance. */
284 opensaml::MessageDecoder::ArtifactResolver* m_artifactResolver;
288 unsigned long m_features;
289 xercesc::DOMDocument* m_configDoc;
292 #if defined (_MSC_VER)
293 #pragma warning( pop )
298 #endif /* __shibsp_config_h__ */