X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=saml%2FSAMLConfig.h;h=6945ab4e0e80513eb3cca02aa8ba1c93cd98b171;hb=90ade2861c4d44e13d4d0013034fbd66cd294069;hp=cd9dfa1e7f309e3f7ebea24a06f225766d62d6fc;hpb=be0b6f800ddf54b62d31342576c917b4fb59533c;p=shibboleth%2Fcpp-opensaml.git

diff --git a/saml/SAMLConfig.h b/saml/SAMLConfig.h
index cd9dfa1..6945ab4 100644
--- a/saml/SAMLConfig.h
+++ b/saml/SAMLConfig.h
@@ -15,7 +15,7 @@
  */
 
 /**
- * @file SAMLConfig.h
+ * @file saml/SAMLConfig.h
  * 
  * Library configuration 
  */
@@ -24,7 +24,8 @@
 #define __saml_config_h__
 
 #include <saml/base.h>
-#include <xmltooling/unicode.h>
+
+#include <xmltooling/PluginManager.h>
 #include <xmltooling/XMLToolingConfig.h>
 
 #include <string>
@@ -35,6 +36,23 @@
  */
 namespace opensaml {
 
+    class SAML_API ArtifactMap;
+    class SAML_API MessageEncoder;
+    class SAML_API MessageDecoder;
+    class SAML_API SAMLArtifact;
+    class SAML_API TrustEngine;
+    class SAML_API URLEncoder;
+
+    namespace saml2md {
+        class SAML_API MetadataProvider;
+        class SAML_API MetadataFilter;
+    };
+
+#if defined (_MSC_VER)
+    #pragma warning( push )
+    #pragma warning( disable : 4250 4251 )
+#endif
+
     /**
      * Singleton object that manages library startup/shutdown.configuration.
      */
@@ -55,19 +73,62 @@ namespace opensaml {
          * Initializes library
          * 
          * Each process using the library MUST call this function exactly once
-         * before using any library classes.
+         * before using any library classes. The flag controls whether this is the
+         * "dominant" library or not and can allow the SAML library to be loaded
+         * as an extension of XMLTooling rather than subsuming it.
          * 
+         * @param initXMLTooling true iff this method should initialize the XMLTooling layer
          * @return true iff initialization was successful 
          */
-        virtual bool init()=0;
+        virtual bool init(bool initXMLTooling=true)=0;
         
         /**
          * Shuts down library
          * 
          * Each process using the library SHOULD call this function exactly once
-         * before terminating itself
+         * before terminating itself. The flag controls whether this is the
+         * "dominant" library or not and can allow the SAML library to be loaded
+         * as an extension of XMLTooling rather than subsuming it.
+         * 
+         * @param termXMLTooling true iff this method should shutdown the XMLTooling layer
          */
-        virtual void term()=0;
+        virtual void term(bool termXMLTooling=true)=0;
+        
+        /**
+         * Sets the global ArtifactMap instance.
+         * This method must be externally synchronized with any code that uses the object.
+         * Any previously set object is destroyed.
+         * 
+         * @param artifactMap   new ArtifactMap instance to store
+         */
+        void setArtifactMap(ArtifactMap* artifactMap);
+        
+        /**
+         * Returns the global ArtifactMap instance.
+         * 
+         * @return  global ArtifactMap or NULL
+         */
+        ArtifactMap* getArtifactMap() const {
+            return m_artifactMap;
+        }
+
+        /**
+         * 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
+         */
+        URLEncoder* getURLEncoder() const {
+            return m_urlEncoder;
+        }
         
         /**
          * Generate random information using the underlying security library
@@ -92,11 +153,61 @@ namespace opensaml {
          * @return a valid null-terminated XML ID
          */
         virtual XMLCh* generateIdentifier()=0;
+        
+        /**
+         * Generate the SHA-1 hash of a string
+         * 
+         * @param s     NULL-terminated string to hash
+         * @param toHex true iff the result should be encoded in hexadecimal form or left as raw bytes
+         *  
+         * @return  SHA-1 hash of the data
+         */
+        virtual std::string hashSHA1(const char* s, bool toHex=false)=0;
+
+        /**
+         * Manages factories for MessageDecoder plugins.
+         */
+        xmltooling::PluginManager<MessageDecoder,const DOMElement*> MessageDecoderManager;
+
+        /**
+         * Manages factories for MessageEncoder plugins.
+         */
+        xmltooling::PluginManager<MessageEncoder,const DOMElement*> MessageEncoderManager;        
+
+        /**
+         * Manages factories for SAMLArtifact plugins.
+         */
+        xmltooling::PluginManager<SAMLArtifact,const char*> SAMLArtifactManager;
+
+        /**
+         * Manages factories for TrustEngine plugins.
+         */
+        xmltooling::PluginManager<TrustEngine,const DOMElement*> TrustEngineManager;
+
+        /**
+         * Manages factories for MetadataProvider plugins.
+         */
+        xmltooling::PluginManager<saml2md::MetadataProvider,const DOMElement*> MetadataProviderManager;
+        
+        /**
+         * Manages factories for MetadataFilter plugins.
+         */
+        xmltooling::PluginManager<saml2md::MetadataFilter,const DOMElement*> MetadataFilterManager;
 
     protected:
-        SAMLConfig() {}
+        SAMLConfig() : m_artifactMap(NULL), m_urlEncoder(NULL) {}
+        
+        /** Global ArtifactMap instance for use by artifact-related functions. */
+        ArtifactMap* m_artifactMap;
+
+        /** Global URLEncoder instance for use by URL-related functions. */
+        URLEncoder* m_urlEncoder;
     };
 
+#if defined (_MSC_VER)
+    #pragma warning( pop )
+#endif
+    
 };
 
 #endif /* __saml_config_h__ */