-/*\r
- * Copyright 2001-2006 Internet2\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- * http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * @file XMLToolingConfig.h\r
- * \r
- * Library configuration \r
- */\r
-\r
-#ifndef __xmltooling_config_h__\r
-#define __xmltooling_config_h__\r
-\r
-#include <xmltooling/Lockable.h>\r
-#include <xmltooling/PluginManager.h>\r
-#include <xmltooling/util/ParserPool.h>\r
-\r
-#ifndef XMLTOOLING_NO_XMLSEC\r
-namespace xmlsignature {\r
- class XMLTOOL_API CredentialResolver;\r
- class XMLTOOL_API KeyResolver;\r
-};\r
-#endif\r
-\r
-#if defined (_MSC_VER)\r
- #pragma warning( push )\r
- #pragma warning( disable : 4251 )\r
-#endif\r
-\r
-namespace xmltooling {\r
- \r
- class XMLTOOL_API ReplayCache;\r
- class XMLTOOL_API StorageService;\r
- class XMLTOOL_API TrustEngine;\r
- class XMLTOOL_API XSECCryptoX509CRL;\r
-\r
- /**\r
- * Singleton object that manages library startup/shutdown.configuration.\r
- * \r
- * A locking interface is supplied as a convenience for code that wants to\r
- * obtain a global system lock, but the actual configuration itself is not\r
- * synchronized.\r
- */\r
- class XMLTOOL_API XMLToolingConfig : public Lockable\r
- {\r
- MAKE_NONCOPYABLE(XMLToolingConfig);\r
- protected:\r
- XMLToolingConfig() : m_replayCache(NULL), clock_skew_secs(180) {}\r
- \r
- /** Global ReplayCache instance. */\r
- ReplayCache* m_replayCache;\r
- public:\r
- virtual ~XMLToolingConfig() {}\r
-\r
- /**\r
- * Returns the global configuration object for the library.\r
- * \r
- * @return reference to the global library configuration object\r
- */\r
- static XMLToolingConfig& getConfig();\r
- \r
- /**\r
- * Initializes library\r
- * \r
- * Each process using the library MUST call this function exactly once\r
- * before using any library classes except for the LogConfig method.\r
- * \r
- * @return true iff initialization was successful \r
- */\r
- virtual bool init()=0;\r
- \r
- /**\r
- * Shuts down library\r
- * \r
- * Each process using the library SHOULD call this function exactly once\r
- * before terminating itself\r
- */\r
- virtual void term()=0;\r
-\r
- /**\r
- * Loads a shared/dynamic library extension.\r
- * \r
- * Extension libraries are managed using a pair of "C" linkage functions:<br>\r
- * extern "C" int xmltooling_extension_init(void* context);<br>\r
- * extern "C" void xmltooling_extension_term();\r
- * \r
- * This method is internally synchronized.\r
- * \r
- * @param path pathname of shared library to load into process\r
- * @param context arbitrary data to pass to library initialization hook\r
- * @return true iff library was loaded successfully\r
- */\r
- virtual bool load_library(const char* path, void* context=NULL)=0;\r
- \r
- /**\r
- * Configure logging system.\r
- * \r
- * May be called first, before initializing the library. Other calls to it\r
- * must be externally synchronized. \r
- * \r
- * @param config either a logging configuration file, or a level from the set\r
- * (DEBUG, INFO, NOTICE, WARN, ERROR, CRIT, ALERT, FATAL, EMERG)\r
- * @return true iff configuration was successful\r
- */\r
- virtual bool log_config(const char* config=NULL)=0;\r
-\r
- /**\r
- * Obtains a non-validating parser pool.\r
- * Library must be initialized first.\r
- *\r
- * @return reference to a non-validating parser pool.\r
- */\r
- virtual ParserPool& getParser() const=0;\r
-\r
- /**\r
- * Obtains a validating parser pool.\r
- * Library must be initialized first. Schema/catalog registration must be\r
- * externally synchronized.\r
- *\r
- * @return reference to a validating parser pool.\r
- */\r
- virtual ParserPool& getValidatingParser() const=0;\r
-\r
- /**\r
- * Sets the global ReplayCache instance.\r
- * This method must be externally synchronized with any code that uses the object.\r
- * Any previously set object is destroyed.\r
- * \r
- * @param replayCache new ReplayCache instance to store\r
- */\r
- void setReplayCache(ReplayCache* replayCache);\r
-\r
- /**\r
- * Returns the global ReplayCache instance.\r
- * \r
- * @return global ReplayCache or NULL\r
- */\r
- ReplayCache* getReplayCache() const {\r
- return m_replayCache;\r
- }\r
- \r
- /**\r
- * List of catalog files to load into validating parser pool at initialization time.\r
- * Like other path settings, the separator depends on the platform\r
- * (semicolon on Windows, colon otherwise). \r
- */\r
- std::string catalog_path;\r
- \r
- /**\r
- * Adjusts any clock comparisons to be more liberal/permissive by the\r
- * indicated number of seconds.\r
- */\r
- unsigned int clock_skew_secs;\r
-\r
-#ifndef XMLTOOLING_NO_XMLSEC\r
- /**\r
- * Returns an X.509 CRL implementation object.\r
- */\r
- virtual XSECCryptoX509CRL* X509CRL() const=0;\r
-\r
- /**\r
- * Manages factories for KeyResolver plugins.\r
- */\r
- PluginManager<xmlsignature::KeyResolver,const DOMElement*> KeyResolverManager;\r
-\r
- /**\r
- * Manages factories for CredentialResolver plugins.\r
- */\r
- PluginManager<xmlsignature::CredentialResolver,const DOMElement*> CredentialResolverManager;\r
-\r
- /**\r
- * Manages factories for TrustEngine plugins.\r
- */\r
- PluginManager<TrustEngine,const DOMElement*> TrustEngineManager;\r
-#endif\r
-\r
- /**\r
- * Manages factories for StorageService plugins.\r
- */\r
- PluginManager<StorageService,const DOMElement*> StorageServiceManager;\r
- };\r
-\r
-};\r
-\r
-#if defined (_MSC_VER)\r
- #pragma warning( pop )\r
-#endif\r
-\r
-#endif /* __xmltooling_config_h__ */\r
+/*
+ * Copyright 2001-2006 Internet2
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @file XMLToolingConfig.h
+ *
+ * Library configuration
+ */
+
+#ifndef __xmltooling_config_h__
+#define __xmltooling_config_h__
+
+#include <xmltooling/Lockable.h>
+#include <xmltooling/PluginManager.h>
+#include <xmltooling/util/ParserPool.h>
+
+#ifndef XMLTOOLING_NO_XMLSEC
+namespace xmlsignature {
+ class XMLTOOL_API CredentialResolver;
+ class XMLTOOL_API KeyResolver;
+};
+#endif
+
+#if defined (_MSC_VER)
+ #pragma warning( push )
+ #pragma warning( disable : 4251 )
+#endif
+
+namespace xmltooling {
+
+ class XMLTOOL_API ReplayCache;
+ class XMLTOOL_API StorageService;
+ class XMLTOOL_API TrustEngine;
+ class XMLTOOL_API XSECCryptoX509CRL;
+
+ /**
+ * Singleton object that manages library startup/shutdown.configuration.
+ *
+ * A locking interface is supplied as a convenience for code that wants to
+ * obtain a global system lock, but the actual configuration itself is not
+ * synchronized.
+ */
+ class XMLTOOL_API XMLToolingConfig : public Lockable
+ {
+ MAKE_NONCOPYABLE(XMLToolingConfig);
+ protected:
+ XMLToolingConfig() : m_replayCache(NULL), clock_skew_secs(180) {}
+
+ /** Global ReplayCache instance. */
+ ReplayCache* m_replayCache;
+ public:
+ virtual ~XMLToolingConfig() {}
+
+ /**
+ * Returns the global configuration object for the library.
+ *
+ * @return reference to the global library configuration object
+ */
+ static XMLToolingConfig& getConfig();
+
+ /**
+ * Initializes library
+ *
+ * Each process using the library MUST call this function exactly once
+ * before using any library classes except for the LogConfig method.
+ *
+ * @return true iff initialization was successful
+ */
+ virtual bool init()=0;
+
+ /**
+ * Shuts down library
+ *
+ * Each process using the library SHOULD call this function exactly once
+ * before terminating itself
+ */
+ virtual void term()=0;
+
+ /**
+ * Loads a shared/dynamic library extension.
+ *
+ * Extension libraries are managed using a pair of "C" linkage functions:<br>
+ * extern "C" int xmltooling_extension_init(void* context);<br>
+ * extern "C" void xmltooling_extension_term();
+ *
+ * This method is internally synchronized.
+ *
+ * @param path pathname of shared library to load into process
+ * @param context arbitrary data to pass to library initialization hook
+ * @return true iff library was loaded successfully
+ */
+ virtual bool load_library(const char* path, void* context=NULL)=0;
+
+ /**
+ * Configure logging system.
+ *
+ * May be called first, before initializing the library. Other calls to it
+ * must be externally synchronized.
+ *
+ * @param config either a logging configuration file, or a level from the set
+ * (DEBUG, INFO, NOTICE, WARN, ERROR, CRIT, ALERT, FATAL, EMERG)
+ * @return true iff configuration was successful
+ */
+ virtual bool log_config(const char* config=NULL)=0;
+
+ /**
+ * Obtains a non-validating parser pool.
+ * Library must be initialized first.
+ *
+ * @return reference to a non-validating parser pool.
+ */
+ virtual ParserPool& getParser() const=0;
+
+ /**
+ * Obtains a validating parser pool.
+ * Library must be initialized first. Schema/catalog registration must be
+ * externally synchronized.
+ *
+ * @return reference to a validating parser pool.
+ */
+ virtual ParserPool& getValidatingParser() const=0;
+
+ /**
+ * Sets the global ReplayCache instance.
+ * This method must be externally synchronized with any code that uses the object.
+ * Any previously set object is destroyed.
+ *
+ * @param replayCache new ReplayCache instance to store
+ */
+ void setReplayCache(ReplayCache* replayCache);
+
+ /**
+ * Returns the global ReplayCache instance.
+ *
+ * @return global ReplayCache or NULL
+ */
+ ReplayCache* getReplayCache() const {
+ return m_replayCache;
+ }
+
+ /**
+ * List of catalog files to load into validating parser pool at initialization time.
+ * Like other path settings, the separator depends on the platform
+ * (semicolon on Windows, colon otherwise).
+ */
+ std::string catalog_path;
+
+ /**
+ * Adjusts any clock comparisons to be more liberal/permissive by the
+ * indicated number of seconds.
+ */
+ unsigned int clock_skew_secs;
+
+#ifndef XMLTOOLING_NO_XMLSEC
+ /**
+ * Returns an X.509 CRL implementation object.
+ */
+ virtual XSECCryptoX509CRL* X509CRL() const=0;
+
+ /**
+ * Manages factories for KeyResolver plugins.
+ */
+ PluginManager<xmlsignature::KeyResolver,const DOMElement*> KeyResolverManager;
+
+ /**
+ * Manages factories for CredentialResolver plugins.
+ */
+ PluginManager<xmlsignature::CredentialResolver,const DOMElement*> CredentialResolverManager;
+
+ /**
+ * Manages factories for TrustEngine plugins.
+ */
+ PluginManager<TrustEngine,const DOMElement*> TrustEngineManager;
+#endif
+
+ /**
+ * Manages factories for StorageService plugins.
+ */
+ PluginManager<StorageService,const DOMElement*> StorageServiceManager;
+ };
+
+};
+
+#if defined (_MSC_VER)
+ #pragma warning( pop )
+#endif
+
+#endif /* __xmltooling_config_h__ */
projects / shibboleth / cpp-xmltooling.git / blobdiff