Path resolver class for supporting installation-independent relative paths.

[shibboleth/cpp-xmltooling.git] / xmltooling / XMLToolingConfig.h

diff --git a/xmltooling/XMLToolingConfig.h b/xmltooling/XMLToolingConfig.h
index 7a333d6..0f8ae43 100644 (file)
--- a/xmltooling/XMLToolingConfig.h
+++ b/xmltooling/XMLToolingConfig.h
@@ -15,7 +15,7 @@
  */
 
 /**
- * @file XMLToolingConfig.h
+ * @file xmltooling/XMLToolingConfig.h
  * 
  * Library configuration 
  */
@@ -25,13 +25,13 @@
 
 #include <xmltooling/Lockable.h>
 #include <xmltooling/PluginManager.h>
+#include <xmltooling/soap/SOAPTransport.h>
 #include <xmltooling/util/ParserPool.h>
 
 #ifndef XMLTOOLING_NO_XMLSEC
 namespace xmltooling {
     class XMLTOOL_API CredentialResolver;
-    class XMLTOOL_API KeyInfoSource;
-    class XMLTOOL_API KeyResolver;
+    class XMLTOOL_API KeyInfoResolver;
     class XMLTOOL_API TrustEngine;
     class XMLTOOL_API XSECCryptoX509CRL;
 };
