X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=saml%2FSAMLConfig.h;h=1d0dbd12708e6d1256191ffd35ad49aa8030c69d;hb=1114253f9e24bc8b77967551ce9bceb0032d3bc5;hp=dca8f15f80498eea3c623fcfee6b31429aa4c154;hpb=12d8e6ed0125ea986a8eb78ea177b6d6f0251fd6;p=shibboleth%2Fcpp-opensaml.git diff --git a/saml/SAMLConfig.h b/saml/SAMLConfig.h index dca8f15..1d0dbd1 100644 --- a/saml/SAMLConfig.h +++ b/saml/SAMLConfig.h @@ -26,7 +26,6 @@ #include #include -#include #include #include @@ -37,6 +36,13 @@ */ 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; @@ -67,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(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 + */ + 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 */ - virtual void term()=0; + URLEncoder* getURLEncoder() const { + return m_urlEncoder; + } /** * Generate random information using the underlying security library @@ -106,6 +155,36 @@ namespace opensaml { 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 MessageDecoderManager; + + /** + * Manages factories for MessageEncoder plugins. + */ + xmltooling::PluginManager MessageEncoderManager; + + /** + * Manages factories for SAMLArtifact plugins. + */ + xmltooling::PluginManager SAMLArtifactManager; + + /** + * Manages factories for TrustEngine plugins. + */ + xmltooling::PluginManager TrustEngineManager; + + /** * Manages factories for MetadataProvider plugins. */ xmltooling::PluginManager MetadataProviderManager; @@ -116,7 +195,13 @@ namespace opensaml { xmltooling::PluginManager 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)