Kea 2.2.0
isc::yang::TranslatorOptionDef Class Reference

Option definition translation between YANG and JSON. More...

#include <translator_option_def.h>

+ Inheritance diagram for isc::yang::TranslatorOptionDef:

Public Member Functions

 TranslatorOptionDef (sysrepo::S_Session session, const std::string &model)
 Constructor. More...
 
virtual ~TranslatorOptionDef ()
 Destructor. More...
 
isc::data::ElementPtr getOptionDef (const std::string &xpath)
 Get and translate an option definition from YANG to JSON. More...
 
void setOptionDef (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set option definition from JSON to YANG. More...
 
- Public Member Functions inherited from isc::yang::TranslatorBasic
 TranslatorBasic (sysrepo::S_Session session, const std::string &model)
 Constructor. More...
 
virtual ~TranslatorBasic ()
 Destructor. More...
 
void checkAndGetLeaf (isc::data::ElementPtr &storage, const std::string &xpath, const std::string &name)
 Retrieves an item and stores it in the specified storage. More...
 
void checkAndSetLeaf (isc::data::ConstElementPtr const &from, std::string const &xpath, std::string const &name, sr_type_t const type)
 Get an element from given ElementPtr node and set it in sysrepo at given xpath. More...
 
void delItem (const std::string &xpath)
 Delete basic value from YANG. More...
 
template<typename functor_t >
void forAll (std::string const &xpath, functor_t f)
 Run a function for a node and all its children. More...
 
isc::data::ElementPtr getItem (const std::string &xpath)
 Get and translate basic value from YANG to JSON. More...
 
isc::data::ElementPtr getItems (const std::string &xpath)
 Get and translate a list of basic values from YANG to JSON. More...
 
template<typename T >
isc::data::ElementPtr getList (std::string const &xpath, T &t, isc::data::ElementPtr(T::*f)(std::string const &xpath))
 Retrieve a list as ElementPtr from sysrepo from a certain xpath. More...
 
sysrepo::S_Vals getValuesFromItems (std::string const &xpath)
 Get the values of all siblings at a certain xpath. More...
 
void setItem (const std::string &xpath, isc::data::ConstElementPtr elem, sr_type_t type)
 Translate and set basic value from JSON to YANG. More...
 

Protected Member Functions

isc::data::ElementPtr getOptionDefKea (const std::string &xpath)
 getOptionDef implementation specific to kea-dhcp[46]-server models. More...
 
void setOptionDefKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setOptionDef implementation specific to kea-dhcp[46]-server models. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from isc::yang::TranslatorBasic
static sysrepo::S_Val value (isc::data::ConstElementPtr elem, sr_type_t type)
 Translate basic value from JSON to YANG. More...
 
static isc::data::ElementPtr value (sysrepo::S_Val s_val)
 Translate basic value from YANG to JSON. More...
 
- Protected Attributes inherited from isc::yang::TranslatorBasic
std::string model_
 The model. More...
 
sysrepo::S_Session session_
 The sysrepo session. More...
 

Detailed Description

Option definition translation between YANG and JSON.

JSON syntax for Kea DHCP servers is:

{
"code": <code>,
"name": <name>,
"space": <space>,
"type": <type>,
"array": <array flag>,
"encapsulate": <encapsulated space>,
"record-types": <record types>,
"user-context": { <json map> },
"comment": "<comment>"
}

YANG syntax for kea-dhcp[46] with code and space as keys is:

+--rw option-def* [code space]
+--rw code uint8
+--rw space string
+--rw name string
+--rw type string
+--rw record-types? string
+--rw encapsulate? string
+--rw array? boolean
+--rw user-context? user-context

An example in JSON and YANG formats:

[
{
"code": 100,
"name": "foo",
"space": "isc",
"type": "string",
"array": false
}
]
/kea-dhcp6-server:config (container)
/kea-dhcp6-server:config/
option-def[code='100'][space='isc'] (list instance)
/kea-dhcp6-server:config/
option-def[code='100'][space='isc']/code = 100
/kea-dhcp6-server:config/
option-def[code='100'][space='isc']/space = isc
/kea-dhcp6-server:config/
option-def[code='100'][space='isc']/name = foo
/kea-dhcp6-server:config/
option-def[code='100'][space='isc']/type = string
/kea-dhcp6-server:config/
option-def[code='100'][space='isc']/array = false
Defines the logger used by the top-level component of kea-lfc.

A translator class for converting an option definition between YANG and JSON.

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

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

Definition at line 79 of file translator_option_def.h.

Constructor & Destructor Documentation

◆ TranslatorOptionDef()

isc::yang::TranslatorOptionDef::TranslatorOptionDef ( sysrepo::S_Session  session,
const std::string &  model 
)

Constructor.

Parameters
sessionSysrepo session.
modelModel name.

Definition at line 21 of file translator_option_def.cc.

◆ ~TranslatorOptionDef()

isc::yang::TranslatorOptionDef::~TranslatorOptionDef ( )
virtual

Destructor.

Definition at line 26 of file translator_option_def.cc.

Member Function Documentation

◆ getOptionDef()

ElementPtr isc::yang::TranslatorOptionDef::getOptionDef ( const std::string &  xpath)

Get and translate an option definition from YANG to JSON.

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

Definition at line 30 of file translator_option_def.cc.

References getOptionDefKea(), isc_throw, isc::yang::TranslatorBasic::model_, and isc::Exception::what().

Referenced by isc::yang::TranslatorOptionDefList::getOptionDefListKea().

+ Here is the call graph for this function:

◆ getOptionDefKea()

ElementPtr isc::yang::TranslatorOptionDef::getOptionDefKea ( const std::string &  xpath)
protected

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

Parameters
xpathThe xpath of the option definition.
Returns
JSON representation of the option definition.
Exceptions
SysrepoErrorwhen sysrepo raises an error.
BadValueon option definition without name or type.

Definition at line 46 of file translator_option_def.cc.

References isc::yang::TranslatorBasic::getItem(), and isc_throw.

Referenced by getOptionDef().

+ Here is the call graph for this function:

◆ setOptionDef()

void isc::yang::TranslatorOptionDef::setOptionDef ( const std::string &  xpath,
isc::data::ConstElementPtr  elem 
)

Translate and set option definition from JSON to YANG.

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

Definition at line 85 of file translator_option_def.cc.

References isc_throw, isc::yang::TranslatorBasic::model_, setOptionDefKea(), and isc::Exception::what().

Referenced by isc::yang::TranslatorOptionDefList::setOptionDefListKea().

+ Here is the call graph for this function:

◆ setOptionDefKea()

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

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

Parameters
xpathThe xpath of the option definition.
elemThe JSON element.
Exceptions
BadValueon option definition without name or type.

Definition at line 103 of file translator_option_def.cc.

References isc::yang::Adaptor::getContext(), isc_throw, and isc::yang::TranslatorBasic::setItem().

Referenced by setOptionDef().

+ Here is the call graph for this function:

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