Convert from NULL macro to nullptr.
[shibboleth/cpp-xmltooling.git] / xmltooling / XMLToolingConfig.h
index 1cbb650..2bdc59b 100644 (file)
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2001-2007 Internet2
+ *  Copyright 2001-2010 Internet2
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,7 @@
 /**
  * @file xmltooling/XMLToolingConfig.h
  * 
- * Library configuration 
+ * Library configuration.
  */
 
 #ifndef __xmltooling_config_h__
 
 #include <xmltooling/Lockable.h>
 #include <xmltooling/PluginManager.h>
-#include <xmltooling/util/ParserPool.h>
+#include <xmltooling/soap/SOAPTransport.h>
 
-#ifndef XMLTOOLING_NO_XMLSEC
-namespace xmltooling {
-    class XMLTOOL_API CredentialResolver;
-    class XMLTOOL_API KeyInfoResolver;
-    class XMLTOOL_API TrustEngine;
-    class XMLTOOL_API XSECCryptoX509CRL;
-};
-#endif
+#include <string>
+#include <xercesc/dom/DOM.hpp>
 
 #if defined (_MSC_VER)
     #pragma warning( push )
@@ -43,11 +37,20 @@ namespace xmltooling {
 
 namespace xmltooling {
     
-    class XMLTOOL_API ReplayCache;
-    class XMLTOOL_API SOAPTransport;
-    class XMLTOOL_API StorageService;
+    class XMLTOOL_API ParserPool;
+    class XMLTOOL_API PathResolver;
     class XMLTOOL_API TemplateEngine;
     class XMLTOOL_API URLEncoder;
+#ifndef XMLTOOLING_LITE
+    class XMLTOOL_API ReplayCache;
+    class XMLTOOL_API StorageService;
+#endif
+#ifndef XMLTOOLING_NO_XMLSEC
+    class XMLTOOL_API CredentialResolver;
+    class XMLTOOL_API KeyInfoResolver;
+    class XMLTOOL_API TrustEngine;
+    class XMLTOOL_API XSECCryptoX509CRL;
+#endif
 
     /**
      * Singleton object that manages library startup/shutdown.configuration.
@@ -56,21 +59,22 @@ namespace xmltooling {
      * obtain a global system lock, but the actual configuration itself is not
      * synchronized.
      */
-    class XMLTOOL_API XMLToolingConfig : public Lockable
+    class XMLTOOL_API XMLToolingConfig : public virtual Lockable
     {
         MAKE_NONCOPYABLE(XMLToolingConfig);
     protected:
-#ifndef XMLTOOLING_NO_XMLSEC
-        XMLToolingConfig() : m_keyInfoResolver(NULL), m_replayCache(NULL), m_templateEngine(NULL), m_urlEncoder(NULL), clock_skew_secs(180) {}
+        XMLToolingConfig();
 
+#ifndef XMLTOOLING_NO_XMLSEC
         /** Global KeyInfoResolver instance. */
         KeyInfoResolver* m_keyInfoResolver;
-#else
-        XMLToolingConfig() : m_replayCache(NULL), m_templateEngine(NULL), m_urlEncoder(NULL), clock_skew_secs(180) {}
-#endif
 
         /** Global ReplayCache instance. */
         ReplayCache* m_replayCache;
+#endif
+
+        /** Global PathResolver instance. */
+        PathResolver* m_pathResolver;
         
         /** Global TemplateEngine instance. */
         TemplateEngine* m_templateEngine;
@@ -79,7 +83,7 @@ namespace xmltooling {
         URLEncoder* m_urlEncoder;
 
     public:
-        virtual ~XMLToolingConfig() {}
+        virtual ~XMLToolingConfig();
 
         /**
          * Returns the global configuration object for the library.
@@ -119,7 +123,7 @@ namespace xmltooling {
          * @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;
+        virtual bool load_library(const char* path, void* context=nullptr)=0;
         
         /**
          * Configure logging system.
@@ -131,7 +135,7 @@ namespace xmltooling {
          *                  (DEBUG, INFO, NOTICE, WARN, ERROR, CRIT, ALERT, FATAL, EMERG)
          * @return true iff configuration was successful
          */
-        virtual bool log_config(const char* config=NULL)=0;
+        virtual bool log_config(const char* config=nullptr)=0;
 
         /**
          * Obtains a non-validating parser pool.
@@ -152,6 +156,20 @@ namespace xmltooling {
 
 #ifndef XMLTOOLING_NO_XMLSEC
         /**
+         * Returns the global KeyInfoResolver instance.
+         * 
+         * @return  global KeyInfoResolver or nullptr
+         */
+        const KeyInfoResolver* getKeyInfoResolver() const;
+
+        /**
+         * Returns the global ReplayCache instance.
+         * 
+         * @return  global ReplayCache or nullptr
+         */
+        ReplayCache* getReplayCache() const;
+
+        /**
          * Sets the global KeyInfoResolver instance.
          * This method must be externally synchronized with any code that uses the object.
          * Any previously set object is destroyed.
@@ -161,16 +179,6 @@ namespace xmltooling {
         void setKeyInfoResolver(KeyInfoResolver* keyInfoResolver);
 
         /**
-         * Returns the global KeyInfoResolver instance.
-         * 
-         * @return  global KeyInfoResolver or NULL
-         */
-        const KeyInfoResolver* getKeyInfoResolver() const {
-            return m_keyInfoResolver;
-        }
-#endif
-
-        /**
          * Sets the global ReplayCache instance.
          * This method must be externally synchronized with any code that uses the object.
          * Any previously set object is destroyed.
@@ -178,33 +186,37 @@ namespace xmltooling {
          * @param replayCache   new ReplayCache instance to store
          */
         void setReplayCache(ReplayCache* replayCache);
+#endif
 
         /**
-         * Returns the global ReplayCache instance.
+         * Returns the global PathResolver instance.
          * 
-         * @return  global ReplayCache or NULL
+         * @return  global PathResolver or nullptr
          */
-        ReplayCache* getReplayCache() const {
-            return m_replayCache;
-        }
-
+        PathResolver* getPathResolver() const;
+        
         /**
-         * Sets the global URLEncoder instance.
-         * This method must be externally synchronized with any code that uses the object.
-         * Any previously set object is destroyed.
+         * Returns the global TemplateEngine instance.
          * 
-         * @param urlEncoder   new URLEncoder instance to store
+         * @return  global TemplateEngine or nullptr
          */
-        void setURLEncoder(URLEncoder* urlEncoder);
-        
+        TemplateEngine* getTemplateEngine() const;
+
         /**
          * Returns the global URLEncoder instance.
          * 
-         * @return  global URLEncoder or NULL
+         * @return  global URLEncoder or nullptr
          */
-        const URLEncoder* getURLEncoder() const {
-            return m_urlEncoder;
-        }
+        const URLEncoder* getURLEncoder() const;
+
+        /**
+         * Sets the global PathResolver instance.
+         * This method must be externally synchronized with any code that uses the object.
+         * Any previously set object is destroyed.
+         * 
+         * @param pathResolver   new PathResolver instance to store
+         */
+        void setPathResolver(PathResolver* pathResolver);
         
         /**
          * Sets the global TemplateEngine instance.
@@ -216,14 +228,14 @@ namespace xmltooling {
         void setTemplateEngine(TemplateEngine* templateEngine);
 
         /**
-         * Returns the global TemplateEngine instance.
+         * Sets the global URLEncoder instance.
+         * This method must be externally synchronized with any code that uses the object.
+         * Any previously set object is destroyed.
          * 
-         * @return  global TemplateEngine or NULL
+         * @param urlEncoder   new URLEncoder instance to store
          */
-        TemplateEngine* getTemplateEngine() const {
-            return m_templateEngine;
-        }
-                
+        void setURLEncoder(URLEncoder* urlEncoder);
+        
         /**
          * List of catalog files to load into validating parser pool at initialization time.
          * Like other path settings, the separator depends on the platform
@@ -259,6 +271,11 @@ namespace xmltooling {
         PluginManager<TrustEngine,std::string,const xercesc::DOMElement*> TrustEngineManager;
 
         /**
+         * Manages factories for StorageService plugins.
+         */
+        PluginManager<StorageService,std::string,const xercesc::DOMElement*> StorageServiceManager;
+
+        /**
          * Maps an XML Signature/Encryption algorithm identifier to a library-specific
          * key algorithm and size for use in resolving credentials.
          *
@@ -283,12 +300,7 @@ namespace xmltooling {
          * 
          * <p>The factory interface takes a peer name/endpoint pair.
          */
-        PluginManager<SOAPTransport,std::string,std::pair<const char*,const char*> > SOAPTransportManager;
-
-        /**
-         * Manages factories for StorageService plugins.
-         */
-        PluginManager<StorageService,std::string,const xercesc::DOMElement*> StorageServiceManager;
+        PluginManager<SOAPTransport,std::string,SOAPTransport::Address> SOAPTransportManager;
     };
 
 };