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/PluginManager.h>\r
  28 #include <xmltooling/util/ParserPool.h>\r
  29 \r
  30 #ifndef XMLTOOLING_NO_XMLSEC\r
  31 namespace xmlsignature {\r
  32     class XMLTOOL_API CredentialResolver;\r
  33     class XMLTOOL_API KeyResolver;\r
  34 };\r
  35 #endif\r
  36 \r
  37 #if defined (_MSC_VER)\r
  38     #pragma warning( push )\r
  39     #pragma warning( disable : 4251 )\r
  40 #endif\r
  41 \r
  42 namespace xmltooling {\r
  43 \r
  44     /**\r
  45      * Singleton object that manages library startup/shutdown.configuration.\r
  46      * \r
  47      * A locking interface is supplied as a convenience for code that wants to\r
  48      * obtain a global system lock, but the actual configuration itself is not\r
  49      * synchronized.\r
  50      */\r
  51     class XMLTOOL_API XMLToolingConfig : public Lockable\r
  52     {\r
  53     MAKE_NONCOPYABLE(XMLToolingConfig);\r
  54     public:\r
  55         virtual ~XMLToolingConfig() {}\r
  56 \r
  57         /**\r
  58          * Returns the global configuration object for the library.\r
  59          * \r
  60          * @return reference to the global library configuration object\r
  61          */\r
  62         static XMLToolingConfig& getConfig();\r
  63         \r
  64         /**\r
  65          * Initializes library\r
  66          * \r
  67          * Each process using the library MUST call this function exactly once\r
  68          * before using any library classes except for the LogConfig method.\r
  69          * \r
  70          * @return true iff initialization was successful \r
  71          */\r
  72         virtual bool init()=0;\r
  73         \r
  74         /**\r
  75          * Shuts down library\r
  76          * \r
  77          * Each process using the library SHOULD call this function exactly once\r
  78          * before terminating itself\r
  79          */\r
  80         virtual void term()=0;\r
  81 \r
  82         /**\r
  83          * Loads a shared/dynamic library extension.\r
  84          * \r
  85          * Extension libraries are managed using a pair of "C" linkage functions:<br>\r
  86          *      extern "C" int xmltooling_extension_init(void* context);<br>\r
  87          *      extern "C" void xmltooling_extension_term();\r
  88          * \r
  89          * This method is internally synchronized.\r
  90          * \r
  91          * @param path      pathname of shared library to load into process\r
  92          * @param context   arbitrary data to pass to library initialization hook\r
  93          * @return true iff library was loaded successfully\r
  94          */\r
  95         virtual bool load_library(const char* path, void* context=NULL)=0;\r
  96         \r
  97         /**\r
  98          * Configure logging system.\r
  99          * \r
 100          * May be called first, before initializing the library. Other calls to it\r
 101          * must be externally synchronized. \r
 102          * \r
 103          * @param config    either a logging configuration file, or a level from the set\r
 104          *                  (DEBUG, INFO, NOTICE, WARN, ERROR, CRIT, ALERT, FATAL, EMERG)\r
 105          * @return true iff configuration was successful\r
 106          */\r
 107         virtual bool log_config(const char* config=NULL)=0;\r
 108 \r
 109         /**\r
 110          * Obtains a non-validating parser pool.\r
 111          * Library must be initialized first.\r
 112          *\r
 113          * @return reference to a non-validating parser pool.\r
 114          */\r
 115         virtual ParserPool& getParser() const=0;\r
 116 \r
 117         /**\r
 118          * Obtains a validating parser pool.\r
 119          * Library must be initialized first. Schema/catalog registration must be\r
 120          * externally synchronized.\r
 121          *\r
 122          * @return reference to a validating parser pool.\r
 123          */\r
 124         virtual ParserPool& getValidatingParser() const=0;\r
 125 \r
 126 #ifndef XMLTOOLING_NO_XMLSEC\r
 127         /**\r
 128          * Manages factories for KeyResolver plugins.\r
 129          */\r
 130         xmltooling::PluginManager<xmlsignature::KeyResolver,const DOMElement*> KeyResolverManager;\r
 131 \r
 132         /**\r
 133          * Manages factories for CredentialResolver plugins.\r
 134          */\r
 135         xmltooling::PluginManager<xmlsignature::CredentialResolver,const DOMElement*> CredentialResolverManager;\r
 136 #endif\r
 137 \r
 138     protected:\r
 139         XMLToolingConfig() {}\r
 140     };\r
 141 \r
 142 };\r
 143 \r
 144 #if defined (_MSC_VER)\r
 145     #pragma warning( pop )\r
 146 #endif\r
 147 \r
 148 #endif /* __xmltooling_config_h__ */\r