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>
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),
72 m_features(0), m_configDoc(NULL) {
75 virtual ~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) {
109 m_features = enabled;
113 * Test whether a subsystem is enabled.
115 * @param feature subsystem/component to test
116 * @return true iff feature is enabled
118 bool isEnabled(components_t feature) {
119 return (m_features & feature)>0;
123 * Initializes library
125 * Each process using the library MUST call this function exactly once
126 * before using any library classes.
128 * @param catalog_path delimited set of schema catalog files to load
129 * @param inst_prefix installation prefix for software
130 * @return true iff initialization was successful
132 virtual bool init(const char* catalog_path=NULL, const char* inst_prefix=NULL);
137 * Each process using the library SHOULD call this function exactly once
138 * before terminating itself.
143 * Sets the global ServiceProvider instance.
144 * This method must be externally synchronized with any code that uses the object.
145 * Any previously set object is destroyed.
147 * @param serviceProvider new ServiceProvider instance to store
149 void setServiceProvider(ServiceProvider* serviceProvider);
152 * Returns the global ServiceProvider instance.
154 * @return global ServiceProvider or NULL
156 ServiceProvider* getServiceProvider() const {
157 return m_serviceProvider;
161 * Instantiates and installs a ServiceProvider instance based on an XML configuration string
162 * or a configuration pathname.
164 * @param config a snippet of XML to parse (it <strong>MUST</strong> contain a type attribute) or a pathname
165 * @param rethrow true iff caught exceptions should be rethrown instead of just returning the status
166 * @return true iff instantiation was successful
168 virtual bool instantiate(const char* config=NULL, bool rethrow=false);
172 * Sets the global ArtifactResolver instance.
174 * <p>This method must be externally synchronized with any code that uses the object.
175 * Any previously set object is destroyed.
177 * @param artifactResolver new ArtifactResolver instance to store
179 void setArtifactResolver(opensaml::MessageDecoder::ArtifactResolver* artifactResolver) {
180 delete m_artifactResolver;
181 m_artifactResolver = artifactResolver;
185 * Returns the global ArtifactResolver instance.
187 * @return global ArtifactResolver or NULL
189 const opensaml::MessageDecoder::ArtifactResolver* getArtifactResolver() const {
190 return m_artifactResolver;
194 /** Separator for serialized values of multi-valued attributes. */
195 char attribute_value_delimeter;
198 * Manages factories for AccessControl plugins.
200 xmltooling::PluginManager<AccessControl,std::string,const xercesc::DOMElement*> AccessControlManager;
204 * Manages factories for AttributeDecoder plugins.
206 xmltooling::PluginManager<AttributeDecoder,xmltooling::QName,const xercesc::DOMElement*> AttributeDecoderManager;
209 * Manages factories for AttributeExtractor plugins.
211 xmltooling::PluginManager<AttributeExtractor,std::string,const xercesc::DOMElement*> AttributeExtractorManager;
214 * Manages factories for AttributeFilter plugins.
216 xmltooling::PluginManager<AttributeFilter,std::string,const xercesc::DOMElement*> AttributeFilterManager;
219 * Manages factories for AttributeResolver plugins.
221 xmltooling::PluginManager<AttributeResolver,std::string,const xercesc::DOMElement*> AttributeResolverManager;
224 * Manages factories for MatchFunctor plugins.
226 xmltooling::PluginManager< MatchFunctor,xmltooling::QName,std::pair<const FilterPolicyContext*,const xercesc::DOMElement*> > MatchFunctorManager;
230 * Manages factories for Handler plugins that implement ArtifactResolutionService functionality.
232 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > ArtifactResolutionServiceManager;
235 * Manages factories for Handler plugins that implement AssertionConsumerService functionality.
237 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > AssertionConsumerServiceManager;
240 * Manages factories for Handler plugins that implement customized functionality.
242 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > HandlerManager;
245 * Manages factories for ListenerService plugins.
247 xmltooling::PluginManager<ListenerService,std::string,const xercesc::DOMElement*> ListenerServiceManager;
250 * Manages factories for Handler plugins that implement LogoutInitiator functionality.
252 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > LogoutInitiatorManager;
255 * Manages factories for Handler plugins that implement ManageNameIDService functionality.
257 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > ManageNameIDServiceManager;
260 * Manages factories for RequestMapper plugins.
262 xmltooling::PluginManager<RequestMapper,std::string,const xercesc::DOMElement*> RequestMapperManager;
265 * Manages factories for ServiceProvider plugins.
267 xmltooling::PluginManager<ServiceProvider,std::string,const xercesc::DOMElement*> ServiceProviderManager;
270 * Manages factories for SessionCache plugins.
272 xmltooling::PluginManager<SessionCache,std::string,const xercesc::DOMElement*> SessionCacheManager;
275 * Manages factories for Handler plugins that implement SessionInitiator functionality.
277 xmltooling::PluginManager< SessionInitiator,std::string,std::pair<const xercesc::DOMElement*,const char*> > SessionInitiatorManager;
280 * Manages factories for Handler plugins that implement SingleLogoutService functionality.
282 xmltooling::PluginManager< Handler,std::string,std::pair<const xercesc::DOMElement*,const char*> > SingleLogoutServiceManager;
285 /** Global ServiceProvider instance. */
286 ServiceProvider* m_serviceProvider;
289 /** Global ArtifactResolver instance. */
290 opensaml::MessageDecoder::ArtifactResolver* m_artifactResolver;
294 unsigned long m_features;
295 xercesc::DOMDocument* m_configDoc;
298 #if defined (_MSC_VER)
299 #pragma warning( pop )
304 #endif /* __shibsp_config_h__ */