xmltooling/XMLToolingConfig.h

   1 /*\r
   2  *  Copyright 2001-2006 Internet2\r
   3  * \r
   4  * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 \r
  17 /**\r
  18  * @file XMLToolingConfig.h\r
  19  * \r
  20  * Library configuration \r
  21  */\r
  22 \r
  23 #ifndef __xmltooling_config_h__\r
  24 #define __xmltooling_config_h__\r
  25 \r
  26 #include <xmltooling/Lockable.h>\r
  27 #include <xmltooling/util/ParserPool.h>\r
  28 \r
  29 namespace xmltooling {\r
  30 \r
  31     /**\r
  32      * Singleton object that manages library startup/shutdown.configuration.\r
  33      * \r
  34      * A locking interface is supplied as a convenience for code that wants to\r
  35      * obtain a global system lock, but the actual configuration itself is not\r
  36      * synchronized.\r
  37      */\r
  38     class XMLTOOL_API XMLToolingConfig : public Lockable\r
  39     {\r
  40     MAKE_NONCOPYABLE(XMLToolingConfig);\r
  41     public:\r
  42         virtual ~XMLToolingConfig() {}\r
  43 \r
  44         /**\r
  45          * Returns the global configuration object for the library.\r
  46          * \r
  47          * @return reference to the global library configuration object\r
  48          */\r
  49         static XMLToolingConfig& getConfig();\r
  50         \r
  51         /**\r
  52          * Initializes library\r
  53          * \r
  54          * Each process using the library MUST call this function exactly once\r
  55          * before using any library classes except for the LogConfig method.\r
  56          * \r
  57          * @return true iff initialization was successful \r
  58          */\r
  59         virtual bool init()=0;\r
  60         \r
  61         /**\r
  62          * Shuts down library\r
  63          * \r
  64          * Each process using the library SHOULD call this function exactly once\r
  65          * before terminating itself\r
  66          */\r
  67         virtual void term()=0;\r
  68 \r
  69         /**\r
  70          * Loads a shared/dynamic library extension.\r
  71          * \r
  72          * Extension libraries are managed using a pair of "C" linkage functions:<br>\r
  73          *      extern "C" int xmltooling_extension_init(void* context);<br>\r
  74          *      extern "C" void xmltooling_extension_term();\r
  75          * \r
  76          * This method is internally synchronized.\r
  77          * \r
  78          * @param path      pathname of shared library to load into process\r
  79          * @param context   arbitrary data to pass to library initialization hook\r
  80          * @return true iff library was loaded successfully\r
  81          */\r
  82         virtual bool load_library(const char* path, void* context=NULL)=0;\r
  83         \r
  84         /**\r
  85          * Configure logging system.\r
  86          * \r
  87          * May be called first, before initializing the library. Other calls to it\r
  88          * must be externally synchronized. \r
  89          * \r
  90          * @param config    either a logging configuration file, or a level from the set\r
  91          *                  (DEBUG, INFO, NOTICE, WARN, ERROR, CRIT, ALERT, FATAL, EMERG)\r
  92          * @return true iff configuration was successful\r
  93          */\r
  94         virtual bool log_config(const char* config=NULL)=0;\r
  95 \r
  96         /**\r
  97          * Obtains a non-validating parser pool.\r
  98          * Library must be initialized first.\r
  99          *\r
 100          * @return reference to a non-validating parser pool.\r
 101          */\r
 102         virtual ParserPool& getParser() const=0;\r
 103 \r
 104         /**\r
 105          * Obtains a validating parser pool.\r
 106          * Library must be initialized first. Schema/catalog registration must be\r
 107          * externally synchronized.\r
 108          *\r
 109          * @return reference to a validating parser pool.\r
 110          */\r
 111         virtual ParserPool& getValidatingParser() const=0;\r
 112 \r
 113     protected:\r
 114         XMLToolingConfig() {}\r
 115     };\r
 116 \r
 117 };\r
 118 \r
 119 #endif /* __xmltooling_config_h__ */\r