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