Kea 2.2.0
isc::yang::TranslatorSubnets Class Reference

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

#include <translator_subnet.h>

+ Inheritance diagram for isc::yang::TranslatorSubnets:

Public Member Functions

 TranslatorSubnets (sysrepo::S_Session session, const std::string &model)
 Constructor. More...
 
virtual ~TranslatorSubnets ()
 Destructor. More...
 
isc::data::ElementPtr getSubnets (const std::string &xpath)
 Get and translate subnets from YANG to JSON. More...
 
void setSubnets (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set subnets from JSON to YANG. More...
 
- Public Member Functions inherited from isc::yang::TranslatorSubnet
 TranslatorSubnet (sysrepo::S_Session session, const std::string &model)
 Constructor. More...
 
virtual ~TranslatorSubnet ()
 Destructor. More...
 
isc::data::ElementPtr getSubnet (const std::string &xpath)
 Get and translate a subnet from YANG to JSON. More...
 
void setSubnet (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set subnet from JSON to YANG. More...
 
- Public Member Functions inherited from isc::yang::TranslatorPools
 TranslatorPools (sysrepo::S_Session session, const std::string &model)
 Constructor. More...
 
virtual ~TranslatorPools ()
 Destructor. More...
 
isc::data::ElementPtr getPools (const std::string &xpath)
 Get and translate pools from YANG to JSON. More...
 
void setPools (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set (address) pools from JSON to YANG. More...
 
- Public Member Functions inherited from isc::yang::TranslatorPool
 TranslatorPool (sysrepo::S_Session session, const std::string &model)
 Constructor. More...
 
virtual ~TranslatorPool ()
 Destructor. More...
 
isc::data::ElementPtr getPool (const std::string &xpath)
 Get and translate a pool from YANG to JSON. More...
 
void setPool (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set (address) pool from JSON to YANG. More...
 
- Public Member Functions inherited from isc::yang::TranslatorOptionDataList
 TranslatorOptionDataList (sysrepo::S_Session session, const std::string &model)
 Constructor. More...
 
virtual ~TranslatorOptionDataList ()
 Destructor. More...
 
isc::data::ConstElementPtr getOptionDataList (const std::string &xpath)
 Get and translate option data list from YANG to JSON. More...
 
void setOptionDataList (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set option data list from JSON to YANG. More...
 
- Public Member Functions inherited from isc::yang::TranslatorOptionData
 TranslatorOptionData (sysrepo::S_Session session, const std::string &model)
 Constructor. More...
 
virtual ~TranslatorOptionData ()
 Destructor. More...
 
isc::data::ElementPtr getOptionData (const std::string &xpath)
 Get and translate an option data from YANG to JSON. More...
 
void setOptionData (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set option data 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...
 
- Public Member Functions inherited from isc::yang::TranslatorPdPools
 TranslatorPdPools (sysrepo::S_Session session, const std::string &model)
 Constructor. More...
 
virtual ~TranslatorPdPools ()
 Destructor. More...
 
isc::data::ElementPtr getPdPools (const std::string &xpath)
 Get and translate pd-pools from YANG to JSON. More...
 
void setPdPools (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set pd-pools from JSON to YANG. More...
 
- Public Member Functions inherited from isc::yang::TranslatorPdPool
 TranslatorPdPool (sysrepo::S_Session session, const std::string &model)
 Constructor. More...
 
virtual ~TranslatorPdPool ()
 Destructor. More...
 
isc::data::ElementPtr getPdPool (const std::string &xpath)
 Get and translate a pd-pool from YANG to JSON. More...
 
void setPdPool (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set pd-pool from JSON to YANG. More...
 
- Public Member Functions inherited from isc::yang::TranslatorHosts
 TranslatorHosts (sysrepo::S_Session session, const std::string &model)
 Constructor. More...
 
virtual ~TranslatorHosts ()
 Destructor. More...
 
isc::data::ElementPtr getHosts (const std::string &xpath)
 Get and translate host reservations from YANG to JSON. More...
 
void setHosts (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set (address) host reservations from JSON to YANG. More...
 
- Public Member Functions inherited from isc::yang::TranslatorHost
 TranslatorHost (sysrepo::S_Session session, const std::string &model)
 Constructor. More...
 
virtual ~TranslatorHost ()
 Destructor. More...
 
isc::data::ElementPtr getHost (const std::string &xpath)
 Get and translate a host reservation from YANG to JSON. More...
 
void setHost (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set host reservation from JSON to YANG. More...
 

Protected Member Functions

isc::data::ElementPtr getSubnetsCommon (const std::string &xpath, const std::string &subsel)
 getSubnets common part. More...
 
void setSubnetsIetf6 (const std::string &xpath, isc::data::ConstElementPtr elem)
 setSubnets for ietf-dhcpv6-server. More...
 
void setSubnetsKea (const std::string &xpath, isc::data::ConstElementPtr elem, const std::string &subsel)
 setSubnets for kea-dhcp[46]-server. More...
 
- Protected Member Functions inherited from isc::yang::TranslatorSubnet
isc::data::ElementPtr getSubnetIetf6 (const std::string &xpath)
 getSubnet for ietf-dhcpv6-server. More...
 
isc::data::ElementPtr getSubnetKea (const std::string &xpath)
 getSubnet for kea-dhcp[46]-server. More...
 
void setSubnetIetf6 (const std::string &xpath, isc::data::ConstElementPtr elem)
 setSubnet for ietf-dhcpv6-server. More...
 
void setSubnetKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setSubnet for kea-dhcp[46]-server. More...
 
- Protected Member Functions inherited from isc::yang::TranslatorPools
isc::data::ElementPtr getPoolsIetf (const std::string &xpath)
 getPools for ietf-dhcpv6-server. More...
 
isc::data::ElementPtr getPoolsKea (const std::string &xpath)
 getPools for kea-dhcp[46]-server. More...
 
void setPoolsByAddresses (const std::string &xpath, isc::data::ConstElementPtr elem)
 setPools using address pair. More...
 
void setPoolsById (const std::string &xpath, isc::data::ConstElementPtr elem)
 setPools using pool-id. More...
 
- Protected Member Functions inherited from isc::yang::TranslatorPool
isc::data::ElementPtr getPoolIetf6 (const std::string &xpath)
 getPool for ietf-dhcpv6-server. More...
 
isc::data::ElementPtr getPoolKea (const std::string &xpath)
 getPool for kea-dhcp[46]-server. More...
 
void setPoolIetf6 (const std::string &xpath, isc::data::ConstElementPtr elem)
 setPool for ietf-dhcpv6-server. More...
 
void setPoolKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setPool for kea-dhcp[46]-server. More...
 
- Protected Member Functions inherited from isc::yang::TranslatorOptionDataList
isc::data::ConstElementPtr getOptionDataListKea (const std::string &xpath)
 getOptionDataList for kea-dhcp[46]. More...
 
void setOptionDataListKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setOptionDataList for kea-dhcp[46]. More...
 
- Protected Member Functions inherited from isc::yang::TranslatorOptionData
isc::data::ElementPtr getOptionDataKea (const std::string &xpath)
 getOptionData JSON for kea-dhcp[46]. More...
 
void setOptionDataKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setOptionData for kea-dhcp[46]. More...
 
- Protected Member Functions inherited from isc::yang::TranslatorPdPools
isc::data::ElementPtr getPdPoolsCommon (const std::string &xpath)
 getPdPools common part. More...
 
void setPdPoolsId (const std::string &xpath, isc::data::ConstElementPtr elem)
 setPdPools using pool-id. More...
 
void setPdPoolsPrefix (const std::string &xpath, isc::data::ConstElementPtr elem)
 setPdPools using prefix. More...
 
- Protected Member Functions inherited from isc::yang::TranslatorPdPool
isc::data::ElementPtr getPdPoolIetf6 (const std::string &xpath)
 getPdPool for ietf-dhcpv6-server. More...
 
isc::data::ElementPtr getPdPoolKea (const std::string &xpath)
 getPdPool for kea-dhcp6-server. More...
 
void setPdPoolIetf6 (const std::string &xpath, isc::data::ConstElementPtr elem)
 setPdPool for ietf-dhcpv6-server. More...
 
void setPdPoolKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setPdPool for kea-dhcp6-server. More...
 
- Protected Member Functions inherited from isc::yang::TranslatorHosts
void setHostsKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setHosts for kea-dhcp[46]. More...
 
- Protected Member Functions inherited from isc::yang::TranslatorHost
isc::data::ElementPtr getHostKea (const std::string &xpath)
 getHost for kea-dhcp[46]-server models. More...
 
void setHostKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setHost for kea-dhcp[46]-server models. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from isc::yang::TranslatorPool
static void getAddresses (const std::string &prefix, std::string &start_address, std::string &end_address)
 Get start and end addresses from prefix. More...
 
- 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

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

Currently supports on kea-dhcp[46]-server and partially ietf-dhcpv6-server.

Definition at line 333 of file translator_subnet.h.

Constructor & Destructor Documentation

◆ TranslatorSubnets()

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

Constructor.

Parameters
sessionSysrepo session.
modelModel name.

Definition at line 482 of file translator_subnet.cc.

◆ ~TranslatorSubnets()

isc::yang::TranslatorSubnets::~TranslatorSubnets ( )
virtual

Destructor.

Definition at line 495 of file translator_subnet.cc.

Member Function Documentation

◆ getSubnets()

ElementPtr isc::yang::TranslatorSubnets::getSubnets ( const std::string &  xpath)

Get and translate subnets from YANG to JSON.

Parameters
xpathThe xpath of the subnet list.
Exceptions
SysrepoErrorwhen sysrepo raises an error.

Definition at line 499 of file translator_subnet.cc.

References isc::yang::TranslatorBasic::model_.

Referenced by isc::yang::TranslatorConfig::getConfigIetf6(), isc::yang::TranslatorConfig::getServerKeaDhcp4(), isc::yang::TranslatorConfig::getServerKeaDhcp6(), and isc::yang::TranslatorSharedNetwork::getSharedNetworkKea().

◆ getSubnetsCommon()

ElementPtr isc::yang::TranslatorSubnets::getSubnetsCommon ( const std::string &  xpath,
const std::string &  subsel 
)
protected

getSubnets common part.

Parameters
xpathThe xpath of the subnet list.
subselThe subnet list name.

Definition at line 518 of file translator_subnet.cc.

References isc::yang::TranslatorSubnet::getSubnet().

+ Here is the call graph for this function:

◆ setSubnets()

void isc::yang::TranslatorSubnets::setSubnets ( const std::string &  xpath,
isc::data::ConstElementPtr  elem 
)

Translate and set subnets from JSON to YANG.

Parameters
xpathThe xpath of the subnet list.
elemThe JSON element.
Exceptions
BadValueon a subnet without id.

Definition at line 525 of file translator_subnet.cc.

References isc::yang::TranslatorBasic::model_.

Referenced by isc::yang::TranslatorConfig::setConfigIetf6(), isc::yang::TranslatorConfig::setServerKeaDhcp4(), isc::yang::TranslatorConfig::setServerKeaDhcp6(), and isc::yang::TranslatorSharedNetwork::setSharedNetworkKea().

◆ setSubnetsIetf6()

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

setSubnets for ietf-dhcpv6-server.

Parameters
xpathThe xpath of the subnet list.
elemThe JSON element.

Definition at line 545 of file translator_subnet.cc.

References isc_throw, and isc::yang::TranslatorSubnet::setSubnet().

+ Here is the call graph for this function:

◆ setSubnetsKea()

void isc::yang::TranslatorSubnets::setSubnetsKea ( const std::string &  xpath,
isc::data::ConstElementPtr  elem,
const std::string &  subsel 
)
protected

setSubnets for kea-dhcp[46]-server.

Parameters
xpathThe xpath of the subnet list.
elemThe JSON element.
subselThe subnet list name.

Definition at line 560 of file translator_subnet.cc.

References isc_throw, and isc::yang::TranslatorSubnet::setSubnet().

+ Here is the call graph for this function:

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