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
|
/******************************************************************************
*
* package: Log4Qt
* file: databaseappender.h
* created: Marth 2010
* author: Michael Filonenko
*
*
* Copyright 2010 Michael Filonenko
*
* 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 _DATABASEAPPENDER_H
#define _DATABASEAPPENDER_H
/******************************************************************************
* Dependencies
******************************************************************************/
#include "appenderskeleton.h"
#include <QtSql/QSqlDatabase>
/******************************************************************************
* Declarations
******************************************************************************/
namespace Log4Qt
{
/*!
* \brief The class DatabaseAppender appends log events to a sql database.
*
* \note All the functions declared in this class are thread-safe.
*
* \note The ownership and lifetime of objects of this class are managed.
* See \ref Ownership "Object ownership" for more details.
*/
class LOG4QT_EXPORT DatabaseAppender : public AppenderSkeleton
{
Q_OBJECT
/*!
* The property holds sql database connection the appender uses.
*
* The default is null to use the codec the writer has set.
*
* \sa connection(), setConnection()
*/
Q_PROPERTY(QString connection READ connection WRITE setConnection)
/*!
* The property holds sql database table name
*
\sa table(), setTable()
*/
Q_PROPERTY(QString table READ table WRITE setTable)
public:
DatabaseAppender(QObject *pParent = 0);
DatabaseAppender(Layout *pLayout,
QObject *pParent = 0);
DatabaseAppender(Layout *pLayout
,const QString& tableName
,const QString& connection = QSqlDatabase::defaultConnection
,QObject *pParent = 0);
virtual ~DatabaseAppender();
private:
DatabaseAppender(const DatabaseAppender &rOther); // Not implemented
DatabaseAppender &operator=(const DatabaseAppender &rOther); // Not implemented
public:
virtual bool requiresLayout() const;
QString connection() const;
QString table() const;
void setConnection(const QString& connection);
void setTable(const QString& table);
virtual void activateOptions();
protected:
virtual void append(const LoggingEvent &rEvent);
/*!
* Tests if all entry conditions for using append() in this class are
* met.
*
* If a conditions is not met, an error is logged and the function
* returns false. Otherwise the result of
* AppenderSkeleton::checkEntryConditions() is returned.
*
* The checked conditions are:
* - A writer has been set (APPENDER_USE_MISSING_WRITER_ERROR)
*
* The function is called as part of the checkEntryConditions() chain
* started by AppenderSkeleton::doAppend().
*
* \sa AppenderSkeleton::doAppend(),
* AppenderSkeleton::checkEntryConditions()
*/
virtual bool checkEntryConditions() const;
void closeWriter();
#ifndef QT_NO_DEBUG_STREAM
/*!
* Writes all object member variables to the given debug stream
* \a rDebug and returns the stream.
*
* <tt>
* %WriterAppender(name:"WA" encoding:"" immediateFlush:true
* isactive:false isclosed:false layout:"TTCC"
* referencecount:1 threshold:"NULL"
* writer:0x0)
* </tt>
* \sa QDebug, operator<<(QDebug debug, const LogObject &rLogObject )
*/
virtual QDebug debug(QDebug &rDebug) const;
#endif // QT_NO_DEBUG_STREAM
private:
QString connectionName;
QString tableName;
};
/**************************************************************************
* Operators, Helper
**************************************************************************/
/**************************************************************************
* Inline
**************************************************************************/
inline QString DatabaseAppender::connection() const
{ QMutexLocker locker(&mObjectGuard);
return connectionName; }
inline QString DatabaseAppender::table() const
{ QMutexLocker locker(&mObjectGuard);
return tableName; }
} // namespace Log4Qt
#endif // _DATABASEAPPENDER_H
|