2 * Copyright 2001-2006 Internet2
\r
4 * Licensed under the Apache License, Version 2.0 (the "License");
\r
5 * you may not use this file except in compliance with the License.
\r
6 * You may obtain a copy of the License at
\r
8 * http://www.apache.org/licenses/LICENSE-2.0
\r
10 * Unless required by applicable law or agreed to in writing, software
\r
11 * distributed under the License is distributed on an "AS IS" BASIS,
\r
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
13 * See the License for the specific language governing permissions and
\r
14 * limitations under the License.
\r
18 * @file XMLToolingConfig.h
\r
20 * Library configuration
\r
23 #ifndef __xmltooling_config_h__
\r
24 #define __xmltooling_config_h__
\r
26 #include <xmltooling/Lockable.h>
\r
27 #include <xmltooling/PluginManager.h>
\r
28 #include <xmltooling/util/ParserPool.h>
\r
30 #ifndef XMLTOOLING_NO_XMLSEC
\r
31 namespace xmlsignature {
\r
32 class XMLTOOL_API CredentialResolver;
\r
33 class XMLTOOL_API KeyResolver;
\r
37 #if defined (_MSC_VER)
\r
38 #pragma warning( push )
\r
39 #pragma warning( disable : 4251 )
\r
42 namespace xmltooling {
\r
44 class XMLTOOL_API StorageService;
\r
45 class XMLTOOL_API TrustEngine;
\r
46 class XMLTOOL_API XSECCryptoX509CRL;
\r
49 * Singleton object that manages library startup/shutdown.configuration.
\r
51 * A locking interface is supplied as a convenience for code that wants to
\r
52 * obtain a global system lock, but the actual configuration itself is not
\r
55 class XMLTOOL_API XMLToolingConfig : public Lockable
\r
57 MAKE_NONCOPYABLE(XMLToolingConfig);
\r
59 XMLToolingConfig() : clock_skew_secs(180) {}
\r
61 virtual ~XMLToolingConfig() {}
\r
64 * Returns the global configuration object for the library.
\r
66 * @return reference to the global library configuration object
\r
68 static XMLToolingConfig& getConfig();
\r
71 * Initializes library
\r
73 * Each process using the library MUST call this function exactly once
\r
74 * before using any library classes except for the LogConfig method.
\r
76 * @return true iff initialization was successful
\r
78 virtual bool init()=0;
\r
81 * Shuts down library
\r
83 * Each process using the library SHOULD call this function exactly once
\r
84 * before terminating itself
\r
86 virtual void term()=0;
\r
89 * Loads a shared/dynamic library extension.
\r
91 * Extension libraries are managed using a pair of "C" linkage functions:<br>
\r
92 * extern "C" int xmltooling_extension_init(void* context);<br>
\r
93 * extern "C" void xmltooling_extension_term();
\r
95 * This method is internally synchronized.
\r
97 * @param path pathname of shared library to load into process
\r
98 * @param context arbitrary data to pass to library initialization hook
\r
99 * @return true iff library was loaded successfully
\r
101 virtual bool load_library(const char* path, void* context=NULL)=0;
\r
104 * Configure logging system.
\r
106 * May be called first, before initializing the library. Other calls to it
\r
107 * must be externally synchronized.
\r
109 * @param config either a logging configuration file, or a level from the set
\r
110 * (DEBUG, INFO, NOTICE, WARN, ERROR, CRIT, ALERT, FATAL, EMERG)
\r
111 * @return true iff configuration was successful
\r
113 virtual bool log_config(const char* config=NULL)=0;
\r
116 * Obtains a non-validating parser pool.
\r
117 * Library must be initialized first.
\r
119 * @return reference to a non-validating parser pool.
\r
121 virtual ParserPool& getParser() const=0;
\r
124 * Obtains a validating parser pool.
\r
125 * Library must be initialized first. Schema/catalog registration must be
\r
126 * externally synchronized.
\r
128 * @return reference to a validating parser pool.
\r
130 virtual ParserPool& getValidatingParser() const=0;
\r
133 * List of catalog files to load into validating parser pool at initialization time.
\r
134 * Like other path settings, the separator depends on the platform
\r
135 * (semicolon on Windows, colon otherwise).
\r
137 std::string catalog_path;
\r
140 * Adjusts any clock comparisons to be more liberal/permissive by the
\r
141 * indicated number of seconds.
\r
143 unsigned int clock_skew_secs;
\r
145 #ifndef XMLTOOLING_NO_XMLSEC
\r
147 * Returns an X.509 CRL implementation object.
\r
149 virtual XSECCryptoX509CRL* X509CRL() const=0;
\r
152 * Manages factories for KeyResolver plugins.
\r
154 PluginManager<xmlsignature::KeyResolver,const DOMElement*> KeyResolverManager;
\r
157 * Manages factories for CredentialResolver plugins.
\r
159 PluginManager<xmlsignature::CredentialResolver,const DOMElement*> CredentialResolverManager;
\r
162 * Manages factories for TrustEngine plugins.
\r
164 PluginManager<TrustEngine,const DOMElement*> TrustEngineManager;
\r
168 * Manages factories for StorageService plugins.
\r
170 PluginManager<StorageService,const DOMElement*> StorageServiceManager;
\r
175 #if defined (_MSC_VER)
\r
176 #pragma warning( pop )
\r
179 #endif /* __xmltooling_config_h__ */
\r