DHCP-DDNS Configuration Context. More...

#include <d2_cfg_mgr.h>

Inheritance diagram for isc::d2::D2CfgContext:

Public Member Functions
	D2CfgContext ()
	Constructor.

virtual	~D2CfgContext ()
	Destructor.

virtual process::ConfigPtr	clone ()
	Creates a clone of this context object.

D2ParamsPtr &	getD2Params ()
	Fetches a reference to the D2Params.

DdnsDomainListMgrPtr	getForwardMgr ()
	Fetches the forward DNS domain list manager.

isc::hooks::HooksConfig &	getHooksConfig ()
	Returns non-const reference to configured hooks libraries.

const isc::hooks::HooksConfig &	getHooksConfig () const
	Returns const reference to configured hooks libraries.

isc::config::HttpCommandConfigPtr	getHttpControlSocketInfo () const
	Returns information about HTTP/HTTPS control socket.

TSIGKeyInfoMapPtr	getKeys ()
	Fetches the map of TSIG keys.

DdnsDomainListMgrPtr	getReverseMgr ()
	Fetches the reverse DNS domain list manager.

const isc::data::ConstElementPtr	getUnixControlSocketInfo () const
	Returns information about UNIX control socket.

void	setForwardMgr (DdnsDomainListMgrPtr forward_mgr)
	Sets the forward domain list manager.

void	setHttpControlSocketInfo (const isc::config::HttpCommandConfigPtr &control_socket)
	Sets information about the HTTP/HTTPS control socket.

void	setKeys (const TSIGKeyInfoMapPtr &keys)
	Sets the map of TSIG keys.

void	setReverseMgr (DdnsDomainListMgrPtr reverse_mgr)
	Sets the reverse domain list manager.

void	setUnixControlSocketInfo (const isc::data::ConstElementPtr &control_socket)
	Sets information about the UNIX control socket.

virtual isc::data::ElementPtr	toElement () const
	Unparse a configuration object.

Public Member Functions inherited from isc::process::ConfigBase
const process::LoggingInfoStorage &	getLoggingInfo () const
	Returns logging specific configuration.

void	addLoggingInfo (const process::LoggingInfo &logging_info)
	Sets logging specific configuration.

void	applyLoggingCfg () const
	Apply logging configuration to log4cplus.

bool	equals (const ConfigBase &other) const
	Compares two configuration.

virtual void	merge (ConfigBase &other)
	Merges specified configuration into this configuration.

process::ConstConfigControlInfoPtr	getConfigControlInfo () const
	Fetches a read-only copy of the configuration control information.

void	setConfigControlInfo (const process::ConfigControlInfoPtr &config_ctl_info)
	Set the configuration control information.

void	setServerTag (const util::Optional< std::string > &server_tag)
	Sets the server's logical name.

util::Optional< std::string >	getServerTag () const
	Returns the server's logical name.

boost::posix_time::ptime	getLastCommitTime () const
	Returns the last commit timestamp.

void	setLastCommitTime (const boost::posix_time::ptime &last_commit_time)
	Sets the last commit timestamp.

Public Member Functions inherited from isc::data::UserContext
void	contextToElement (data::ElementPtr map) const
	Merge unparse a user_context object.

data::ConstElementPtr	getContext () const
	Returns const pointer to the user context.

void	setContext (const data::ConstElementPtr &ctx)
	Sets user context.

Public Member Functions inherited from isc::data::CfgToElement
virtual	~CfgToElement ()
	Destructor.

Protected Member Functions
	D2CfgContext (const D2CfgContext &rhs)
	Copy constructor for use by derivations in clone().

Protected Member Functions inherited from isc::process::ConfigBase
void	copy (ConfigBase &new_config) const
	Copies the current configuration to a new configuration.

Additional Inherited Members
Static Public Member Functions inherited from isc::data::UserContext
static data::ElementPtr	toElement (data::ConstElementPtr map)
	Copy an Element map.

Protected Attributes inherited from isc::data::UserContext
data::ConstElementPtr	user_context_
	Pointer to the user context (may be NULL)

Detailed Description

DHCP-DDNS Configuration Context.

Implements the storage container for configuration context. It provides a single enclosure for the storage of configuration parameters and any other DHCP-DDNS specific information that needs to be accessible during configuration parsing as well as to the application as a whole. It is derived from the context base class, ConfigBase.

Definition at line 35 of file d2_cfg_mgr.h.

Constructor & Destructor Documentation

◆ D2CfgContext() [1/2]

isc::d2::D2CfgContext::D2CfgContext ( )

Constructor.

Definition at line 33 of file d2_cfg_mgr.cc.

Referenced by clone().

◆ ~D2CfgContext()

isc::d2::D2CfgContext::~D2CfgContext ( )

virtual

Destructor.

Definition at line 63 of file d2_cfg_mgr.cc.

◆ D2CfgContext() [2/2]

isc::d2::D2CfgContext::D2CfgContext ( const D2CfgContext & rhs )

protected

Copy constructor for use by derivations in clone().

Definition at line 42 of file d2_cfg_mgr.cc.

Member Function Documentation

◆ clone()

virtual process::ConfigPtr isc::d2::D2CfgContext::clone ( )

inlinevirtual

Creates a clone of this context object.

Returns: returns a pointer to the new clone.

