2 * Copyright 2001-2006 Internet2
\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
8 * http://www.apache.org/licenses/LICENSE-2.0
\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
18 * @file SAMLConfig.h
\r
20 * Library configuration
\r
23 #ifndef __saml_config_h__
\r
24 #define __saml_config_h__
\r
26 #include <saml/base.h>
\r
27 #include <xmltooling/unicode.h>
\r
28 #include <xmltooling/XMLToolingConfig.h>
\r
33 * @namespace opensaml
\r
34 * Common classes for OpenSAML library
\r
36 namespace opensaml {
\r
39 * Singleton object that manages library startup/shutdown.configuration.
\r
41 class SAML_API SAMLConfig
\r
43 MAKE_NONCOPYABLE(SAMLConfig);
\r
45 virtual ~SAMLConfig() {}
\r
48 * Returns the global configuration object for the library.
\r
50 * @return reference to the global library configuration object
\r
52 static SAMLConfig& getConfig();
\r
55 * Initializes library
\r
57 * Each process using the library MUST call this function exactly once
\r
58 * before using any library classes.
\r
60 * @return true iff initialization was successful
\r
62 virtual bool init()=0;
\r
65 * Shuts down library
\r
67 * Each process using the library SHOULD call this function exactly once
\r
68 * before terminating itself
\r
70 virtual void term()=0;
\r
73 * Generate random information using the underlying security library
\r
75 * @param buf buffer for the information
\r
76 * @param len number of bytes to write into buffer
\r
78 virtual void generateRandomBytes(void* buf, unsigned int len)=0;
\r
81 * Generate random information using the underlying security library
\r
83 * @param buf string buffer for the information
\r
84 * @param len number of bytes to write into buffer
\r
86 virtual void generateRandomBytes(std::string& buf, unsigned int len)=0;
\r
89 * Generate a valid XML identifier of the form _X{32} where X is a
\r
90 * random hex character. The caller is responsible for freeing the result.
\r
92 * @return a valid null-terminated XML ID
\r
94 virtual XMLCh* generateIdentifier()=0;
\r
102 #endif /* __saml_config_h__ */
\r