![]() |
Kea 2.2.0
|
A translator class for converting a pool between YANG and JSON. More...
#include <translator_pool.h>
Inheritance diagram for isc::yang::TranslatorPool:Public Member Functions | |
| 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... | |
Static Public Member Functions | |
| 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 Member Functions | |
| 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... | |
Additional Inherited Members | |
Protected Attributes inherited from isc::yang::TranslatorBasic | |
| std::string | model_ |
| The model. More... | |
| sysrepo::S_Session | session_ |
| The sysrepo session. More... | |
A translator class for converting a pool between YANG and JSON.
Currently supports on kea-dhcp[46]-server and partially ietf-dhcpv6-server.
JSON syntax for both kea-dhcp4 and kea-dhcp6 is:
YANG syntax is for ietf-dhcpv6-server is with pool-id as the key:
YANG syntax for kea-dhcp[46] is with start-address and end-address as the keys:
An example in JSON and YANG formats for the IETF model:
An example in JSON and YANG formats for the Kea model:
Definition at line 125 of file translator_pool.h.
| isc::yang::TranslatorPool::TranslatorPool | ( | sysrepo::S_Session | session, |
| const std::string & | model | ||
| ) |
Constructor.
| session | Sysrepo session. |
| model | Model name. |
Definition at line 25 of file translator_pool.cc.
|
virtual |
Destructor.
Definition at line 31 of file translator_pool.cc.
|
static |
Get start and end addresses from prefix.
| prefix | The prefix string. |
| start_address | The reference to the start_address. |
| end_address | The reference to the end_address. |
| BadValue | when the prefix is not correctly formed. |
Definition at line 249 of file translator_pool.cc.
References isc::asiolink::firstAddrInPrefix(), isc_throw, isc::asiolink::lastAddrInPrefix(), and isc::asiolink::IOAddress::toText().
Referenced by setPoolKea(), and isc::yang::TranslatorPools::setPoolsByAddresses().
Here is the call graph for this function:| ElementPtr isc::yang::TranslatorPool::getPool | ( | const std::string & | xpath | ) |
Get and translate a pool from YANG to JSON.
| xpath | The xpath of the pool. |
| SysrepoError | when sysrepo raises an error. |
Definition at line 35 of file translator_pool.cc.
References getPoolIetf6(), getPoolKea(), isc_throw, isc::yang::TranslatorBasic::model_, and isc::Exception::what().
Referenced by isc::yang::TranslatorPools::getPoolsIetf(), and isc::yang::TranslatorPools::getPoolsKea().
Here is the call graph for this function:
|
protected |
getPool for ietf-dhcpv6-server.
| xpath | The xpath of the pool. |
| BadValue | on pool without prefix. |
no require-client-classes nor user-context.
Definition at line 53 of file translator_pool.cc.
References isc::yang::TranslatorBasic::getItem(), and isc_throw.
Referenced by getPool().
Here is the call graph for this function:
|
protected |
getPool for kea-dhcp[46]-server.
| xpath | The xpath of the pool. |
| BadValue | on a pool without prefix and start or end address. |
Definition at line 94 of file translator_pool.cc.
References isc::yang::TranslatorBasic::getItem(), isc::yang::TranslatorBasic::getItems(), isc::yang::TranslatorOptionDataList::getOptionDataList(), and isc_throw.
Referenced by getPool().
Here is the call graph for this function:| void isc::yang::TranslatorPool::setPool | ( | const std::string & | xpath, |
| isc::data::ConstElementPtr | elem | ||
| ) |
Translate and set (address) pool from JSON to YANG.
| xpath | The xpath of the pool. |
| elem | The JSON element. |
Definition at line 131 of file translator_pool.cc.
References isc_throw, isc::yang::TranslatorBasic::model_, setPoolIetf6(), setPoolKea(), and isc::Exception::what().
Referenced by isc::yang::TranslatorPools::setPoolsByAddresses(), and isc::yang::TranslatorPools::setPoolsById().
Here is the call graph for this function:
|
protected |
setPool for ietf-dhcpv6-server.
| xpath | The xpath of the pool. |
| elem | The JSON element. |
| BadValue | on pool without prefix and with a range which is not a prefix. |
Definition at line 150 of file translator_pool.cc.
References isc::asiolink::firstAddrInPrefix(), isc_throw, isc::asiolink::lastAddrInPrefix(), and isc::yang::TranslatorBasic::setItem().
Referenced by setPool().
Here is the call graph for this function:
|
protected |
setPool for kea-dhcp[46]-server.
| xpath | The xpath of the pool. |
| elem | The JSON element. |
| BadValue | on a pool without a well formed prefix. |
Definition at line 203 of file translator_pool.cc.
References getAddresses(), isc::yang::Adaptor::getContext(), isc_throw, isc::yang::TranslatorBasic::setItem(), and isc::yang::TranslatorOptionDataList::setOptionDataList().
Referenced by setPool().
Here is the call graph for this function: