Kea 2.5.7
isc::yang::TranslatorControlSocket Class Reference

Control socket translation between YANG and JSON. More...

#include <translator_control_socket.h>

+ Inheritance diagram for isc::yang::TranslatorControlSocket:

Public Member Functions

 TranslatorControlSocket (sysrepo::Session session, const std::string &model)
 Constructor.
 
virtual ~TranslatorControlSocket ()=default
 Destructor.
 
isc::data::ElementPtr getControlSocket (libyang::DataNode const &data_node)
 Translate a control socket from YANG to JSON.
 
isc::data::ElementPtr getControlSocketFromAbsoluteXpath (std::string const &xpath)
 Translate a control socket from YANG to JSON.
 
void setControlSocket (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set control socket 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 getControlSocketKea (libyang::DataNode const &data_node)
 getControlSocket JSON for kea models.
 
void setControlSocketKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setControlSocket for kea 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

Control socket translation between YANG and JSON.

JSON syntax for all Kea servers with command channel is:

"control-socket": {
"socket-type": "<socket type>",
"socket-name": "<socket name>",
"user-context": { <json map> },
"comment": "<comment>"
}

YANG syntax is:

+--rw control-socket!
+--rw socket-name string
+--rw socket-type enumeration
+--rw user-context? user-context

An example in JSON and YANG formats:

{
"socket-name": "/tmp/kea.sock",
"socket-type": "unix",
"user-context": { "foo": 1 }
}
/kea-ctrl-agent:config (container)
/kea-ctrl-agent:config/control-sockets (container)
/kea-ctrl-agent:config/control-sockets/
socket[server-type='dhcp4'] (list instance)
/kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
server-type = dhcp4
/kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
control-socket (container)
/kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
control-socket/socket-name = /tmp/kea.sock
/kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
control-socket/socket-type = unix
/kea-ctrl-agent:config/control-sockets/socket[server-type='dhcp4']/
control-socket/user-context = { \"foo\": 1 }

A translator class for converting a control socket between YANG and JSON.

Supports the following models:

  • kea-dhcp4-server
  • kea-dhcp6-server
  • kea-dhcp-ddns
  • kea-ctrl-agent

Definition at line 68 of file translator_control_socket.h.

Constructor & Destructor Documentation

◆ TranslatorControlSocket()

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

Constructor.

Parameters
sessionSysrepo session.
modelModel name.

Definition at line 22 of file translator_control_socket.cc.

◆ ~TranslatorControlSocket()

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

Destructor.

Member Function Documentation

◆ getControlSocket()

ElementPtr isc::yang::TranslatorControlSocket::getControlSocket ( libyang::DataNode const &  data_node)

Translate a control socket from YANG to JSON.

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

Definition at line 28 of file translator_control_socket.cc.

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

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

+ Here is the call graph for this function:

◆ getControlSocketFromAbsoluteXpath()

ElementPtr isc::yang::TranslatorControlSocket::getControlSocketFromAbsoluteXpath ( std::string const &  xpath)

Translate a control socket 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 getControlSocket(libyang::DataNode) as a scalable alternative.
Parameters
xpathThe xpath of the control socket.
Returns
JSON representation of the control socket
Exceptions
NetconfErrorwhen sysrepo raises an error.

Definition at line 54 of file translator_control_socket.cc.

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

+ Here is the call graph for this function:

◆ getControlSocketKea()

ElementPtr isc::yang::TranslatorControlSocket::getControlSocketKea ( libyang::DataNode const &  data_node)
protected

getControlSocket JSON for kea models.

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

Definition at line 45 of file translator_control_socket.cc.

References isc::yang::Translator::checkAndGetAndJsonifyLeaf(), isc::data::Element::createMap(), and isc::yang::Translator::getMandatoryLeaf().

Referenced by getControlSocket().

+ Here is the call graph for this function:

◆ setControlSocket()

void isc::yang::TranslatorControlSocket::setControlSocket ( const std::string &  xpath,
isc::data::ConstElementPtr  elem 
)

Translate and set control socket from JSON to YANG.

Parameters
xpathThe xpath of the control socket.
elemThe JSON element.

Definition at line 63 of file translator_control_socket.cc.

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

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

+ Here is the call graph for this function:

◆ setControlSocketKea()

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

setControlSocket for kea models.

Null elem argument removes the container. Required parameters passed in elem are: socket-name, socket-type. Optional parameters are: user-context.

Parameters
xpathThe xpath of the control socket.
elemThe JSON element.
Exceptions
BadValueon control socket without socket type or name.

Definition at line 84 of file translator_control_socket.cc.

References isc::yang::Translator::checkAndSetUserContext(), isc::yang::Translator::deleteItem(), and isc::yang::Translator::setMandatoryLeaf().

Referenced by setControlSocket().

+ Here is the call graph for this function:

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