Kea 2.5.7
isc::yang::TranslatorLoggers Class Reference

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

#include <translator_logger.h>

+ Inheritance diagram for isc::yang::TranslatorLoggers:

Public Member Functions

 TranslatorLoggers (sysrepo::Session session, const std::string &model)
 Constructor.
 
virtual ~TranslatorLoggers ()=default
 Destructor.
 
isc::data::ConstElementPtr getLoggers (libyang::DataNode const &data_node)
 Translate loggers from YANG to JSON.
 
isc::data::ConstElementPtr getLoggersFromAbsoluteXpath (std::string const &xpath)
 Translate loggers from YANG to JSON.
 
void setLoggers (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set loggers from JSON to YANG.
 
- Public Member Functions inherited from isc::yang::TranslatorLogger
 TranslatorLogger (sysrepo::Session session, const std::string &model)
 Constructor.
 
virtual ~TranslatorLogger ()=default
 Destructor.
 
isc::data::ElementPtr getLogger (libyang::DataNode const &data_node)
 Translate a logger from YANG to JSON.
 
void setLogger (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set logger 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 getLoggersKea (libyang::DataNode const &data_node)
 getLoggers JSON for loggers.
 
void setLoggersKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setLoggers for loggers.
 
- Protected Member Functions inherited from isc::yang::TranslatorLogger
isc::data::ElementPtr getLoggerKea (libyang::DataNode const &data_node)
 getLogger JSON for loggers.
 
isc::data::ElementPtr getOutputOption (libyang::DataNode const &data_node)
 Translate an output option from YANG to JSON.
 
isc::data::ElementPtr getOutputOptions (libyang::DataNode const &data_node)
 Translate output options from YANG to JSON.
 
void setLoggerKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setLogger for loggers.
 
void setOutputOption (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set an output option from JSON to YANG.
 
void setOutputOptions (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set output options from JSON to YANG.
 

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

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

Currently supports all kea servers and agents. Specific to Kea.

Definition at line 174 of file translator_logger.h.

Constructor & Destructor Documentation

◆ TranslatorLoggers()

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

Constructor.

Parameters
sessionSysrepo session.
modelModel name.

Definition at line 145 of file translator_logger.cc.

◆ ~TranslatorLoggers()

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

Destructor.

Member Function Documentation

◆ getLoggers()

ConstElementPtr isc::yang::TranslatorLoggers::getLoggers ( libyang::DataNode const &  data_node)

Translate loggers from YANG to JSON.

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

Definition at line 151 of file translator_logger.cc.

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

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

+ Here is the call graph for this function:

◆ getLoggersFromAbsoluteXpath()

ConstElementPtr isc::yang::TranslatorLoggers::getLoggersFromAbsoluteXpath ( std::string const &  xpath)

Translate loggers from YANG to JSON.

Parameters
xpathThe xpath of loggers.
Returns
JSON representation of loggers.
Exceptions
NetconfErrorwhen sysrepo raises an error.

Definition at line 168 of file translator_logger.cc.

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

+ Here is the call graph for this function:

◆ getLoggersKea()

ElementPtr isc::yang::TranslatorLoggers::getLoggersKea ( libyang::DataNode const &  data_node)
protected

getLoggers JSON for loggers.

Parameters
data_nodethe YANG node representing loggers configuration
Returns
JSON representation of loggers.
Exceptions
NetconfErrorwhen sysrepo raises an error.

Definition at line 177 of file translator_logger.cc.

References isc::yang::TranslatorLogger::getLogger().

Referenced by getLoggers().

+ Here is the call graph for this function:

◆ setLoggers()

void isc::yang::TranslatorLoggers::setLoggers ( const std::string &  xpath,
isc::data::ConstElementPtr  elem 
)

Translate and set loggers from JSON to YANG.

Parameters
xpathThe xpath of loggers.
elemThe JSON element.

Definition at line 183 of file translator_logger.cc.

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

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

+ Here is the call graph for this function:

◆ setLoggersKea()

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

setLoggers for loggers.

Parameters
xpathThe xpath of loggers.
elemThe JSON element.
Exceptions
BadValueon a logger without name.

Definition at line 202 of file translator_logger.cc.

References isc_throw, and isc::yang::TranslatorLogger::setLogger().

Referenced by setLoggers().

+ Here is the call graph for this function:

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