|  | Kea 3.1.0
    | 
Shared network translation between YANG and JSON. More...
#include <translator_shared_network.h>
| Public Member Functions | |
| TranslatorSharedNetwork (sysrepo::Session session, const std::string &model) | |
| Constructor. | |
| virtual | ~TranslatorSharedNetwork ()=default | 
| Destructor. | |
| isc::data::ElementPtr | getSharedNetwork (libyang::DataNode const &data_node) | 
| Translate a shared network from YANG to JSON. | |
| isc::data::ElementPtr | getSharedNetworkFromAbsoluteXpath (std::string const &xpath) | 
| Translate a shared network from YANG to JSON. | |
| void | setSharedNetwork (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| Translate and set shared network from JSON to YANG. | |
| Public Member Functions inherited from isc::yang::TranslatorSubnets | |
| TranslatorSubnets (sysrepo::Session session, const std::string &model) | |
| Constructor. | |
| virtual | ~TranslatorSubnets ()=default | 
| Destructor. | |
| isc::data::ElementPtr | getSubnets (libyang::DataNode const &data_node) | 
| Get and translate subnets from YANG to JSON. | |
| isc::data::ElementPtr | getSubnetsFromAbsoluteXpath (std::string const &xpath) | 
| Get and translate subnets from YANG to JSON. | |
| void | setSubnets (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| Translate and set subnets from JSON to YANG. | |
| Public Member Functions inherited from isc::yang::TranslatorSubnet | |
| TranslatorSubnet (sysrepo::Session session, const std::string &model) | |
| Constructor. | |
| virtual | ~TranslatorSubnet ()=default | 
| Destructor. | |
| isc::data::ElementPtr | getSubnet (libyang::DataNode const &data_node) | 
| Get and translate a subnet from YANG to JSON. | |
| isc::data::ElementPtr | getSubnetFromAbsoluteXpath (std::string const &xpath) | 
| Get and translate a subnet from YANG to JSON. | |
| void | setSubnet (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| Translate and set subnet from JSON to YANG. | |
| Public Member Functions inherited from isc::yang::TranslatorPools | |
| TranslatorPools (sysrepo::Session session, const std::string &model) | |
| Constructor. | |
| virtual | ~TranslatorPools ()=default | 
| Destructor. | |
| isc::data::ElementPtr | getPools (libyang::DataNode const &data_node) | 
| Translate pools from YANG to JSON. | |
| isc::data::ElementPtr | getPoolsFromAbsoluteXpath (std::string const &xpath) | 
| Translate pools from YANG to JSON. | |
| void | setPools (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| Translate and set (address) pools from JSON to YANG. | |
| Public Member Functions inherited from isc::yang::TranslatorPool | |
| TranslatorPool (sysrepo::Session session, const std::string &model) | |
| Constructor. | |
| virtual | ~TranslatorPool ()=default | 
| Destructor. | |
| isc::data::ElementPtr | getPool (libyang::DataNode const &data_node) | 
| Translate a pool from YANG to JSON. | |
| isc::data::ElementPtr | getPoolFromAbsoluteXpath (std::string const &xpath) | 
| Translate a pool from YANG to JSON. | |
| void | setPool (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| Translate and set (address) pool from JSON to YANG. | |
| Public Member Functions inherited from isc::yang::TranslatorOptionDataList | |
| TranslatorOptionDataList (sysrepo::Session session, const std::string &model) | |
| Constructor. | |
| virtual | ~TranslatorOptionDataList ()=default | 
| Destructor. | |
| isc::data::ConstElementPtr | getOptionDataList (libyang::DataNode const &data_node) | 
| Translate option data list from YANG to JSON. | |
| isc::data::ConstElementPtr | getOptionDataListFromAbsoluteXpath (std::string const &xpath) | 
| Translate option data list from YANG to JSON. | |
| void | setOptionDataList (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| Translate and set option data list from JSON to YANG. | |
| Public Member Functions inherited from isc::yang::TranslatorOptionData | |
| TranslatorOptionData (sysrepo::Session session, const std::string &model) | |
| Constructor. | |
| virtual | ~TranslatorOptionData ()=default | 
| Destructor. | |
| isc::data::ElementPtr | getOptionData (libyang::DataNode const &data_node) | 
| Translate an option data from YANG to JSON. | |
| isc::data::ElementPtr | getOptionDataFromAbsoluteXpath (std::string const &xpath) | 
| Translate an option data from YANG to JSON. | |
| void | setOptionData (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| Translate and set option data from JSON to YANG. | |
| Public Member Functions inherited from isc::yang::Translator | |
| Translator (sysrepo::Session session, const std::string &model) | |
| Constructor. | |
| virtual | ~Translator ()=default | 
| Destructor. | |
| template<typename T> | |
| void | checkAndGet (isc::data::ElementPtr const &storage, libyang::DataNode const &data_node, std::string const &xpath, T translate) const | 
| Calls {translate} for the element found at {xpath} relative to {data_node} and sets the result in {storage} with the {xpath} key. | |
| void | checkAndGetAndJsonifyLeaf (isc::data::ElementPtr &storage, libyang::DataNode const &data_node, const std::string &name) const | 
| Retrieves a child YANG data node identified by name from the given parent YANG container node, converts it from string to JSON and stores it in the specified storage. | |
| template<typename T> | |
| void | checkAndGetDiverging (isc::data::ElementPtr const &storage, libyang::DataNode const &data_node, std::string const &key, std::string const &xpath, T translate) const | 
| Calls {translate} for the element found at {xpath} relative to {data_node} and sets the result in {storage} with the {key} key. | |
| void | checkAndGetDivergingLeaf (isc::data::ElementPtr &storage, libyang::DataNode const &data_node, std::string const &name, std::string const &yang_name) const | 
| Retrieves a child YANG data node identified by name from the given parent YANG container node and stores it in the specified storage. | |
| void | checkAndGetLeaf (isc::data::ElementPtr &storage, libyang::DataNode const &data_node, std::string const &name) const | 
| Retrieves a child YANG data node identified by name from the given parent YANG container node and stores it in the specified storage. | |
| void | checkAndSetDivergingLeaf (isc::data::ConstElementPtr const &from, std::string const &xpath, std::string const &name, std::string const &yang_name, libyang::LeafBaseType const type) | 
| Get an element from given ElementPtr node and set it in sysrepo at given xpath. | |
| void | checkAndSetLeaf (isc::data::ConstElementPtr const &from, std::string const &xpath, std::string const &name, libyang::LeafBaseType const type) | 
| Get an element from given ElementPtr node and set it in sysrepo at given xpath. | |
| void | checkAndSetLeafList (isc::data::ConstElementPtr const &from, std::string const &xpath, std::string const &name, libyang::LeafBaseType const type) | 
| Get an element from given ElementPtr node and set it in sysrepo at given xpath as a leaf-list. | |
| void | checkAndSetUserContext (isc::data::ConstElementPtr const &from, std::string const &xpath) | 
| Get an element from given ElementPtr node and set it in sysrepo at given xpath. | |
| void | checkAndStringifyAndSetLeaf (isc::data::ConstElementPtr const &from, std::string const &xpath, std::string const &name) | 
| Get an element from given ElementPtr node and set it in sysrepo at given xpath. | |
| void | deleteItem (const std::string &xpath) | 
| Delete basic value from YANG. | |
| libyang::DataNode | findXPath (std::string const &xpath) const | 
| Retrieves a YANG data node by xpath. | |
| template<typename functor_t> | |
| void | forAll (std::string const &xpath, functor_t f) const | 
| Run a function for a node and all its children. | |
| std::optional< libyang::DataNode > | getData (std::string const &xpath) const | 
| Get a YANG data node found at the given absolute xpath. | |
| isc::data::ElementPtr | getItem (libyang::DataNode const &data_node, std::string const &xpath) const | 
| Translate a basic value from YANG to JSON for a given xpath that is relative to the given source node. | |
| isc::data::ElementPtr | getItemFromAbsoluteXpath (std::string const &xpath) const | 
| Translate a basic value from YANG to JSON for a given absolute xpath. | |
| template<typename T> | |
| isc::data::ElementPtr | getList (libyang::DataNode const &data_node, std::string const &xpath, T &t, isc::data::ElementPtr(T::*f)(libyang::DataNode const &)) const | 
| Retrieve a list as ElementPtr from sysrepo from a certain xpath. | |
| void | getMandatoryDivergingLeaf (isc::data::ElementPtr &storage, libyang::DataNode const &data_node, std::string const &name, std::string const &yang_name) const | 
| Retrieves a child YANG data node identified by one name from the given parent YANG container node and stores it in the specified storage under a different name. | |
| void | getMandatoryLeaf (isc::data::ElementPtr &storage, libyang::DataNode const &data_node, std::string const &name) const | 
| Retrieves a child YANG data node identified by name from the given parent YANG container node and stores it in the specified storage. | |
| bool | schemaNodeExists (std::string const &xpath) const | 
| Checks whether a YANG node exists in the schema. | |
| void | setItem (const std::string &xpath, isc::data::ConstElementPtr const elem, libyang::LeafBaseType const type) | 
| Translate and set basic value from JSON to YANG. | |
| void | setMandatoryDivergingLeaf (isc::data::ConstElementPtr const &from, std::string const &xpath, std::string const &name, std::string const &yang_name, libyang::LeafBaseType const type) | 
| Get an element from given ElementPtr node and set it in sysrepo at given xpath. | |
| void | setMandatoryLeaf (isc::data::ConstElementPtr const &from, std::string const &xpath, std::string const &name, libyang::LeafBaseType const type) | 
| Get an element from given ElementPtr node and set it in sysrepo at given xpath. | |
| Public Member Functions inherited from isc::yang::TranslatorPdPools | |
| TranslatorPdPools (sysrepo::Session session, const std::string &model) | |
| Constructor. | |
| virtual | ~TranslatorPdPools ()=default | 
| Destructor. | |
| isc::data::ElementPtr | getPdPools (libyang::DataNode const &data_node) | 
| Translate pd-pools from YANG to JSON. | |
| isc::data::ElementPtr | getPdPoolsFromAbsoluteXpath (std::string const &xpath) | 
| Translate pd-pools from YANG to JSON. | |
| void | setPdPools (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| Translate and set pd-pools from JSON to YANG. | |
| Public Member Functions inherited from isc::yang::TranslatorPdPool | |
| TranslatorPdPool (sysrepo::Session session, const std::string &model) | |
| Constructor. | |
| virtual | ~TranslatorPdPool ()=default | 
| Destructor. | |
| isc::data::ElementPtr | getPdPool (libyang::DataNode const &data_node) | 
| Translate a pd-pool from YANG to JSON. | |
| isc::data::ElementPtr | getPdPoolFromAbsoluteXpath (std::string const &xpath) | 
| Translate a pd-pool from YANG to JSON. | |
| void | setPdPool (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| Translate and set pd-pool from JSON to YANG. | |
| Public Member Functions inherited from isc::yang::TranslatorHosts | |
| TranslatorHosts (sysrepo::Session session, const std::string &model) | |
| Constructor. | |
| virtual | ~TranslatorHosts ()=default | 
| Destructor. | |
| isc::data::ElementPtr | getHosts (libyang::DataNode const &data_node) | 
| Translate host reservations from YANG to JSON. | |
| isc::data::ElementPtr | getHostsFromAbsoluteXpath (std::string const &xpath) | 
| Translate host reservations from YANG to JSON. | |
| void | setHosts (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| Translate and set (address) host reservations from JSON to YANG. | |
| Public Member Functions inherited from isc::yang::TranslatorHost | |
| TranslatorHost (sysrepo::Session session, const std::string &model) | |
| Constructor. | |
| virtual | ~TranslatorHost ()=default | 
| Destructor. | |
| isc::data::ElementPtr | getHost (libyang::DataNode const &data_node) | 
| Translate a host reservation from YANG to JSON. | |
| isc::data::ElementPtr | getHostFromAbsoluteXpath (std::string const &xpath) | 
| Translate a host reservation from YANG to JSON. | |
| void | setHost (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| Translate and set host reservation from JSON to YANG. | |
| Protected Member Functions | |
| isc::data::ElementPtr | getSharedNetworkKea (libyang::DataNode const &data_node, const std::string &subsel) | 
| getSharedNetwork for kea-dhcp4-server and kea-dhcp6-server models | |
| void | setSharedNetworkKea (const std::string &xpath, isc::data::ConstElementPtr elem, const std::string &subsel) | 
| setSharedNetwork for kea-dhcp4-server and kea-dhcp6-server models | |
| Protected Member Functions inherited from isc::yang::TranslatorSubnets | |
| isc::data::ElementPtr | getSubnetsCommon (libyang::DataNode const &data_node, const std::string &subsel) | 
| getSubnets common part. | |
| void | setSubnetsIetf6 (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setSubnets for ietf-dhcpv6-server. | |
| void | setSubnetsKea (const std::string &xpath, isc::data::ConstElementPtr elem, const std::string &subsel) | 
| setSubnets for kea-dhcp[46]-server. | |
| Protected Member Functions inherited from isc::yang::TranslatorSubnet | |
| isc::data::ElementPtr | getSubnetIetf6 (libyang::DataNode const &data_node) | 
| getSubnet for ietf-dhcpv6-server. | |
| isc::data::ElementPtr | getSubnetKea (libyang::DataNode const &data_node) | 
| getSubnet for kea-dhcp[46]-server. | |
| void | setSubnetIetf6 (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setSubnet for ietf-dhcpv6-server. | |
| void | setSubnetKea (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setSubnet for kea-dhcp[46]-server. | |
| Protected Member Functions inherited from isc::yang::TranslatorPools | |
| isc::data::ElementPtr | getPoolsIetf (libyang::DataNode const &data_node) | 
| getPools for ietf-dhcpv6-server. | |
| isc::data::ElementPtr | getPoolsKea (libyang::DataNode const &data_node) | 
| getPools for kea-dhcp[46]-server. | |
| void | setPoolsByAddresses (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setPools using address pair. | |
| void | setPoolsById (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setPools using pool-id. | |
| Protected Member Functions inherited from isc::yang::TranslatorPool | |
| isc::data::ElementPtr | getPoolIetf6 (libyang::DataNode const &data_node) | 
| getPool for ietf-dhcpv6-server. | |
| isc::data::ElementPtr | getPoolKea (libyang::DataNode const &data_node) | 
| getPool for kea-dhcp[46]-server. | |
| void | setPoolIetf6 (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setPool for ietf-dhcpv6-server. | |
| void | setPoolKea (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setPool for kea-dhcp[46]-server. | |
| Protected Member Functions inherited from isc::yang::TranslatorOptionDataList | |
| isc::data::ConstElementPtr | getOptionDataListKea (libyang::DataNode const &data_node) | 
| getOptionDataList for kea-dhcp[46]. | |
| void | setOptionDataListKea (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setOptionDataList for kea-dhcp[46]. | |
| Protected Member Functions inherited from isc::yang::TranslatorOptionData | |
| isc::data::ElementPtr | getOptionDataKea (libyang::DataNode const &data_node) | 
| getOptionData JSON for kea-dhcp[46]. | |
| void | setOptionDataKea (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setOptionData for kea-dhcp[46]. | |
| Protected Member Functions inherited from isc::yang::TranslatorPdPools | |
| isc::data::ElementPtr | getPdPoolsCommon (libyang::DataNode const &data_node) | 
| getPdPools common part. | |
| void | setPdPoolsId (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setPdPools using pool-id. | |
| void | setPdPoolsPrefix (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setPdPools using prefix. | |
| Protected Member Functions inherited from isc::yang::TranslatorPdPool | |
| isc::data::ElementPtr | getPdPoolIetf6 (libyang::DataNode const &data_node) | 
| getPdPool for ietf-dhcpv6-server. | |
| isc::data::ElementPtr | getPdPoolKea (libyang::DataNode const &data_node) | 
| getPdPool for kea-dhcp6-server. | |
| void | setPdPoolIetf6 (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setPdPool for ietf-dhcpv6-server. | |
| void | setPdPoolKea (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setPdPool for kea-dhcp6-server. | |
| Protected Member Functions inherited from isc::yang::TranslatorHosts | |
| void | setHostsKea (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setHosts for kea-dhcp[46]. | |
| Protected Member Functions inherited from isc::yang::TranslatorHost | |
| isc::data::ElementPtr | getHostKea (libyang::DataNode const &data_node) | 
| getHost for kea-dhcp[46]-server models. | |
| void | setHostKea (const std::string &xpath, isc::data::ConstElementPtr elem) | 
| setHost for kea-dhcp[46]-server models. | |
| Additional Inherited Members | |
| Static Public Member Functions inherited from isc::yang::TranslatorPool | |
| static void | getAddresses (const std::string &prefix, std::string &start_address, std::string &end_address) | 
| Get start and end addresses from prefix. | |
| Static Public Member Functions inherited from isc::yang::Translator | |
| static isc::data::ElementPtr | translateFromYang (std::optional< libyang::DataNode > data_node) | 
| Translate basic value from the given YANG data node to JSON element. | |
| static std::optional< std::string > | translateToYang (isc::data::ConstElementPtr const &elem, libyang::LeafBaseType const type) | 
| Translate basic value from JSON to YANG. | |
| Protected Types inherited from isc::yang::Translator | |
| using | Deserializer | 
| Maps YANG types to functions that transform a YANG type into an ElementPtr. | |
| using | Serializer | 
| Maps YANG types to functions that transform the string representation of an Element into a string that can be passed into Session::setItem(). | |
| Static Protected Member Functions inherited from isc::yang::Translator | |
| static std::string | decode64 (std::string const &input) | 
| Decode a YANG element of binary type to a string that can be stored in an Element::string JSON. | |
| static std::string | encode64 (std::string const &input) | 
| Encode a string such that it can be stored in a YANG element of binary type. | |
| static Deserializer | initializeDeserializer () | 
| Initializes the deserializer which is used to translate a YANG node to an ElementPtr. | |
| static Serializer | initializeSerializer () | 
| Initializes the serializer which is used to translate the string value of an Element to a string that can be passed into Session::setItem(). | |
| Protected Attributes inherited from isc::yang::Translator | |
| std::string | model_ | 
| The model. | |
| sysrepo::Session | session_ | 
| The sysrepo session. | |
Shared network translation between YANG and JSON.
JSON syntax for kea-dhcp4 is:
JSON syntax for kea-dhcp6 is:
YANG syntax for kea-dhcp[46]-server is with name as the list key:
An example in JSON and YANG formats:
A translator class for converting a shared network between YANG and JSON.
Currently supports the following models:
Definition at line 169 of file translator_shared_network.h.
| isc::yang::TranslatorSharedNetwork::TranslatorSharedNetwork | ( | sysrepo::Session | session, | 
| const std::string & | model ) | 
Constructor.
| session | Sysrepo session. | 
| model | Model name. | 
Definition at line 22 of file translator_shared_network.cc.
References isc::yang::TranslatorSubnets::TranslatorSubnets().
Referenced by isc::yang::TranslatorSharedNetworks::TranslatorSharedNetworks().
| 
 | virtualdefault | 
Destructor.
| ElementPtr isc::yang::TranslatorSharedNetwork::getSharedNetwork | ( | libyang::DataNode const & | data_node | ) | 
Translate a shared network from YANG to JSON.
| data_node | the YANG node representing the shared network | 
| NetconfError | when sysrepo raises an error. | 
Definition at line 38 of file translator_shared_network.cc.
References getSharedNetworkKea(), isc_throw, isc::yang::Translator::model_, and isc::Exception::what().
Referenced by getSharedNetworkFromAbsoluteXpath(), and isc::yang::TranslatorSharedNetworks::getSharedNetworks().
| ElementPtr isc::yang::TranslatorSharedNetwork::getSharedNetworkFromAbsoluteXpath | ( | std::string const & | xpath | ) | 
Translate a shared network from YANG to JSON.
| xpath | The xpath of the shared network. | 
| NetconfError | when sysrepo raises an error. | 
Definition at line 55 of file translator_shared_network.cc.
References isc::yang::Translator::findXPath(), and getSharedNetwork().
| 
 | protected | 
getSharedNetwork for kea-dhcp4-server and kea-dhcp6-server models
| data_node | the YANG node representing the shared nework | 
| subsel | The subnet list name (either "subnet4" or "subnet6"). | 
Definition at line 64 of file translator_shared_network.cc.
References isc::yang::Translator::checkAndGet(), isc::yang::Translator::checkAndGetAndJsonifyLeaf(), isc::yang::Translator::checkAndGetLeaf(), Element::createMap(), isc::yang::Translator::getMandatoryLeaf(), isc::yang::TranslatorOptionDataList::getOptionDataList(), and isc::yang::TranslatorSubnets::getSubnets().
Referenced by getSharedNetwork().
| void isc::yang::TranslatorSharedNetwork::setSharedNetwork | ( | const std::string & | xpath, | 
| isc::data::ConstElementPtr | elem ) | 
Translate and set shared network from JSON to YANG.
| xpath | The xpath of the shared network. | 
| elem | The JSON element. | 
Definition at line 145 of file translator_shared_network.cc.
References isc_throw, isc::yang::Translator::model_, setSharedNetworkKea(), and isc::Exception::what().
Referenced by isc::yang::TranslatorSharedNetworks::setSharedNetworksKea().
| 
 | protected | 
setSharedNetwork for kea-dhcp4-server and kea-dhcp6-server models
| xpath | The xpath of the shared network. | 
| elem | The JSON element. | 
| subsel | The subnet list name (either "subnet4" or "subnet6"). | 
Definition at line 165 of file translator_shared_network.cc.
References isc::yang::Translator::checkAndSetLeaf(), isc::yang::Translator::checkAndSetLeafList(), isc::yang::Translator::checkAndSetUserContext(), isc::yang::Translator::setItem(), isc::yang::TranslatorOptionDataList::setOptionDataList(), and isc::yang::TranslatorSubnets::setSubnets().
Referenced by setSharedNetwork().