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 #include <xmltooling/unicode.h>\r
  28 #include <string>\r
  29 \r
  30 /**\r
  31  * @namespace opensaml\r
  32  * Common classes for OpenSAML library\r
  33  */\r
  34 namespace opensaml {\r
  35 \r
  36     /**\r
  37      * Singleton object that manages library startup/shutdown.configuration.\r
  38      */\r
  39     class SAML_API SAMLConfig\r
  40     {\r
  41     MAKE_NONCOPYABLE(SAMLConfig);\r
  42     public:\r
  43         virtual ~SAMLConfig() {}\r
  44 \r
  45         /**\r
  46          * Returns the global configuration object for the library.\r
  47          * \r
  48          * @return reference to the global library configuration object\r
  49          */\r
  50         static SAMLConfig& getConfig();\r
  51         \r
  52         /**\r
  53          * Initializes library\r
  54          * \r
  55          * Each process using the library MUST call this function exactly once\r
  56          * before using any library classes.\r
  57          * \r
  58          * @return true iff initialization was successful \r
  59          */\r
  60         virtual bool init()=0;\r
  61         \r
  62         /**\r
  63          * Shuts down library\r
  64          * \r
  65          * Each process using the library SHOULD call this function exactly once\r
  66          * before terminating itself\r
  67          */\r
  68         virtual void term()=0;\r
  69         \r
  70         /**\r
  71          * Generate random information using the underlying security library\r
  72          * \r
  73          * @param buf   buffer for the information\r
  74          * @param len   number of bytes to write into buffer\r
  75          */\r
  76         virtual void generateRandomBytes(void* buf, unsigned int len)=0;\r
  77 \r
  78         /**\r
  79          * Generate random information using the underlying security library\r
  80          * \r
  81          * @param buf   string buffer for the information\r
  82          * @param len   number of bytes to write into buffer\r
  83          */\r
  84         virtual void generateRandomBytes(std::string& buf, unsigned int len)=0;\r
  85 \r
  86         /**\r
  87          * Generate a valid XML identifier of the form _X{32} where X is a\r
  88          * random hex character. The caller is responsible for freeing the result.\r
  89          * \r
  90          * @return a valid null-terminated XML ID\r
  91          */\r
  92         virtual XMLCh* generateIdentifier()=0;\r
  93 \r
  94     protected:\r
  95         SAMLConfig() {}\r
  96     };\r
  97 \r
  98 };\r
  99 \r
 100 #endif /* __saml_config_h__ */\r