X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=saml%2FSAMLConfig.h;h=8491d0f0258f0f18496e25a378ed758ed195b995;hb=5263186a620ca02913980ad2d35d4045844e7a05;hp=b97bda0ba3b798adf66696a6a550b733a4c9ebac;hpb=d70c88b320fcc61aa5f657abbf57f8c451f4ab25;p=shibboleth%2Fcpp-opensaml.git diff --git a/saml/SAMLConfig.h b/saml/SAMLConfig.h index b97bda0..8491d0f 100644 --- a/saml/SAMLConfig.h +++ b/saml/SAMLConfig.h @@ -36,8 +36,13 @@ */ namespace opensaml { + class SAML_API ArtifactMap; + class SAML_API MessageEncoder; + class SAML_API MessageDecoder; + class SAML_API ReplayCache; class SAML_API SAMLArtifact; class SAML_API TrustEngine; + class SAML_API URLEncoder; namespace saml2md { class SAML_API MetadataProvider; @@ -69,19 +74,80 @@ 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 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; + } + + /** + * 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 */ - virtual void term()=0; + ReplayCache* getReplayCache() const { + return m_replayCache; + } /** * Generate random information using the underlying security library @@ -116,16 +182,16 @@ namespace opensaml { * @return SHA-1 hash of the data */ virtual std::string hashSHA1(const char* s, bool toHex=false)=0; - + /** - * Manages factories for MetadataProvider plugins. + * Manages factories for MessageDecoder plugins. */ - xmltooling::PluginManager MetadataProviderManager; - + xmltooling::PluginManager MessageDecoderManager; + /** - * Manages factories for MetadataFilter plugins. + * Manages factories for MessageEncoder plugins. */ - xmltooling::PluginManager MetadataFilterManager; + xmltooling::PluginManager MessageEncoderManager; /** * Manages factories for SAMLArtifact plugins. @@ -137,8 +203,27 @@ namespace opensaml { */ xmltooling::PluginManager TrustEngineManager; + /** + * Manages factories for MetadataProvider plugins. + */ + xmltooling::PluginManager MetadataProviderManager; + + /** + * Manages factories for MetadataFilter plugins. + */ + xmltooling::PluginManager MetadataFilterManager; + protected: - SAMLConfig() {} + SAMLConfig() : m_artifactMap(NULL), m_urlEncoder(NULL), m_replayCache(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; + + /** Global ReplayCache instance. */ + ReplayCache* m_replayCache; }; #if defined (_MSC_VER)