@@ -44,10 +44,13 @@ namespace xmltooling {
 
 namespace xmltooling {
     
+    class XMLTOOL_API PathResolver;
+    class XMLTOOL_API TemplateEngine;
+    class XMLTOOL_API URLEncoder;
+#ifndef XMLTOOLING_LITE
     class XMLTOOL_API ReplayCache;
-    class XMLTOOL_API SOAPTransport;
     class XMLTOOL_API StorageService;
-    class XMLTOOL_API TemplateEngine;
+#endif
 
     /**
      * Singleton object that manages library startup/shutdown.configuration.
@@ -60,13 +63,28 @@ namespace xmltooling {
     {
         MAKE_NONCOPYABLE(XMLToolingConfig);
     protected:
-        XMLToolingConfig() : m_replayCache(NULL), m_templateEngine(NULL), clock_skew_secs(180) {}
-        
+#ifndef XMLTOOLING_NO_XMLSEC
+        XMLToolingConfig() : m_keyInfoResolver(NULL), m_replayCache(NULL),
+            m_pathResolver(NULL), m_templateEngine(NULL), m_urlEncoder(NULL), clock_skew_secs(180) {}
+
+        /** Global KeyInfoResolver instance. */
+        KeyInfoResolver* m_keyInfoResolver;
+
         /** Global ReplayCache instance. */
         ReplayCache* m_replayCache;
+#else
+        XMLToolingConfig() : m_pathResolver(NULL), m_templateEngine(NULL), m_urlEncoder(NULL), clock_skew_secs(180) {}
+#endif
+
+        /** Global PathResolver instance. */
+        PathResolver* m_pathResolver;
         
         /** Global TemplateEngine instance. */
         TemplateEngine* m_templateEngine;
+
+        /** Global URLEncoder instance for use by URL-related functions. */
+        URLEncoder* m_urlEncoder;
+
     public:
         virtual ~XMLToolingConfig() {}
 
@@ -139,6 +157,25 @@ namespace xmltooling {
          */
         virtual ParserPool& getValidatingParser() const=0;
 
+#ifndef XMLTOOLING_NO_XMLSEC
+        /**
+         * Sets the global KeyInfoResolver instance.
+         * This method must be externally synchronized with any code that uses the object.
+         * Any previously set object is destroyed.
+         * 
+         * @param keyInfoResolver   new KeyInfoResolver instance to store
+         */
+        void setKeyInfoResolver(KeyInfoResolver* keyInfoResolver);
+
+        /**
+         * Returns the global KeyInfoResolver instance.
+         * 
+         * @return  global KeyInfoResolver or NULL
+         */
+        const KeyInfoResolver* getKeyInfoResolver() const {
+            return m_keyInfoResolver;
+        }
+
         /**
          * Sets the global ReplayCache instance.
          * This method must be externally synchronized with any code that uses the object.
@@ -156,8 +193,27 @@ namespace xmltooling {
         ReplayCache* getReplayCache() const {
             return m_replayCache;
         }
+#endif
 
         /**
+         * Sets the global URLEncoder instance.
+         * This method must be externally synchronized with any code that uses the object.
+         * Any previously set object is destroyed.
+         * 
+         * @param urlEncoder   new URLEncoder instance to store
+         */
+        void setURLEncoder(URLEncoder* urlEncoder);
+        
+        /**
+         * Returns the global URLEncoder instance.
+         * 
+         * @return  global URLEncoder or NULL
+         */
+        const URLEncoder* getURLEncoder() const {
+            return m_urlEncoder;
+        }
+        
+        /**
          * Sets the global TemplateEngine instance.
          * This method must be externally synchronized with any code that uses the object.
          * Any previously set object is destroyed.
@@ -174,7 +230,25 @@ namespace xmltooling {
         TemplateEngine* getTemplateEngine() const {
             return m_templateEngine;
         }
-                
+
+        /**
+         * 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);
+
+        /**
+         * Returns the global PathResolver instance.
+         * 
+         * @return  global PathResolver or NULL
+         */
+        PathResolver* getPathResolver() const {
+            return m_pathResolver;
+        }
+        
         /**
          * List of catalog files to load into validating parser pool at initialization time.
          * Like other path settings, the separator depends on the platform
@@ -195,30 +269,51 @@ namespace xmltooling {
         virtual XSECCryptoX509CRL* X509CRL() const=0;
 
         /**
-         * Manages factories for KeyResolver plugins.
+         * Manages factories for KeyInfoResolver plugins.
          */
-        PluginManager<KeyResolver,const DOMElement*> KeyResolverManager;
+        PluginManager<KeyInfoResolver,std::string,const xercesc::DOMElement*> KeyInfoResolverManager;
 
         /**
          * Manages factories for CredentialResolver plugins.
          */
-        PluginManager<CredentialResolver,const DOMElement*> CredentialResolverManager;
+        PluginManager<CredentialResolver,std::string,const xercesc::DOMElement*> CredentialResolverManager;
 
         /**
          * Manages factories for TrustEngine plugins.
          */
-        PluginManager<TrustEngine,const DOMElement*> TrustEngineManager;
-#endif
+        PluginManager<TrustEngine,std::string,const xercesc::DOMElement*> TrustEngineManager;
 
         /**
-         * Manages factories for SOAPTransport plugins.
+         * Manages factories for StorageService plugins.
          */
-        PluginManager<SOAPTransport,std::pair<const KeyInfoSource*,const char*> > SOAPTransportManager;
+        PluginManager<StorageService,std::string,const xercesc::DOMElement*> StorageServiceManager;
 
         /**
-         * Manages factories for StorageService plugins.
+         * Maps an XML Signature/Encryption algorithm identifier to a library-specific
+         * key algorithm and size for use in resolving credentials.
+         *
+         * @param xmlAlgorithm  XML Signature/Encryption algorithm identifier
+         * @return  a general key algorithm and key size (or 0 if the size is irrelevant)
+         */
+        virtual std::pair<const char*,unsigned int> mapXMLAlgorithmToKeyAlgorithm(const XMLCh* xmlAlgorithm) const=0;
+
+        /**
+         * Registers an XML Signature/Encryption algorithm identifier against a library-specific
+         * key algorithm and size for use in resolving credentials.
+         *
+         * @param xmlAlgorithm  XML Signature/Encryption algorithm identifier
+         * @param keyAlgorithm  a key algorithm
+         * @param size          a key size (or 0 if the size is irrelevant)
+         */
+        virtual void registerXMLAlgorithm(const XMLCh* xmlAlgorithm, const char* keyAlgorithm, unsigned int size=0)=0;
+#endif
+
+        /**
+         * Manages factories for SOAPTransport plugins.
+         * 
+         * <p>The factory interface takes a peer name/endpoint pair.
          */
-        PluginManager<StorageService,const DOMElement*> StorageServiceManager;
+        PluginManager<SOAPTransport,std::string,SOAPTransport::Address> SOAPTransportManager;
     };
 
 };