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 XMLToolingConfig.h
\r
20 * Library configuration
\r
23 #if !defined(__xmltooling_config_h__)
\r
24 #define __xmltooling_config_h__
\r
26 #include <xmltooling/ILockable.h>
\r
28 namespace xmltooling {
\r
31 * Singleton object that manages library startup/shutdown.configuration.
\r
33 * A locking interface is supplied as a convenience for code that wants to
\r
34 * obtain a global system lock, but the actual configuration itself is not
\r
37 class XMLTOOL_API XMLToolingConfig : public ILockable
\r
39 MAKE_NONCOPYABLE(XMLToolingConfig);
\r
41 virtual ~XMLToolingConfig() {}
\r
44 * Returns the global configuration object for the library.
\r
46 * @return reference to the global library configuration object
\r
48 static XMLToolingConfig& getConfig();
\r
51 * Initializes library
\r
53 * Each process using the library MUST call this function exactly once
\r
54 * before using any library classes except for the LogConfig method.
\r
56 * @return true iff initialization was successful
\r
58 virtual bool init()=0;
\r
61 * Shuts down library
\r
63 * Each process using the library SHOULD call this function exactly once
\r
64 * before terminating itself
\r
66 virtual void term()=0;
\r
69 * Loads a shared/dynamic library extension.
\r
71 * Extension libraries are managed using a pair of "C" linkage functions:<br>
\r
72 * extern "C" int xmltooling_extension_init(void* context);<br>
\r
73 * extern "C" void xmltooling_extension_term();
\r
75 * This method is internally synchronized.
\r
77 * @param path pathname of shared library to load into process
\r
78 * @param context arbitrary data to pass to library initialization hook
\r
79 * @return true iff library was loaded successfully
\r
81 virtual bool load_library(const char* path, void* context=NULL)=0;
\r
84 * Configure logging system.
\r
86 * May be called first, before initializing the library. Other calls to it
\r
87 * must be externally synchronized.
\r
89 * @param config either a logging configuration file, or a level from the set
\r
90 * (DEBUG, INFO, NOTICE, WARN, ERROR, CRIT, ALERT, FATAL, EMERG)
\r
91 * @return true iff configuration was successful
\r
93 virtual bool log_config(const char* config=NULL)=0;
\r
96 XMLToolingConfig() {}
\r
101 #endif /* __xmltooling_config_h__ */
\r