Kea 2.5.7
isc::yang::TranslatorOptionDefList Class Reference

Currently supports kea-dhcp[46]-server models. More...

#include <translator_option_def.h>

+ Inheritance diagram for isc::yang::TranslatorOptionDefList:

Public Member Functions

 TranslatorOptionDefList (sysrepo::Session session, const std::string &model)
 Constructor.
 
virtual ~TranslatorOptionDefList ()=default
 Destructor.
 
isc::data::ConstElementPtr getOptionDefList (libyang::DataNode const &data_node)
 Translate option definition list from YANG to JSON.
 
isc::data::ConstElementPtr getOptionDefListFromAbsoluteXpath (std::string const &xpath)
 Translate option definition list from YANG to JSON.
 
void setOptionDefList (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set option definition list from JSON to YANG.
 
- Public Member Functions inherited from isc::yang::TranslatorOptionDef
 TranslatorOptionDef (sysrepo::Session session, const std::string &model)
 Constructor.
 
virtual ~TranslatorOptionDef ()=default
 Destructor.
 
isc::data::ElementPtr getOptionDef (libyang::DataNode const &data_node)
 Translate an option definition from YANG to JSON.
 
isc::data::ElementPtr getOptionDefFromAbsoluteXpath (std::string const &xpath)
 Translate an option definition from YANG to JSON.
 
void setOptionDef (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set option definition 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::ConstElementPtr getOptionDefListKea (libyang::DataNode const &data_node)
 getOptionDefList implementation specific to kea-dhcp[46]-server models.
 
void setOptionDefListKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setOptionDefList implementation specific to kea-dhcp[46]-server models.
 
- Protected Member Functions inherited from isc::yang::TranslatorOptionDef
isc::data::ElementPtr getOptionDefKea (libyang::DataNode const &data_node)
 getOptionDef implementation specific to kea-dhcp[46]-server models.
 
void setOptionDefKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setOptionDef implementation specific to 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 = std::unordered_map< libyang::LeafBaseType, std::function< isc::data::ElementPtr const (std::string const &)> >
 Maps YANG types to functions that transform a YANG type into an ElementPtr.
 
using Serializer = std::unordered_map< libyang::LeafBaseType, std::function< std::string const (std::string const &)> >
 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

Currently supports kea-dhcp[46]-server models.

Todo:
: Support for ietf-dhcpv6-server model.

Definition at line 139 of file translator_option_def.h.

Constructor & Destructor Documentation

◆ TranslatorOptionDefList()

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

Constructor.

Parameters
sessionSysrepo session.
modelModel name.

Definition at line 107 of file translator_option_def.cc.

◆ ~TranslatorOptionDefList()

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

Destructor.

Member Function Documentation

◆ getOptionDefList()

ConstElementPtr isc::yang::TranslatorOptionDefList::getOptionDefList ( libyang::DataNode const &  data_node)

Translate option definition list from YANG to JSON.

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

Definition at line 114 of file translator_option_def.cc.

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

Referenced by isc::yang::TranslatorClass::getClassKea(), getOptionDefListFromAbsoluteXpath(), and isc::yang::TranslatorConfig::getServerKeaDhcpCommon().

+ Here is the call graph for this function:

◆ getOptionDefListFromAbsoluteXpath()

ConstElementPtr isc::yang::TranslatorOptionDefList::getOptionDefListFromAbsoluteXpath ( std::string const &  xpath)

Translate option definition list from YANG to JSON.

Parameters
xpathThe xpath of the option definition list.
Returns
JSON representation of the list of option definitions
Exceptions
NetconfErrorwhen sysrepo raises an error.

Definition at line 130 of file translator_option_def.cc.

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

+ Here is the call graph for this function:

◆ getOptionDefListKea()

ConstElementPtr isc::yang::TranslatorOptionDefList::getOptionDefListKea ( libyang::DataNode const &  data_node)
protected

getOptionDefList implementation specific to kea-dhcp[46]-server models.

Parameters
data_nodethe YANG node representing the list of option definitions
Exceptions
NetconfErrorwhen sysrepo raises an error.

Definition at line 139 of file translator_option_def.cc.

References isc::yang::TranslatorOptionDef::getOptionDef().

Referenced by getOptionDefList().

+ Here is the call graph for this function:

◆ setOptionDefList()

void isc::yang::TranslatorOptionDefList::setOptionDefList ( const std::string &  xpath,
isc::data::ConstElementPtr  elem 
)

Translate and set option definition list from JSON to YANG.

Parameters
xpathThe xpath of the option definition list.
elemThe JSON element.

Definition at line 145 of file translator_option_def.cc.

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

Referenced by isc::yang::TranslatorClass::setClassKea(), and isc::yang::TranslatorConfig::setServerKeaDhcpCommon().

+ Here is the call graph for this function:

◆ setOptionDefListKea()

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

setOptionDefList implementation specific to kea-dhcp[46]-server models.

Parameters
xpathThe xpath of the option definition list.
elemThe JSON element.
Exceptions
BadValueon option definition without code or space.

Definition at line 164 of file translator_option_def.cc.

References isc_throw, and isc::yang::TranslatorOptionDef::setOptionDef().

Referenced by setOptionDefList().

+ Here is the call graph for this function:

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