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