Definition at line 46 of file d2_cfg_mgr.h.

References D2CfgContext().

Here is the call graph for this function:

◆ getD2Params()

D2ParamsPtr & isc::d2::D2CfgContext::getD2Params ( )

inline

Fetches a reference to the D2Params.

Definition at line 51 of file d2_cfg_mgr.h.

◆ getForwardMgr()

DdnsDomainListMgrPtr isc::d2::D2CfgContext::getForwardMgr ( )

inline

Fetches the forward DNS domain list manager.

Returns: returns a pointer to the forward manager.

Definition at line 58 of file d2_cfg_mgr.h.

◆ getHooksConfig() [1/2]

isc::hooks::HooksConfig & isc::d2::D2CfgContext::getHooksConfig ( )

inline

Returns non-const reference to configured hooks libraries.

Returns: non-const reference to configured hooks libraries.

Definition at line 128 of file d2_cfg_mgr.h.

◆ getHooksConfig() [2/2]

const isc::hooks::HooksConfig & isc::d2::D2CfgContext::getHooksConfig ( ) const

inline

Returns const reference to configured hooks libraries.

Returns: const reference to configured hooks libraries.

Definition at line 135 of file d2_cfg_mgr.h.

◆ getHttpControlSocketInfo()

isc::config::HttpCommandConfigPtr isc::d2::D2CfgContext::getHttpControlSocketInfo ( ) const

inline

Returns information about HTTP/HTTPS control socket.

Returns: pointer to the HTTP/HTTPS control socket config

Definition at line 114 of file d2_cfg_mgr.h.

◆ getKeys()

TSIGKeyInfoMapPtr isc::d2::D2CfgContext::getKeys ( )

inline

Fetches the map of TSIG keys.

Returns: returns a pointer to the key map.

Definition at line 86 of file d2_cfg_mgr.h.

◆ getReverseMgr()

DdnsDomainListMgrPtr isc::d2::D2CfgContext::getReverseMgr ( )

inline

Fetches the reverse DNS domain list manager.

Returns: returns a pointer to the reverse manager.

Definition at line 72 of file d2_cfg_mgr.h.

◆ getUnixControlSocketInfo()

const isc::data::ConstElementPtr isc::d2::D2CfgContext::getUnixControlSocketInfo ( ) const

inline

Returns information about UNIX control socket.

Returns: pointer to the UNIX control socket config

Definition at line 100 of file d2_cfg_mgr.h.

◆ setForwardMgr()

void isc::d2::D2CfgContext::setForwardMgr ( DdnsDomainListMgrPtr forward_mgr )

inline

Sets the forward domain list manager.

Parameters

forward_mgr pointer to the new forward manager

Definition at line 65 of file d2_cfg_mgr.h.

◆ setHttpControlSocketInfo()

void isc::d2::D2CfgContext::setHttpControlSocketInfo ( const isc::config::HttpCommandConfigPtr & control_socket )

inline

Sets information about the HTTP/HTTPS control socket.

Parameters

control_socket HTTP/HTTPS control socket config

Definition at line 121 of file d2_cfg_mgr.h.

◆ setKeys()

void isc::d2::D2CfgContext::setKeys ( const TSIGKeyInfoMapPtr & keys )

inline

Sets the map of TSIG keys.

Parameters

keys	pointer to the new TSIG key map

Definition at line 93 of file d2_cfg_mgr.h.

◆ setReverseMgr()

void isc::d2::D2CfgContext::setReverseMgr ( DdnsDomainListMgrPtr reverse_mgr )

inline

Sets the reverse domain list manager.

Parameters

reverse_mgr pointer to the new reverse manager

Definition at line 79 of file d2_cfg_mgr.h.

◆ setUnixControlSocketInfo()

void isc::d2::D2CfgContext::setUnixControlSocketInfo ( const isc::data::ConstElementPtr & control_socket )

inline

Sets information about the UNIX control socket.

Parameters

control_socket UNIX control socket config

Definition at line 107 of file d2_cfg_mgr.h.

◆ toElement()

ElementPtr isc::d2::D2CfgContext::toElement ( ) const

virtual

Unparse a configuration object.

Returns: a pointer to a configuration

Reimplemented from isc::process::ConfigBase.

Definition at line 67 of file d2_cfg_mgr.cc.

References isc::data::UserContext::contextToElement(), isc::data::Element::create(), isc::data::Element::createList(), isc::data::Element::createMap(), isc::data::isNull(), isc::dhcp_ddns::ncrFormatToString(), isc::dhcp_ddns::ncrProtocolToString(), isc::hooks::HooksConfig::toElement(), isc::process::ConfigBase::toElement(), and isc::data::UserContext::toElement().

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

◆ D2CfgContext() [1/2]

◆ ~D2CfgContext()

◆ D2CfgContext() [2/2]

Member Function Documentation

◆ clone()

◆ getD2Params()

◆ getForwardMgr()

◆ getHooksConfig() [1/2]

◆ getHooksConfig() [2/2]

◆ getHttpControlSocketInfo()

◆ getKeys()

◆ getReverseMgr()

◆ getUnixControlSocketInfo()

◆ setForwardMgr()

◆ setHttpControlSocketInfo()

◆ setKeys()

◆ setReverseMgr()

◆ setUnixControlSocketInfo()

◆ toElement()