Kea  2.3.2-git
netconf_config.h
Go to the documentation of this file.
1 // Copyright (C) 2018-2022 Internet Systems Consortium, Inc. ("ISC")
2 //
3 // This Source Code Form is subject to the terms of the Mozilla Public
4 // License, v. 2.0. If a copy of the MPL was not distributed with this
5 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
6 
7 #ifndef NETCONF_CONFIG_H
8 #define NETCONF_CONFIG_H
9 
10 #include <cc/data.h>
11 #include <cc/cfg_to_element.h>
12 #include <cc/user_context.h>
13 #include <cc/simple_parser.h>
14 #include <http/url.h>
15 #include <exceptions/exceptions.h>
16 
17 #include <boost/foreach.hpp>
18 
19 #include <stdint.h>
20 #include <string>
21 
22 namespace isc {
23 namespace netconf {
24 
65 
72 public:
74  enum Type {
75  UNIX, //< Unix socket.
76  HTTP, //< HTTP socket.
77  STDOUT //< standard output.
78  };
79 
85  CfgControlSocket(Type type, const std::string& name,
86  const isc::http::Url& url);
87 
89  virtual ~CfgControlSocket() = default;
90 
94  Type getType() const {
95  return (type_);
96  }
97 
101  const std::string getName() const {
102  return (name_);
103  }
104 
108  const isc::http::Url getUrl() const {
109  return (url_);
110  }
111 
119  static Type stringToType(const std::string& type);
120 
125  static const std::string typeToString(CfgControlSocket::Type type);
126 
130  virtual isc::data::ElementPtr toElement() const;
131 
132 private:
134  Type type_;
135 
137  const std::string name_;
138 
140  const isc::http::Url url_;
141 };
142 
144 typedef boost::shared_ptr<CfgControlSocket> CfgControlSocketPtr;
145 
151 public:
156  CfgServer(const std::string& model, CfgControlSocketPtr ctrl_sock);
157 
159  virtual ~CfgServer() = default;
160 
164  const std::string getModel() const {
165  return (model_);
166  }
167 
171  const CfgControlSocketPtr& getCfgControlSocket() const {
172  return (control_socket_);
173  }
174 
178  bool getBootUpdate() const {
179  return (boot_update_);
180  }
181 
185  void setBootUpdate(bool boot_update) {
186  boot_update_ = boot_update;
187  }
188 
192  bool getSubscribeChanges() const {
193  return (subscribe_changes_);
194  }
195 
200  return (subscribe_notifications_);
201  }
202 
206  void setSubscribeChanges(bool subscribe_changes) {
207  subscribe_changes_ = subscribe_changes;
208  }
209 
213  void setSubscribeNotifications(bool subscribe_notifications) {
214  subscribe_notifications_ = subscribe_notifications;
215  }
216 
220  bool getValidateChanges() const {
221  return (validate_changes_);
222  }
223 
227  void setValidateChanges(bool validate_changes) {
228  validate_changes_ = validate_changes;
229  }
230 
232  std::string toText() const;
233 
237  virtual isc::data::ElementPtr toElement() const;
238 
239 private:
241  const std::string model_;
242 
247  bool boot_update_;
248 
253  bool subscribe_changes_;
254 
260  bool subscribe_notifications_;
261 
266  bool validate_changes_;
267 
269  CfgControlSocketPtr control_socket_;
270 };
271 
273 typedef boost::shared_ptr<CfgServer> CfgServerPtr;
274 
276 typedef std::map<std::string, CfgServerPtr> CfgServersMap;
277 
279 typedef std::pair<std::string, CfgServerPtr> CfgServersMapPair;
280 
282 typedef boost::shared_ptr<CfgServersMap> CfgServersMapPtr;
283 
288 std::ostream& operator<<(std::ostream& os, const CfgServer& server);
289 
295 public:
305  CfgControlSocketPtr parse(data::ConstElementPtr ctrl_sock_config);
306 };
307 
313 public:
322  CfgServerPtr parse(data::ConstElementPtr server_config);
323 };
324 
325 } // namespace netconf
326 } // namespace isc
327 
328 #endif // NETCONF_CONFIG_H
bool getSubscribeNotifications() const
Getter which returns the subscribe-changes flag.
static const std::string typeToString(CfgControlSocket::Type type)
Converts CfgControlSocket::Type to string.
const isc::http::Url getUrl() const
Getter which returns the HTTP server URL.
Parser for CfgControlSocket.
Base class for user context.
Definition: user_context.h:22
std::pair< std::string, CfgServerPtr > CfgServersMapPair
Defines a iterator pairing of name and CfgServer.
boost::shared_ptr< Element > ElementPtr
Definition: data.h:24
boost::shared_ptr< CfgServer > CfgServerPtr
Defines a pointer for CfgServer instances.
static Type stringToType(const std::string &type)
Converts socket type name to CfgControlSocket::Type.
bool getSubscribeChanges() const
Getter which returns the subscribe-changes flag.
virtual ~CfgControlSocket()=default
Destructor (doing nothing).
std::map< std::string, CfgServerPtr > CfgServersMap
Defines a map of CfgServers, keyed by the name.
Represents an URL.
Definition: url.h:20
const std::string getName() const
Getter which returns the Unix socket name.
const CfgControlSocketPtr & getCfgControlSocket() const
Getter which returns the control socket.
virtual isc::data::ElementPtr toElement() const
Unparse a configuration object.
Abstract class for configuration Cfg_* classes.
boost::shared_ptr< const Element > ConstElementPtr
Definition: data.h:27
const std::string getModel() const
Getter which returns the model name.
Type
Defines the list of possible control socket types.
Defines the logger used by the top-level component of kea-lfc.
void setBootUpdate(bool boot_update)
Set the boot-update flag.
void setSubscribeChanges(bool subscribe_changes)
Set the subscribe-changes flag.
CfgControlSocket(Type type, const std::string &name, const isc::http::Url &url)
Constructor.
Represents a Control Socket.
Type getType() const
Getter which returns the socket type.
bool getBootUpdate() const
Getter which returns the boot-update flag.
Represents a Managed CfgServer.
ostream & operator<<(ostream &os, const CfgServer &server)
Dumps the contents of a CfgServer as text to a output stream.
boost::shared_ptr< CfgControlSocket > CfgControlSocketPtr
Defines a pointer for CfgControlSocket instances.
void setSubscribeNotifications(bool subscribe_notifications)
Set the subscribe-notifications flag.
bool getValidateChanges() const
Getter which returns the validate-changes flag.
void setValidateChanges(bool validate_changes)
Set the validate-changes flag.
boost::shared_ptr< CfgServersMap > CfgServersMapPtr
Defines a pointer to map of CfgServers.