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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
// Copyright (C) 2018-2019 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
#ifndef ISC_TRANSLATOR_LOGGER_H
#define ISC_TRANSLATOR_LOGGER_H 1
#include <yang/translator.h>
#include <list>
namespace isc {
namespace yang {
/// Logger translation between YANG and JSON
///
/// JSON syntax for all Kea servers with loggers is:
/// @code
/// {
/// "name": <name>,
/// "output_options": [ <output options> ],
/// "severity": <severity>,
/// "debuglevel": <debug level>,
/// "user-context": { <json map> },
/// "comment": <comment>
/// }
/// @endcode
///
/// JSON syntax for all Kea server for output options is:
/// @code
/// {
/// "output": <output, e.g. log file name>,
/// "maxver": <maximum file version>,
/// "maxsize": <maxium file size>,
/// "flush": <flush flag>,
/// "pattern": <custom layout>
/// }
/// @endcode
///
/// YANG syntax for loggers is:
/// @code
/// +--rw logger (list)
/// |
/// +--rw name? string
/// +--rw output-option*
/// | +--rw output string
/// | +--rw maxver? uint32
/// | +--rw maxsize? uint32
/// | +--rw flush? boolean
/// | +--rw pattern? string
/// +--rw debuglevel? uint8
/// +--rw severity? enumeration
/// +--rw user-context? string
/// @endcode
///
/// An example in JSON and YANG formats:
/// @code
/// [
/// {
/// "name": "foo",
/// "severity": "WARN",
/// "output_options":
/// [
/// {
/// "output": "/bar",
/// "maxver": 10
/// }
/// ]
/// }
/// ]
/// @endcode
/// @code
/// /kea-dhcp4-server:config (container)
/// /kea-dhcp4-server:config/...
/// /kea-dhcp4-server:config/logger[name='foo'] (list instance)
/// /kea-dhcp4-server:config/logger[name='foo']/name = foo
/// /kea-dhcp4-server:config/logger[name='foo']/
/// option[output='/bar'] (list instance)
/// /kea-dhcp4-server:config/logger[name='foo']/
/// option[output='/bar']/option = /bar
/// /kea-dhcp4-server:config/logger[name='foo']/
/// option[output='/bar']/maxver = 10
/// /kea-dhcp4-server:config/logger[name='foo']/severity = WARN
/// @endcode
/// @brief A translator class for converting a logger between
/// YANG and JSON.
///
/// Currently supports all kea models:
/// - kea-dhcp4-server
/// - kea-dhcp6-server
/// - kea-dhcp-ddns
/// - kea-ctrl-agent
class TranslatorLogger : virtual public TranslatorBasic {
public:
/// @brief Constructor.
///
/// @param session Sysrepo session.
/// @param model Model name.
#ifndef HAVE_PRE_0_7_6_SYSREPO
TranslatorLogger(sysrepo::S_Session session, const std::string& model);
#else
TranslatorLogger(S_Session session, const std::string& model);
#endif
/// @brief Destructor.
virtual ~TranslatorLogger();
/// @brief Get and translate a logger from YANG to JSON.
///
/// @param xpath The xpath of the logger.
/// @return JSON representation of the logger.
/// @throw SysrepoError when sysrepo raises an error.
isc::data::ElementPtr getLogger(const std::string& xpath);
/// @brief Translate and set logger from JSON to YANG.
///
/// @param xpath The xpath of the logger.
/// @param elem The JSON element.
void setLogger(const std::string& xpath, isc::data::ConstElementPtr elem);
protected:
/// @brief Get and translate an output option from YANG to JSON.
///
/// @param xpath The xpath of the output option.
/// @return JSON representation of the output option.
/// @throw SysrepoError when sysrepo raises an error.
isc::data::ElementPtr getOutputOption(const std::string& xpath);
/// @brief Get and translate output options from YANG to JSON.
///
/// @param xpath The xpath of output options.
/// @return JSON representation of output options.
/// @throw SysrepoError when sysrepo raises an error.
isc::data::ElementPtr getOutputOptions(const std::string& xpath);
/// @brief Translate and set an output option from JSON to YANG.
///
/// @param xpath The xpath of the output option.
/// @param elem The JSON element.
void setOutputOption(const std::string& xpath,
isc::data::ConstElementPtr elem);
/// @brief Translate and set output options from JSON to YANG.
///
/// @param xpath The xpath of the output options.
/// @param elem The JSON element.
/// @throw BadValue on an output option without output.
void setOutputOptions(const std::string& xpath,
isc::data::ConstElementPtr elem);
/// @brief getLogger JSON for loggers.
///
/// @param xpath The xpath of the logger.
/// @return JSON representation of the logger.
/// @throw SysrepoError when sysrepo raises an error.
isc::data::ElementPtr getLoggerKea(const std::string& xpath);
/// @brief setLogger for loggers.
///
/// @param xpath The xpath of the logger.
/// @param elem The JSON element.
void setLoggerKea(const std::string& xpath,
isc::data::ConstElementPtr elem);
};
/// @brief A translator class for converting a logger list between
/// YANG and JSON.
///
/// Currently supports all kea servers and agents. Speficic to Kea.
class TranslatorLoggers : virtual public TranslatorLogger {
public:
/// @brief Constructor.
///
/// @param session Sysrepo session.
/// @param model Model name.
#ifndef HAVE_PRE_0_7_6_SYSREPO
TranslatorLoggers(sysrepo::S_Session session, const std::string& model);
#else
TranslatorLoggers(S_Session session, const std::string& model);
#endif
/// @brief Destructor.
virtual ~TranslatorLoggers();
/// @brief Get and translate loggeres from YANG to JSON.
///
/// @param xpath The xpath of loggers.
/// @return JSON representation of loggers.
/// @throw SysrepoError when sysrepo raises an error.
isc::data::ConstElementPtr getLoggers(const std::string& xpath);
/// @brief Translate and set loggeres from JSON to YANG.
///
/// @param xpath The xpath of loggers.
/// @param elem The JSON element.
void setLoggers(const std::string& xpath,
isc::data::ConstElementPtr elem);
protected:
/// @brief getLoggers JSON for loggers.
///
/// @param xpath The xpath of loggers.
/// @return JSON representation of loggers.
/// @throw SysrepoError when sysrepo raises an error.
isc::data::ElementPtr getLoggersKea(const std::string& xpath);
/// @brief setLoggers for loggers.
///
/// @param xpath The xpath of loggers.
/// @param elem The JSON element.
/// @throw BadValue on a logger without name.
void setLoggersKea(const std::string& xpath,
isc::data::ConstElementPtr elem);
};
}; // end of namespace isc::yang
}; // end of namespace isc
#endif // ISC_TRANSLATOR_LOGGER_H
|
