1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
/******************************************************************************
*
* package: Logging
* file: propertyconfigurator.h
* created: September 2007
* author: Martin Heinrich
*
*
* Copyright 2007 Martin Heinrich
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
******************************************************************************/
#ifndef LOG4QT_PROPERTYCONFIGURATOR_H
#define LOG4QT_PROPERTYCONFIGURATOR_H
/******************************************************************************
* Dependencies
******************************************************************************/
#include <QtCore/QHash>
#include "helpers/logobjectptr.h"
#include "log4qt.h"
/******************************************************************************
* Declarations
******************************************************************************/
class QSettings;
namespace Log4Qt
{
class Appender;
class Layout;
class ListAppender;
class Logger;
class Properties;
class LoggerRepository;
/*!
* \brief The class PropertyConfigurator allows the configuration of the
* package from a JAVA properties file.
*
* \note All the functions declared in this class are thread-safe.
*/
class LOG4QT_EXPORT PropertyConfigurator
{
public:
PropertyConfigurator();
// virtual ~PropertyConfigurator(); // Use compiler default
private:
PropertyConfigurator(const PropertyConfigurator &rOther); // Not implemented
PropertyConfigurator &operator=(const PropertyConfigurator &rOther); // Not implemented
public:
/*!
* \sa ConfiguratorHelper::configureError()
*/
bool doConfigure(const Properties &rProperties,
LoggerRepository *pLoggerRepository = 0);
/*!
* \sa ConfiguratorHelper::configureError()
*/
bool doConfigure(const QString &rConfigFileName,
LoggerRepository *pLoggerRepository = 0);
/*!
* Reads the configuration data from the QSettings object
* \a rSettings.
*
* \sa \ref Properties::load(const QSettings &) "Properties::load()",
* ConfiguratorHelper::configureError()
*/
bool doConfigure(const QSettings &rSettings,
LoggerRepository *pLoggerRepository = 0);
// JAVA: void doConfigure(const QUrl &rUrl, LoggerRepository *pLoggerRepository);
/*!
* \sa ConfiguratorHelper::configureError()
*/
static bool configure(const Properties &rProperties);
/*!
* \sa ConfiguratorHelper::configureError()
*/
static bool configure(const QString &rConfigFilename);
/*!
* Reads the configuration data from the QSettings object
* \a rSettings.
*
* \sa \ref doConfigure(const QSettings &, LoggerRepository *) "doConfigure()",
* \ref Properties::load(const QSettings &) "Properties::load()",
* ConfiguratorHelper::configureError()
*/
static bool configure(const QSettings &rSettings);
// JAVA: static void configure(const QUrl &rUrl);
/*!
* \sa ConfiguratorHelper::configureError(),
* ConfiguratorHelper::configurationFile()
*/
static bool configureAndWatch(const QString &rConfigFilename);
private:
void configureFromFile(const QString &rConfigFileName,
LoggerRepository *pLoggerRepository);
void configureFromProperties(const Properties &rProperties,
LoggerRepository *pLoggerRepository);
void configureFromSettings(const QSettings &rSettings,
LoggerRepository *pLoggerRepository);
void configureGlobalSettings(const Properties &rProperties,
LoggerRepository *pLoggerRepository) const;
void configureNonRootElements(const Properties &rProperties,
LoggerRepository *pLoggerRepository);
void configureRootLogger(const Properties &rProperties,
LoggerRepository *pLoggerRepository);
void parseAdditivityForLogger(const Properties &rProperties,
Logger *pLogger,
const QString &rLog4jName) const;
LogObjectPtr<Appender> parseAppender(const Properties &rProperties,
const QString &rName);
LogObjectPtr<Layout> parseLayout(const Properties &rProperties,
const QString &rAppenderName);
void parseLogger(const Properties &rProperties,
Logger *pLogger,
const QString &rKey,
const QString &rValue);
void setProperties(const Properties &rProperties,
const QString &rPrefix,
const QStringList &rExclusions,
QObject *pObject);
void startCaptureErrors();
bool stopCaptureErrors();
private:
LogObjectPtr<ListAppender> mpConfigureErrors;
QHash< QString, LogObjectPtr<Appender> > mAppenderRegistry;
};
/**************************************************************************
* Operators, Helper
**************************************************************************/
#ifndef QT_NO_DEBUG_STREAM
/*!
* \relates PropertyConfigurator
*
* Writes all object member variables to the given debug stream \a debug
* and returns the stream.
*
* <tt>
* %PropertyConfigurator()
* </tt>
* \sa QDebug
*/
QDebug operator<<(QDebug debug,
const PropertyConfigurator &rPropertyConfigurator);
#endif
/**************************************************************************
* Inline
**************************************************************************/
inline PropertyConfigurator::PropertyConfigurator()
{}
} // namspace Logging
// Q_DECLARE_TYPEINFO(Log4Qt::PropertyConfigurator, Q_COMPLEX_TYPE); // Use default
#endif // LOG4QT_PROPERTYCONFIGURATOR_H
|
