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