Kea 2.7.0
isc::yang::TranslatorDatabases Class Reference

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

#include <translator_database.h>

+ Inheritance diagram for isc::yang::TranslatorDatabases:

Public Member Functions

 TranslatorDatabases (sysrepo::Session session, const std::string &model)
 Constructor.
 
virtual ~TranslatorDatabases ()=default
 Destructor.
 
isc::data::ElementPtr getDatabases (libyang::DataNode const &data_node, std::string const &xpath)
 Translate database accesses from YANG to JSON.
 
isc::data::ElementPtr getDatabasesFromAbsoluteXpath (std::string const &xpath)
 Translate database accesses from YANG to JSON.
 
void setDatabases (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set database accesses from JSON to YANG.
 
- Public Member Functions inherited from isc::yang::TranslatorDatabase
 TranslatorDatabase (sysrepo::Session session, const std::string &model)
 Constructor.
 
virtual ~TranslatorDatabase ()=default
 Destructor.
 
isc::data::ElementPtr getDatabase (libyang::DataNode const &data_node)
 Translate a database access from YANG to JSON.
 
isc::data::ElementPtr getDatabaseFromAbsoluteXpath (std::string const &xpath)
 Translate a database access from YANG to JSON.
 
void setDatabase (const std::string &xpath, isc::data::ConstElementPtr elem, bool skip=false)
 Translate and set database access 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 getDatabasesKea (libyang::DataNode const &data_node, std::string const &xpath)
 getDatabases JSON for kea-dhcp[46]-server models.
 
void setDatabasesKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setDatabases for kea-dhcp[46]-server models.
 
- Protected Member Functions inherited from isc::yang::TranslatorDatabase
isc::data::ElementPtr getDatabaseKea (libyang::DataNode const &data_node)
 getDatabase JSON for kea-dhcp[46]-server models.
 
void setDatabaseKea (const std::string &xpath, isc::data::ConstElementPtr elem, bool skip)
 setDatabase for kea-dhcp[46]-server models.
 

Additional Inherited Members

- 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 database access list between YANG and JSON.

Supports kea-dhcp[46]-server, does not exist in ietf-dhcpv6-server.

Definition at line 174 of file translator_database.h.

Constructor & Destructor Documentation

◆ TranslatorDatabases()

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

Constructor.

Parameters
sessionSysrepo session.
modelModel name.

Definition at line 140 of file translator_database.cc.

◆ ~TranslatorDatabases()

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

Destructor.

Member Function Documentation

◆ getDatabases()

ElementPtr isc::yang::TranslatorDatabases::getDatabases ( libyang::DataNode const & data_node,
std::string const & xpath )

Translate database accesses from YANG to JSON.

Parameters
data_nodethe YANG node representing the databases
xpaththe xpath of databases relative to {data_node}
Returns
the JSON representation of the list of databases
Exceptions
NetconfErrorwhen sysrepo raises an error.

Definition at line 147 of file translator_database.cc.

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

Referenced by isc::yang::TranslatorConfig::getConfigControlKea(), getDatabasesFromAbsoluteXpath(), and isc::yang::TranslatorConfig::getServerKeaDhcpCommon().

+ Here is the call graph for this function:

◆ getDatabasesFromAbsoluteXpath()

ElementPtr isc::yang::TranslatorDatabases::getDatabasesFromAbsoluteXpath ( std::string const & xpath)

Translate database accesses from YANG to JSON.

Note
This is a computationally expensive operation that makes a lookup in the sysrepo datastore by calling Session::getData(). It should be used sparingly in production code, mainly to get an initial data node to work with. It may be used at will in unit tests. Use getDatabases(libyang::DataNode, std::string) as a scalable alternative.
Parameters
xpathThe xpath of databases including the list name.
Returns
JSON representation of databases.
Exceptions
NetconfErrorwhen sysrepo raises an error.

Definition at line 163 of file translator_database.cc.

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

+ Here is the call graph for this function:

◆ getDatabasesKea()

ElementPtr isc::yang::TranslatorDatabases::getDatabasesKea ( libyang::DataNode const & data_node,
std::string const & xpath )
protected

getDatabases JSON for kea-dhcp[46]-server models.

Parameters
data_nodethe YANG node representing the databases
xpaththe xpath of databases relative to {data_node}
Returns
JSON representation of databases.
Exceptions
NetconfErrorwhen sysrepo raises an error.

Definition at line 172 of file translator_database.cc.

References isc::yang::TranslatorDatabase::getDatabase().

Referenced by getDatabases().

+ Here is the call graph for this function:

◆ setDatabases()

void isc::yang::TranslatorDatabases::setDatabases ( const std::string & xpath,
isc::data::ConstElementPtr elem )

Translate and set database accesses from JSON to YANG.

Null elem argument removes the database list.

Parameters
xpathThe xpath of databases including the list name.
elemThe JSON element.

Definition at line 178 of file translator_database.cc.

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

Referenced by isc::yang::TranslatorConfig::setServerKeaDhcpCommon().

+ Here is the call graph for this function:

◆ setDatabasesKea()

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

setDatabases for kea-dhcp[46]-server models.

Parameters
xpathThe xpath of databases including the list name.
elemThe JSON element.
Exceptions
BadValueon database without type,

Definition at line 196 of file translator_database.cc.

References isc::yang::Translator::deleteItem(), isc_throw, and isc::yang::TranslatorDatabase::setDatabase().

Referenced by setDatabases().

+ Here is the call graph for this function:

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