|  | Kea 3.0.0
    | 
Ctrl Netconf Configuration Manager. More...
#include <netconf_cfg_mgr.h>
| Public Member Functions | |
| NetconfCfgMgr () | |
| Constructor. | |
| virtual | ~NetconfCfgMgr ()=default | 
| Destructor. | |
| std::string | getConfigSummary (const uint32_t selection) override final | 
| Returns configuration summary in the textual format. | |
| NetconfConfigPtr | getNetconfConfig () | 
| Convenience method that returns the Netconf configuration context. | |
| std::list< std::list< std::string > > | jsonPathsToRedact () const override final | 
| Return a list of all paths that contain passwords or secrets for kea-netconf. | |
| Public Member Functions inherited from isc::process::DCfgMgrBase | |
| DCfgMgrBase (ConfigPtr context) | |
| Constructor. | |
| virtual | ~DCfgMgrBase () | 
| Destructor. | |
| ConfigPtr & | getContext () | 
| Fetches the configuration context. | |
| isc::data::ConstElementPtr | redactConfig (isc::data::ConstElementPtr const &config) const | 
| Redact the configuration. | |
| 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. | |
| Protected Member Functions | |
| process::ConfigPtr | createNewContext () override final | 
| Creates a new, blank NetconfConfig context. | |
| isc::data::ConstElementPtr | parse (isc::data::ConstElementPtr config, bool check_only) override final | 
| Parses configuration of Netconf. | |
| Protected Member Functions inherited from isc::process::DCfgMgrBase | |
| void | resetContext () | 
| Replaces existing context with a new, empty context. | |
| virtual void | setCfgDefaults (isc::data::ElementPtr mutable_config) | 
| Adds default values to the given config. | |
| void | setContext (ConfigPtr &context) | 
| Update the current context. | |
Ctrl Netconf Configuration Manager.
Provides the mechanisms for managing the Netconf application's configuration.
Definition at line 121 of file netconf_cfg_mgr.h.
| isc::netconf::NetconfCfgMgr::NetconfCfgMgr | ( | ) | 
Constructor.
Definition at line 55 of file netconf_cfg_mgr.cc.
References isc::process::DCfgMgrBase::DCfgMgrBase().
| 
 | virtualdefault | 
Destructor.
| 
 | finaloverrideprotectedvirtual | 
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.
Implements isc::process::DCfgMgrBase.
Definition at line 90 of file netconf_cfg_mgr.cc.
| 
 | finaloverridevirtual | 
Returns configuration summary in the textual format.
| selection | Bitfield which describes the parts of the configuration to be returned. This parameter is ignored for Netconf. | 
Implements isc::process::DCfgMgrBase.
Definition at line 60 of file netconf_cfg_mgr.cc.
References getNetconfConfig().
| 
 | inline | 
Convenience method that returns the Netconf configuration context.
Definition at line 133 of file netconf_cfg_mgr.h.
References isc::data::UserContext::getContext().
Referenced by getConfigSummary(), and parse().
| 
 | finaloverridevirtual | 
Return a list of all paths that contain passwords or secrets for kea-netconf.
Reimplemented from isc::process::DCfgMgrBase.
Definition at line 169 of file netconf_cfg_mgr.cc.
| 
 | finaloverrideprotectedvirtual | 
Parses configuration of Netconf.
| config | Pointer to a configuration specified for netconf. | 
| check_only | Boolean flag indicating if this method should only verify correctness of the provided configuration. | 
Reimplemented from isc::process::DCfgMgrBase.
Definition at line 95 of file netconf_cfg_mgr.cc.
References isc::config::CONTROL_RESULT_ERROR, isc::config::CONTROL_RESULT_SUCCESS, isc::data::copy(), 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().