Adding upstream version 2.5.7.upstream/2.5.7upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 198 insertions, 0 deletions

diff --git a/src/lib/yang/translator_option_def.h b/src/lib/yang/translator_option_def.h
new file mode 100644
index 0000000..b36ba47
--- /dev/null
+++ b/src/lib/yang/translator_option_def.h
@@ -0,0 +1,198 @@
+// Copyright (C) 2018-2022 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_OPTION_DEF_H
+#define ISC_TRANSLATOR_OPTION_DEF_H 1
+
+#include <yang/translator.h>
+
+namespace isc {
+namespace yang {
+
+/// @brief Option definition translation between YANG and JSON
+///
+/// JSON syntax for Kea DHCP servers is:
+/// @code
+/// {
+///     "code": <code>,
+///     "name": <name>,
+///     "space": <space>,
+///     "type": <type>,
+///     "array": <array flag>,
+///     "encapsulate": <encapsulated space>,
+///     "record-types": <record types>,
+///     "user-context": { <json map> },
+///     "comment": "<comment>"
+/// }
+/// @endcode
+///
+/// YANG syntax for kea-dhcp[46] with code and space as keys is:
+/// @code
+/// +--rw option-def* [code space]
+///    +--rw code            uint8
+///    +--rw space           string
+///    +--rw name            string
+///    +--rw type            string
+///    +--rw record-types?   string
+///    +--rw encapsulate?    string
+///    +--rw array?          boolean
+///    +--rw user-context?   user-context
+/// @endcode
+///
+/// An example in JSON and YANG formats:
+/// @code
+/// [
+///     {
+///         "code": 100,
+///         "name": "foo",
+///         "space": "isc",
+///         "type": "string",
+///         "array": false
+///     }
+/// ]
+/// @endcode
+/// @code
+///  /kea-dhcp6-server:config (container)
+///  /kea-dhcp6-server:config/
+///     option-def[code='100'][space='isc'] (list instance)
+///  /kea-dhcp6-server:config/
+///     option-def[code='100'][space='isc']/code = 100
+///  /kea-dhcp6-server:config/
+///     option-def[code='100'][space='isc']/space = isc
+///  /kea-dhcp6-server:config/
+///     option-def[code='100'][space='isc']/name = foo
+///  /kea-dhcp6-server:config/
+///     option-def[code='100'][space='isc']/type = string
+///  /kea-dhcp6-server:config/
+///     option-def[code='100'][space='isc']/array = false
+/// @endcode
+
+/// @brief A translator class for converting an option definition between
+/// YANG and JSON.
+///
+/// Currently supports kea-dhcp[46]-server models.
+/// @todo: Support for ietf-dhcpv6-server model.
+class TranslatorOptionDef : virtual public Translator {
+public:
+    /// @brief Constructor.
+    ///
+    /// @param session Sysrepo session.
+    /// @param model Model name.
+    TranslatorOptionDef(sysrepo::Session session, const std::string& model);
+
+    /// @brief Destructor.
+    virtual ~TranslatorOptionDef() = default;
+
+    /// @brief Translate an option definition from YANG to JSON.
+    ///
+    /// @param data_node the YANG node representing the option definition
+    ///
+    /// @return the JSON representation of the option definition
+    ///
+    /// @throw NetconfError when sysrepo raises an error.
+    isc::data::ElementPtr getOptionDef(libyang::DataNode const& data_node);
+
+    /// @brief Translate an option definition from YANG to JSON.
+    ///
+    /// @param xpath The xpath of the option definition.
+    ///
+    /// @return JSON representation of the option definition.
+    ///
+    /// @throw NetconfError when sysrepo raises an error.
+    isc::data::ElementPtr getOptionDefFromAbsoluteXpath(std::string const& xpath);
+
+    /// @brief Translate and set option definition from JSON to YANG.
+    ///
+    /// @param xpath The xpath of the option definition..
+    /// @param elem The JSON element.
+    void setOptionDef(const std::string& xpath,
+                      isc::data::ConstElementPtr elem);
+
+protected:
+    /// @brief getOptionDef implementation specific to kea-dhcp[46]-server models.
+    ///
+    /// @param data_node the YANG node representing the option definition
+    ///
+    /// @return JSON representation of the option definition.
+    ///
+    /// @throw NetconfError when sysrepo raises an error.
+    /// @throw BadValue on option definition without name or type.
+    isc::data::ElementPtr getOptionDefKea(libyang::DataNode const& data_node);
+
+    /// @brief setOptionDef implementation specific to kea-dhcp[46]-server models.
+    ///
+    /// @param xpath The xpath of the option definition.
+    /// @param elem The JSON element.
+    /// @throw BadValue on option definition without name or type.
+    void setOptionDefKea(const std::string& xpath,
+                         isc::data::ConstElementPtr elem);
+};  // TranslatorOptionDef
+
+// @brief A translator class for converting an option definition list
+// between YANG and JSON.
+//
+/// Currently supports kea-dhcp[46]-server models.
+/// @todo: Support for ietf-dhcpv6-server model.
+class TranslatorOptionDefList : virtual public TranslatorOptionDef {
+public:
+    /// @brief Constructor.
+    ///
+    /// @param session Sysrepo session.
+    /// @param model Model name.
+    TranslatorOptionDefList(sysrepo::Session session,
+                            const std::string& model);
+
+    /// @brief Destructor.
+    virtual ~TranslatorOptionDefList() = default;
+
+    /// @brief Translate option definition list from YANG to JSON.
+    ///
+    /// @param data_node the YANG node representing the list of option definitions
+    ///
+    /// @return the JSON representation of the list of option definitions
+    ///
+    /// @throw NetconfError when sysrepo raises an error.
+    isc::data::ConstElementPtr getOptionDefList(libyang::DataNode const& data_node);
+
+    /// @brief Translate option definition list from YANG to JSON.
+    ///
+    /// @param xpath The xpath of the option definition list.
+    ///
+    /// @return JSON representation of the list of option definitions
+    ///
+    /// @throw NetconfError when sysrepo raises an error.
+    isc::data::ConstElementPtr getOptionDefListFromAbsoluteXpath(std::string const& xpath);
+
+    /// @brief Translate and set option definition list from JSON to YANG.
+    ///
+    /// @param xpath The xpath of the option definition list.
+    /// @param elem The JSON element.
+    void setOptionDefList(const std::string& xpath,
+                          isc::data::ConstElementPtr elem);
+
+protected:
+    /// @brief getOptionDefList implementation specific to kea-dhcp[46]-server
+    ///        models.
+    ///
+    /// @param data_node the YANG node representing the list of option definitions
+    ///
+    /// @throw NetconfError when sysrepo raises an error.
+    isc::data::ConstElementPtr getOptionDefListKea(libyang::DataNode const& data_node);
+
+    /// @brief setOptionDefList implementation specific to kea-dhcp[46]-server
+    ///        models.
+    ///
+    /// @param xpath The xpath of the option definition list.
+    /// @param elem The JSON element.
+    /// @throw BadValue on option definition without code or space.
+    void setOptionDefListKea(const std::string& xpath,
+                             isc::data::ConstElementPtr elem);
+};  // TranslatorOptionDefList
+
+}  // namespace yang
+}  // namespace isc
+
+#endif  // ISC_TRANSLATOR_OPTION_DEF_H