Kea 2.7.0
isc::yang::TranslatorSubnets Class Reference

A translator class for converting a subnet list between YANG and JSON. More...

#include <translator_subnet.h>

+ Inheritance diagram for isc::yang::TranslatorSubnets:

Public Member Functions

 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 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.
 

Detailed Description

A translator class for converting a subnet list between YANG and JSON.

Currently supports on kea-dhcp[46]-server and partially ietf-dhcpv6-server.

Definition at line 343 of file translator_subnet.h.

Constructor & Destructor Documentation

◆ TranslatorSubnets()

isc::yang::TranslatorSubnets::TranslatorSubnets ( sysrepo::Session session,
const std::string & model )

Constructor.

Parameters
sessionSysrepo session.
modelModel name.

Definition at line 336 of file translator_subnet.cc.

◆ ~TranslatorSubnets()

virtual isc::yang::TranslatorSubnets::~TranslatorSubnets ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getSubnets()

ElementPtr isc::yang::TranslatorSubnets::getSubnets ( libyang::DataNode const & data_node)

Get and translate subnets from YANG to JSON.

Parameters
data_nodethe YANG node representing the list of subnets
Returns
the JSON representation of the list of subnets
Exceptions
NetconfErrorwhen sysrepo raises an error.

Definition at line 350 of file translator_subnet.cc.

References getSubnetsCommon(), isc_throw, isc::yang::Translator::model_, and isc::Exception::what().

Referenced by isc::yang::TranslatorConfig::getConfigIetf6(), isc::yang::TranslatorConfig::getServerKeaDhcp4(), isc::yang::TranslatorConfig::getServerKeaDhcp6(), isc::yang::TranslatorSharedNetwork::getSharedNetworkKea(), and getSubnetsFromAbsoluteXpath().

+ Here is the call graph for this function:

◆ getSubnetsCommon()

ElementPtr isc::yang::TranslatorSubnets::getSubnetsCommon ( libyang::DataNode const & data_node,
const std::string & subsel )
protected

getSubnets common part.

Parameters
data_nodethe YANG node representing the list of subnets
subselThe subnet list name.
Returns
the JSON representation of the list of subnets

Definition at line 378 of file translator_subnet.cc.

References isc::yang::TranslatorSubnet::getSubnet().

Referenced by getSubnets().

+ Here is the call graph for this function:

◆ getSubnetsFromAbsoluteXpath()

ElementPtr isc::yang::TranslatorSubnets::getSubnetsFromAbsoluteXpath ( std::string const & xpath)

Get and translate subnets from YANG to JSON.

Parameters
xpathThe xpath of the subnet list.
Returns
the JSON representation of the list of subnets
Exceptions
NetconfErrorwhen sysrepo raises an error.

Definition at line 369 of file translator_subnet.cc.

References isc::yang::Translator::findXPath(), and getSubnets().

+ Here is the call graph for this function:

◆ setSubnets()

void isc::yang::TranslatorSubnets::setSubnets ( const std::string & xpath,
isc::data::ConstElementPtr elem )

Translate and set subnets from JSON to YANG.

Parameters
xpathThe xpath of the subnet list.
elemThe JSON element.
Exceptions
BadValueon a subnet without id.

Definition at line 385 of file translator_subnet.cc.

References isc_throw, isc::yang::Translator::model_, setSubnetsIetf6(), setSubnetsKea(), and isc::Exception::what().

Referenced by isc::yang::TranslatorConfig::setConfigIetf6(), isc::yang::TranslatorConfig::setServerKeaDhcp4(), isc::yang::TranslatorConfig::setServerKeaDhcp6(), and isc::yang::TranslatorSharedNetwork::setSharedNetworkKea().

+ Here is the call graph for this function:

◆ setSubnetsIetf6()

void isc::yang::TranslatorSubnets::setSubnetsIetf6 ( const std::string & xpath,
isc::data::ConstElementPtr elem )
protected

setSubnets for ietf-dhcpv6-server.

Parameters
xpathThe xpath of the subnet list.
elemThe JSON element.

Definition at line 405 of file translator_subnet.cc.

References isc_throw, and isc::yang::TranslatorSubnet::setSubnet().

Referenced by setSubnets().

+ Here is the call graph for this function:

◆ setSubnetsKea()

void isc::yang::TranslatorSubnets::setSubnetsKea ( const std::string & xpath,
isc::data::ConstElementPtr elem,
const std::string & subsel )
protected

setSubnets for kea-dhcp[46]-server.

Parameters
xpathThe xpath of the subnet list.
elemThe JSON element.
subselThe subnet list name.

Definition at line 420 of file translator_subnet.cc.

References isc_throw, and isc::yang::TranslatorSubnet::setSubnet().

Referenced by setSubnets().

+ Here is the call graph for this function:

The documentation for this class was generated from the following files: