A translator class for converting pools between YANG and JSON. More...

#include <translator_pool.h>

Inheritance diagram for isc::yang::TranslatorPools:

Public Member Functions
	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.

Protected Member Functions
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].

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 pools between YANG and JSON.

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

Definition at line 208 of file translator_pool.h.

Constructor & Destructor Documentation

◆ TranslatorPools()

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

Constructor.

Parameters

session	Sysrepo session.
model	Model name.

Definition at line 235 of file translator_pool.cc.

◆ ~TranslatorPools()

virtual isc::yang::TranslatorPools::~TranslatorPools ( )

virtualdefault

Destructor.

Member Function Documentation

◆ getPools()

ElementPtr isc::yang::TranslatorPools::getPools ( libyang::DataNode const & data_node )

Translate pools from YANG to JSON.

Parameters

data_node the YANG node representing the list of pools

Returns: the JSON representation of the list of pools

Exceptions

NetconfError when sysrepo raises an error.

Definition at line 243 of file translator_pool.cc.

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

Referenced by getPoolsFromAbsoluteXpath(), isc::yang::TranslatorSubnet::getSubnetIetf6(), and isc::yang::TranslatorSubnet::getSubnetKea().

Here is the call graph for this function:

◆ getPoolsFromAbsoluteXpath()

ElementPtr isc::yang::TranslatorPools::getPoolsFromAbsoluteXpath ( std::string const & xpath )

Translate pools from YANG to JSON.

Parameters

xpath The xpath of the pool list.

Returns: the JSON representation of the list of pools

Exceptions

NetconfError when sysrepo raises an error.

Definition at line 261 of file translator_pool.cc.

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

Here is the call graph for this function:

◆ getPoolsIetf()

ElementPtr isc::yang::TranslatorPools::getPoolsIetf ( libyang::DataNode const & data_node )

protected

getPools for ietf-dhcpv6-server.

Parameters

data_node the YANG node representing the list of pools

Returns: the JSON representation of the list of pools

Definition at line 270 of file translator_pool.cc.

References isc::yang::TranslatorPool::getPool().

Referenced by getPools().

Here is the call graph for this function:

◆ getPoolsKea()

ElementPtr isc::yang::TranslatorPools::getPoolsKea ( libyang::DataNode const & data_node )

protected

getPools for kea-dhcp[46]-server.

Parameters

data_node the YANG node representing the list of pools

Returns: the JSON representation of the list of pools

Definition at line 276 of file translator_pool.cc.

References isc::yang::TranslatorPool::getPool().

Referenced by getPools().

Here is the call graph for this function:

◆ setPools()

void isc::yang::TranslatorPools::setPools	(	const std::string &	xpath,
		isc::data::ConstElementPtr	elem )

Translate and set (address) pools from JSON to YANG.

Parameters

xpath	The xpath of the pool list.
elem	The JSON element.

Definition at line 282 of file translator_pool.cc.

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

Referenced by isc::yang::TranslatorSubnet::setSubnetIetf6(), and isc::yang::TranslatorSubnet::setSubnetKea().

Here is the call graph for this function:

◆ setPoolsByAddresses()

void isc::yang::TranslatorPools::setPoolsByAddresses	(	const std::string &	xpath,
		isc::data::ConstElementPtr	elem )

protected

setPools using address pair.

Parameters

xpath	The xpath of the pool list.
elem	The JSON element.

Exceptions

BadValue on a pool without a prefix.

Definition at line 311 of file translator_pool.cc.

References isc::yang::TranslatorPool::getAddresses(), isc_throw, and isc::yang::TranslatorPool::setPool().

Referenced by setPools().

Here is the call graph for this function:

◆ setPoolsById()

void isc::yang::TranslatorPools::setPoolsById	(	const std::string &	xpath,
		isc::data::ConstElementPtr	elem )

protected

setPools using pool-id.

Parameters

xpath	The xpath of the pool list.
elem	The JSON element.

Definition at line 301 of file translator_pool.cc.

References isc::yang::TranslatorPool::setPool().

Referenced by setPools().

Here is the call graph for this function:

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TranslatorPools()

◆ ~TranslatorPools()

Member Function Documentation

◆ getPools()

◆ getPoolsFromAbsoluteXpath()

◆ getPoolsIetf()

◆ getPoolsKea()

◆ setPools()

◆ setPoolsByAddresses()

◆ setPoolsById()