/*
- * Copyright 2001-2006 Internet2
+ * Copyright 2001-2009 Internet2
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*/
/**
- * @file XMLToolingConfig.h
+ * @file xmltooling/XMLToolingConfig.h
*
* Library configuration
*/
#include <xmltooling/Lockable.h>
#include <xmltooling/PluginManager.h>
+#include <xmltooling/soap/SOAPTransport.h>
#include <xmltooling/util/ParserPool.h>
#ifndef XMLTOOLING_NO_XMLSEC
-namespace xmlsignature {
+namespace xmltooling {
class XMLTOOL_API CredentialResolver;
- class XMLTOOL_API KeyResolver;
+ class XMLTOOL_API KeyInfoResolver;
+ class XMLTOOL_API TrustEngine;
+ class XMLTOOL_API XSECCryptoX509CRL;
};
#endif
namespace xmltooling {
+ class XMLTOOL_API PathResolver;
+ class XMLTOOL_API TemplateEngine;
+ class XMLTOOL_API URLEncoder;
+#ifndef XMLTOOLING_LITE
class XMLTOOL_API ReplayCache;
class XMLTOOL_API StorageService;
- class XMLTOOL_API TrustEngine;
- class XMLTOOL_API XSECCryptoX509CRL;
+#endif
/**
* Singleton object that manages library startup/shutdown.configuration.
{
MAKE_NONCOPYABLE(XMLToolingConfig);
protected:
- XMLToolingConfig() : m_replayCache(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() {}
*/
virtual ParserPool& getValidatingParser() const=0;
+#ifndef XMLTOOLING_NO_XMLSEC
+ /**
+ * Returns the global KeyInfoResolver instance.
+ *
+ * @return global KeyInfoResolver or NULL
+ */
+ const KeyInfoResolver* getKeyInfoResolver() const {
+ return m_keyInfoResolver;
+ }
+
+ /**
+ * Returns the global ReplayCache instance.
+ *
+ * @return global ReplayCache or NULL
+ */
+ ReplayCache* getReplayCache() const {
+ return m_replayCache;
+ }
+
+ /**
+ * 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);
+
/**
* Sets the global ReplayCache instance.
* This method must be externally synchronized with any code that uses the object.
* @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 NULL
*/
- ReplayCache* getReplayCache() const {
- return m_replayCache;
+ PathResolver* getPathResolver() const {
+ return m_pathResolver;
+ }
+
+ /**
+ * Returns the global TemplateEngine instance.
+ *
+ * @return global TemplateEngine or NULL
+ */
+ TemplateEngine* getTemplateEngine() const {
+ return m_templateEngine;
}
-
+
+ /**
+ * Returns the global URLEncoder instance.
+ *
+ * @return global URLEncoder or NULL
+ */
+ const URLEncoder* getURLEncoder() const {
+ return m_urlEncoder;
+ }
+
+ /**
+ * 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.
+ * This method must be externally synchronized with any code that uses the object.
+ * Any previously set object is destroyed.
+ *
+ * @param templateEngine new TemplateEngine instance to store
+ */
+ void setTemplateEngine(TemplateEngine* templateEngine);
+
+ /**
+ * 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);
+
/**
* List of catalog files to load into validating parser pool at initialization time.
* Like other path settings, the separator depends on the platform
virtual XSECCryptoX509CRL* X509CRL() const=0;
/**
- * Manages factories for KeyResolver plugins.
+ * Manages factories for KeyInfoResolver plugins.
*/
- PluginManager<xmlsignature::KeyResolver,const DOMElement*> KeyResolverManager;
+ PluginManager<KeyInfoResolver,std::string,const xercesc::DOMElement*> KeyInfoResolverManager;
/**
* Manages factories for CredentialResolver plugins.
*/
- PluginManager<xmlsignature::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 StorageService plugins.
*/
- PluginManager<StorageService,const DOMElement*> StorageServiceManager;
+ 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.
+ *
+ * @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<SOAPTransport,std::string,SOAPTransport::Address> SOAPTransportManager;
};
};
projects / shibboleth / cpp-xmltooling.git / blobdiff