Ctrl Netconf Configuration Manager. More...

#include <netconf_cfg_mgr.h>

Inheritance diagram for isc::netconf::NetconfCfgMgr:

Public Member Functions
	NetconfCfgMgr ()
	Constructor. More...

virtual	~NetconfCfgMgr ()
	Destructor. More...

virtual std::string	getConfigSummary (const uint32_t selection)
	Returns configuration summary in the textual format. More...

NetconfConfigPtr	getNetconfConfig ()
	Convenience method that returns the Netconf configuration context. More...

std::list< std::list< std::string > >	jsonPathsToRedact () const
	Return a list of all paths that contain passwords or secrets for kea-netconf. More...

Public Member Functions inherited from isc::process::DCfgMgrBase
	DCfgMgrBase (ConfigPtr context)
	Constructor. More...

virtual	~DCfgMgrBase ()
	Destructor. More...

ConfigPtr &	getContext ()
	Fetches the configuration context. More...

isc::data::ConstElementPtr	redactConfig (isc::data::ConstElementPtr const &config) const
	Redact the configuration. More...

isc::data::ConstElementPtr	simpleParseConfig (isc::data::ConstElementPtr config, bool check_only=false, const std::function< void()> &post_config_cb=nullptr)
	Acts as the receiver of new configurations. More...

Protected Member Functions
virtual process::ConfigPtr	createNewContext ()
	Creates a new, blank NetconfConfig context. More...

virtual isc::data::ConstElementPtr	parse (isc::data::ConstElementPtr config, bool check_only)
	Parses configuration of Netconf. More...

Protected Member Functions inherited from isc::process::DCfgMgrBase
void	resetContext ()
	Replaces existing context with a new, empty context. More...

virtual void	setCfgDefaults (isc::data::ElementPtr mutable_config)
	Adds default values to the given config. More...

void	setContext (ConfigPtr &context)
	Update the current context. More...

Detailed Description

Ctrl Netconf Configuration Manager.

Provides the mechanisms for managing the Netconf application's configuration.

Definition at line 124 of file netconf_cfg_mgr.h.

Constructor & Destructor Documentation

isc::netconf::NetconfCfgMgr::NetconfCfgMgr ( )

Constructor.

Definition at line 49 of file netconf_cfg_mgr.cc.

isc::netconf::NetconfCfgMgr::~NetconfCfgMgr ( )

virtual

Destructor.

Definition at line 53 of file netconf_cfg_mgr.cc.

Member Function Documentation

ConfigPtr isc::netconf::NetconfCfgMgr::createNewContext ( )

protectedvirtual

Creates a new, blank NetconfConfig context.

This method is used at the beginning of configuration process to create a fresh, empty copy of a NetconfConfig. This new context will be populated during the configuration process and will replace the existing context provided the configuration process completes without error.

Returns: Returns a ConfigPtr to the new context instance.

Implements isc::process::DCfgMgrBase.

Definition at line 87 of file netconf_cfg_mgr.cc.

std::string isc::netconf::NetconfCfgMgr::getConfigSummary ( const uint32_t selection )

virtual

Returns configuration summary in the textual format.

Parameters

selection Bitfield which describes the parts of the configuration to be returned. This parameter is ignored for Netconf.

Returns: Summary of the configuration in the textual format.

Implements isc::process::DCfgMgrBase.

Definition at line 57 of file netconf_cfg_mgr.cc.

References getNetconfConfig().

Here is the call graph for this function:

NetconfConfigPtr isc::netconf::NetconfCfgMgr::getNetconfConfig ( )

inline

Convenience method that returns the Netconf configuration context.

Returns: returns a pointer to the configuration context.

Definition at line 137 of file netconf_cfg_mgr.h.

References isc::process::DCfgMgrBase::getContext().

Referenced by getConfigSummary(), and parse().

Here is the call graph for this function:

std::list< std::list< std::string > > isc::netconf::NetconfCfgMgr::jsonPathsToRedact ( ) const

virtual

Return a list of all paths that contain passwords or secrets for kea-netconf.

Returns: the list of lists of sequential JSON map keys needed to reach the passwords and secrets.

Reimplemented from isc::process::DCfgMgrBase.

Definition at line 168 of file netconf_cfg_mgr.cc.

isc::data::ConstElementPtr isc::netconf::NetconfCfgMgr::parse	(	isc::data::ConstElementPtr	config,
		bool	check_only
	)

protectedvirtual

Parses configuration of Netconf.

Parameters

config	Pointer to a configuration specified for netconf.
check_only	Boolean flag indicating if this method should only verify correctness of the provided configuration.

Returns: Pointer to a result of configuration parsing.

Reimplemented from isc::process::DCfgMgrBase.

Definition at line 92 of file netconf_cfg_mgr.cc.

References isc::config::CONTROL_RESULT_ERROR, isc::config::CONTROL_RESULT_SUCCESS, isc::config::createAnswer(), isc::netconf::NetconfSimpleParser::deriveParameters(), getNetconfConfig(), isc_throw, LOG_ERROR, isc::netconf::NETCONF_CONFIG_CHECK_FAIL, isc::netconf::NETCONF_CONFIG_FAIL, isc::netconf::netconf_logger, isc::netconf::NetconfSimpleParser::parse(), isc::netconf::NetconfSimpleParser::setAllDefaults(), and isc::Exception::what().

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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation