Database access translation between YANG and JSON. More...

#include <translator_database.h>

Inheritance diagram for isc::yang::TranslatorDatabase:

Public Member Functions
	TranslatorDatabase (sysrepo::S_Session session, const std::string &model)
	Constructor. More...

virtual	~TranslatorDatabase ()
	Destructor. More...

isc::data::ElementPtr	getDatabase (const std::string &xpath)
	Get and translate a database access from YANG to JSON. More...

void	setDatabase (const std::string &xpath, isc::data::ConstElementPtr elem, bool skip=false)
	Translate and set database access 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	delItem (const std::string &xpath)
	Delete basic value from YANG. 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...

sysrepo::S_Iter_Value	getIter (const std::string &xpath)
	List iterator methods keeping the session private. More...

std::string	getNext (sysrepo::S_Iter_Value iter)
	Get xpath of the next YANG list item. 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	getDatabaseKea (const std::string &xpath)
	getDatabase JSON for kea-dhcp[46]-server models. More...

void	setDatabaseKea (const std::string &xpath, isc::data::ConstElementPtr elem, bool skip)
	setDatabase for kea-dhcp[46]-server models. More...

Additional Inherited Members
Static Public Member Functions inherited from isc::yang::TranslatorBasic
static isc::data::ElementPtr	value (sysrepo::S_Val s_val)
	Translate basic value from YANG to JSON. More...

static sysrepo::S_Val	value (isc::data::ConstElementPtr elem, sr_type_t type)
	Translate basic value from JSON to YANG. More...

Protected Attributes inherited from isc::yang::TranslatorBasic
std::string	model_
	The model. More...

sysrepo::S_Session	session_
	The sysrepo session. More...

Detailed Description

Database access translation between YANG and JSON.

JSON syntax for all Kea servers with database access is:

{
    "type": <type>, 
    "user": <user>,
    "password": <password>,
    "host": <host>,
    "name": <name>,
    "persist": <persist flag>,
    "port": <port>,
    "lfc-interval": <lfc interval>,
    "readonly": <readonly flag>,
    "connect-timeout": <connect timeout>,
    "contact-points": <contact points>,
    "keyspace": <keyspace>,
    "max-reconnect-tries": <maximum reconnect tries>,
    "reconnect-wait-time": <reconnect wait time>,
    "request-timeout": <request timeout>,
    "tcp-keepalive": <TCP keepalive>,
    "tcp-nodelay": <TCP nodelay flag>,
    "consistency": <consistency level>,
    "serial-consistency": <serial consistency level>,
    "max-row-errors": <maximum row errors>,
    "user-context": { <json map> },
    "comment": <comment>
}

YANG syntax for kea-dhcp[46] is using database-type as the list key:

+--rw database                (list)
  |
  +--rw database-type?        string
  +--rw user?                 string
  +--rw password?             string
  +--rw host?                 string
  +--rw name?                 string
  +--rw persist?              boolean
  +--rw port?                 uint16
  +--rw lfc-interval?         uint32
  +--rw readonly?             boolean
  +--rw connect-timeout?      uint32
  +--rw contact-points?       string
  +--rw keyspace?             string
  +--rw max-reconnect-tries?  uint32
  +--rw reconnect-wait-time?  uint32
  +--rw request-timeout?      uint32
  +--rw tcp-keepalive?        uint32
  +--rw tcp-nodelay?          boolean
  +--rw consistency?          string
  +--rw serial-consistency?   string
  +--rw max-row-errors?       uint32
  +--rw user-context?         string

An example in JSON and YANG formats:

[
    {
        "type": "mysql",
        "name": "kea",
        "user": "kea",
        "password": "kea",
        "host": "localhost",
        "port": 3306
    }
]

/kea-dhcp6-server:config (container)
/kea-dhcp6-server:config/
   hosts-database[database-type='mysql'] (list instance)
/kea-dhcp6-server:config/
   hosts-database[database-type='mysql']/type = mysql
/kea-dhcp6-server:config/
   hosts-database[database-type='mysql']/name = kea
/kea-dhcp6-server:config/
   hosts-database[database-type='mysql']/user = kea
/kea-dhcp6-server:config/
   hosts-database[database-type='mysql']/password = kea
/kea-dhcp6-server:config/
   hosts-database[database-type='mysql']/host = localhost
/kea-dhcp6-server:config/
   hosts-database[database-type='mysql']/port = 3306

A translator class for converting a database access parameters between YANG and JSON.

Supports the following models:

kea-dhcp4-server
kea-dhcp6-server

Definition at line 110 of file translator_database.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters

session	Sysrepo session.
model	Model name.

Definition at line 23 of file translator_database.cc.

isc::yang::TranslatorDatabase::~TranslatorDatabase ( )

virtual

Destructor.

Definition at line 27 of file translator_database.cc.

Member Function Documentation

ElementPtr isc::yang::TranslatorDatabase::getDatabase ( const std::string & xpath )

Get and translate a database access from YANG to JSON.

Parameters

xpath The xpath of the database.

Returns: JSON representation of the database.

Exceptions

SysrepoError when sysrepo raises an error.

Definition at line 31 of file translator_database.cc.

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

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

Here is the call graph for this function:

ElementPtr isc::yang::TranslatorDatabase::getDatabaseKea ( const std::string & xpath )

protected

getDatabase JSON for kea-dhcp[46]-server models.

Parameters

xpath The xpath of the database.

Returns: JSON representation of the database or null if none.

Exceptions

SysrepoError when sysrepo raises an error.

Definition at line 47 of file translator_database.cc.

References isc::yang::TranslatorBasic::getItem().

Referenced by getDatabase().

Here is the call graph for this function:

void isc::yang::TranslatorDatabase::setDatabase	(	const std::string &	xpath,
		isc::data::ConstElementPtr	elem,
		bool	skip = `false`
	)

Translate and set database access from JSON to YANG.

Null elem argument removes the database entry.

Parameters

xpath	The xpath of the database access.
elem	The JSON element.
skip	The skip type field flag.

Definition at line 138 of file translator_database.cc.

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

Referenced by isc::yang::TranslatorDatabases::setDatabasesKea(), and isc::yang::TranslatorConfig::setServerKeaDhcpCommon().

Here is the call graph for this function:

void isc::yang::TranslatorDatabase::setDatabaseKea	(	const std::string &	xpath,
		isc::data::ConstElementPtr	elem,
		bool	skip
	)

protected

setDatabase for kea-dhcp[46]-server models.

Parameters

xpath	The xpath of the database access.
elem	The JSON element.
skip	The skip type field flag.

Exceptions

BadValue on database without type,

Definition at line 157 of file translator_database.cc.

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

Referenced by setDatabase().

Here is the call graph for this function:

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation