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 #if !defined(__xmltooling_config_h__)\r
  24 #define __xmltooling_config_h__\r
  25 \r
  26 #include <xmltooling/ILockable.h>\r
  27 \r
  28 namespace xmltooling {\r
  29 \r
  30     /**\r
  31      * Singleton object that manages library startup/shutdown.configuration.\r
  32      */\r
  33     class XMLTOOL_API XMLToolingConfig : public ILockable\r
  34     {\r
  35     MAKE_NONCOPYABLE(XMLToolingConfig);\r
  36     public:\r
  37         virtual ~XMLToolingConfig() {}\r
  38 \r
  39         /**\r
  40          * Returns the global configuration object for the library.\r
  41          * \r
  42          * @return reference to the global library configuration object\r
  43          */\r
  44         static XMLToolingConfig& getConfig();\r
  45         \r
  46         /**\r
  47          * Initializes library\r
  48          * \r
  49          * Each process using the library MUST call this function exactly once\r
  50          * before using any library classes except for the LogConfig method.\r
  51          * \r
  52          * @return true iff initialization was successful \r
  53          */\r
  54         virtual bool init()=0;\r
  55         \r
  56         /**\r
  57          * Shuts down library\r
  58          * \r
  59          * Each process using the library SHOULD call this function exactly once\r
  60          * before terminating itself\r
  61          */\r
  62         virtual void term()=0;\r
  63 \r
  64         /**\r
  65          * Loads a shared/dynamic library extension.\r
  66          * \r
  67          * Extension libraries are managed using a pair of "C" linkage functions:<br>\r
  68          *      extern "C" int xmltooling_extension_init(void* context);<br>\r
  69          *      extern "C" void xmltooling_extension_term();\r
  70          * \r
  71          * @param path      pathname of shared library to load into process\r
  72          * @param context   arbitrary data to pass to library initialization hook\r
  73          * @return true iff library was loaded successfully\r
  74          */\r
  75         virtual bool load_library(const char* path, void* context=NULL)=0;\r
  76         \r
  77         /**\r
  78          * Configure logging system.\r
  79          * \r
  80          * May be called first, before initializing the library.\r
  81          * \r
  82          * @param config    either a logging configuration file, or a level from the set\r
  83          *                  (DEBUG, INFO, NOTICE, WARN, ERROR, CRIT, ALERT, FATAL, EMERG)\r
  84          * @return true iff configuration was successful\r
  85          */\r
  86         virtual bool log_config(const char* config=NULL)=0;\r
  87 \r
  88     protected:\r
  89         XMLToolingConfig() {}\r
  90     };\r
  91 \r
  92 };\r
  93 \r
  94 #endif /* __xmltooling_config_h__ */\r