saml/SAMLConfig.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 SAMLConfig.h\r
  19  * \r
  20  * Library configuration \r
  21  */\r
  22 \r
  23 #ifndef __saml_config_h__\r
  24 #define __saml_config_h__\r
  25 \r
  26 #include <saml/base.h>\r
  27 \r
  28 /**\r
  29  * @namespace opensaml\r
  30  * Common classes for OpenSAML library\r
  31  */\r
  32 namespace opensaml {\r
  33 \r
  34     /**\r
  35      * Singleton object that manages library startup/shutdown.configuration.\r
  36      */\r
  37     class SAML_API SAMLConfig\r
  38     {\r
  39     MAKE_NONCOPYABLE(SAMLConfig);\r
  40     public:\r
  41         virtual ~SAMLConfig() {}\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 SAMLConfig& 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.\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     protected:\r
  69         SAMLConfig() {}\r
  70     };\r
  71 \r
  72 };\r
  73 \r
  74 #endif /* __saml_config_h__ */\r