A locking interface is supplied as a convenience for code that wants to * obtain a global system lock, but the actual configuration itself is not * synchronized. */ @@ -104,42 +110,40 @@ namespace xmltooling { /** * Shuts down library - * - * Each process using the library SHOULD call this function exactly once + *
Each process using the library SHOULD call this function exactly once
* before terminating itself
*/
virtual void term()=0;
/**
* Loads a shared/dynamic library extension.
- *
- * Extension libraries are managed using a pair of "C" linkage functions:
+ *
+ *
Extension libraries are managed using a pair of "C" linkage functions:
* extern "C" int xmltooling_extension_init(void* context);
* extern "C" void xmltooling_extension_term();
- *
- * This method is internally synchronized.
+ *
+ *
This method is internally synchronized. * * @param path pathname of shared library to load into process * @param context arbitrary data to pass to library initialization hook * @return true iff library was loaded successfully */ - virtual bool load_library(const char* path, void* context=NULL)=0; + virtual bool load_library(const char* path, void* context=nullptr)=0; /** * Configure logging system. - * - * May be called first, before initializing the library. Other calls to it + *
May be called first, before initializing the library. Other calls to it * must be externally synchronized. * * @param config either a logging configuration file, or a level from the set * (DEBUG, INFO, NOTICE, WARN, ERROR, CRIT, ALERT, FATAL, EMERG) * @return true iff configuration was successful */ - virtual bool log_config(const char* config=NULL)=0; + virtual bool log_config(const char* config=nullptr)=0; /** * Obtains a non-validating parser pool. - * Library must be initialized first. + *
Library must be initialized first. * * @return reference to a non-validating parser pool. */ @@ -147,31 +151,40 @@ namespace xmltooling { /** * Obtains a validating parser pool. - * Library must be initialized first. Schema/catalog registration must be + *
Library must be initialized first. Schema/catalog registration must be * externally synchronized. * * @return reference to a validating parser pool. */ virtual ParserPool& getValidatingParser() const=0; + /** + * Returns a reference to a named mutex. + *
The first access to a given name will create the object. + * + * @param name name of mutex to access + * @return reference to a mutex object + */ + virtual Mutex& getNamedMutex(const char* name)=0; + #ifndef XMLTOOLING_NO_XMLSEC /** * Returns the global KeyInfoResolver instance. * - * @return global KeyInfoResolver or NULL + * @return global KeyInfoResolver or nullptr */ const KeyInfoResolver* getKeyInfoResolver() const; /** * Returns the global ReplayCache instance. * - * @return global ReplayCache or NULL + * @return global ReplayCache or nullptr */ ReplayCache* getReplayCache() const; /** * Sets the global KeyInfoResolver instance. - * This method must be externally synchronized with any code that uses the object. + *
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 @@ -180,7 +193,7 @@ namespace xmltooling { /** * Sets the global ReplayCache instance. - * This method must be externally synchronized with any code that uses the object. + *
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 @@ -191,27 +204,27 @@ namespace xmltooling { /** * Returns the global PathResolver instance. * - * @return global PathResolver or NULL + * @return global PathResolver or nullptr */ PathResolver* getPathResolver() const; /** * Returns the global TemplateEngine instance. * - * @return global TemplateEngine or NULL + * @return global TemplateEngine or nullptr */ TemplateEngine* getTemplateEngine() const; /** * Returns the global URLEncoder instance. * - * @return global URLEncoder or NULL + * @return global URLEncoder or nullptr */ const URLEncoder* getURLEncoder() const; /** * Sets the global PathResolver instance. - * This method must be externally synchronized with any code that uses the object. + *
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 @@ -220,7 +233,7 @@ namespace xmltooling { /** * Sets the global TemplateEngine instance. - * This method must be externally synchronized with any code that uses the object. + *
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 @@ -229,7 +242,7 @@ namespace xmltooling { /** * Sets the global URLEncoder instance. - * This method must be externally synchronized with any code that uses the object. + *
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 @@ -237,18 +250,29 @@ namespace xmltooling { void setURLEncoder(URLEncoder* urlEncoder); /** + * @deprecated * List of catalog files to load into validating parser pool at initialization time. - * Like other path settings, the separator depends on the platform + *
Like other path settings, the separator depends on the platform
* (semicolon on Windows, colon otherwise).
*/
std::string catalog_path;
-
+
+ /** A User-Agent header to include in HTTP client requests. */
+ std::string user_agent;
+
/**
* Adjusts any clock comparisons to be more liberal/permissive by the
* indicated number of seconds.
*/
unsigned int clock_skew_secs;
+#ifndef XMLTOOLING_LITE
+ /**
+ * Manages factories for StorageService plugins.
+ */
+ PluginManager