Kea  2.3.5-git
isc::d2::D2CfgContext Class Reference

DHCP-DDNS Configuration Context. More...

#include <d2_cfg_mgr.h>

+ Inheritance diagram for isc::d2::D2CfgContext:

Public Member Functions

 D2CfgContext ()
 Constructor. More...
 
virtual ~D2CfgContext ()
 Destructor. More...
 
virtual process::ConfigPtr clone ()
 Creates a clone of this context object. More...
 
const isc::data::ConstElementPtr getControlSocketInfo () const
 Returns information about control socket. More...
 
D2ParamsPtrgetD2Params ()
 Fetches a reference to the D2Params. More...
 
DdnsDomainListMgrPtr getForwardMgr ()
 Fetches the forward DNS domain list manager. More...
 
isc::hooks::HooksConfiggetHooksConfig ()
 Returns non-const reference to configured hooks libraries. More...
 
const isc::hooks::HooksConfiggetHooksConfig () const
 Returns const reference to configured hooks libraries. More...
 
TSIGKeyInfoMapPtr getKeys ()
 Fetches the map of TSIG keys. More...
 
DdnsDomainListMgrPtr getReverseMgr ()
 Fetches the reverse DNS domain list manager. More...
 
void setControlSocketInfo (const isc::data::ConstElementPtr &control_socket)
 Sets information about the control socket. More...
 
void setForwardMgr (DdnsDomainListMgrPtr forward_mgr)
 Sets the forward domain list manager. More...
 
void setKeys (const TSIGKeyInfoMapPtr &keys)
 Sets the map of TSIG keys. More...
 
void setReverseMgr (DdnsDomainListMgrPtr reverse_mgr)
 Sets the reverse domain list manager. More...
 
virtual isc::data::ElementPtr toElement () const
 Unparse a configuration object. More...
 
- Public Member Functions inherited from isc::process::ConfigBase
const process::LoggingInfoStoragegetLoggingInfo () const
 Returns logging specific configuration. More...
 
void addLoggingInfo (const process::LoggingInfo &logging_info)
 Sets logging specific configuration. More...
 
void applyLoggingCfg () const
 Apply logging configuration to log4cplus. More...
 
bool equals (const ConfigBase &other) const
 Compares two configuration. More...
 
virtual void merge (ConfigBase &other)
 Merges specified configuration into this configuration. More...
 
process::ConstConfigControlInfoPtr getConfigControlInfo () const
 Fetches a read-only copy of the configuration control information. More...
 
void setConfigControlInfo (const process::ConfigControlInfoPtr &config_ctl_info)
 Set the configuration control information. More...
 
void setServerTag (const util::Optional< std::string > &server_tag)
 Sets the server's logical name. More...
 
util::Optional< std::string > getServerTag () const
 Returns the server's logical name. More...
 
boost::posix_time::ptime getLastCommitTime () const
 Returns the last commit timestamp. More...
 
void setLastCommitTime (const boost::posix_time::ptime &last_commit_time)
 Sets the last commit timestamp. More...
 
- Public Member Functions inherited from isc::data::UserContext
void contextToElement (data::ElementPtr map) const
 Merge unparse a user_context object. More...
 
data::ConstElementPtr getContext () const
 Returns const pointer to the user context. More...
 
void setContext (const data::ConstElementPtr &ctx)
 Sets user context. More...
 
- Public Member Functions inherited from isc::data::CfgToElement
virtual ~CfgToElement ()
 Destructor. More...
 

Protected Member Functions

 D2CfgContext (const D2CfgContext &rhs)
 Copy constructor for use by derivations in clone(). More...
 
- Protected Member Functions inherited from isc::process::ConfigBase
void copy (ConfigBase &new_config) const
 Copies the current configuration to a new configuration. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from isc::data::UserContext
static data::ElementPtr toElement (data::ConstElementPtr map)
 Copy an Element map. More...
 
- Protected Attributes inherited from isc::data::UserContext
data::ConstElementPtr user_context_
 Pointer to the user context (may be NULL) More...
 

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 34 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(), and getHooksConfig().

◆ ~D2CfgContext()

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

Destructor.

Definition at line 60 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 41 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 45 of file d2_cfg_mgr.h.

References D2CfgContext().

+ Here is the call graph for this function:

◆ getControlSocketInfo()

const isc::data::ConstElementPtr isc::d2::D2CfgContext::getControlSocketInfo ( ) const
inline

Returns information about control socket.

Returns
pointer to the Element that holds control-socket map

Definition at line 96 of file d2_cfg_mgr.h.

Referenced by isc::d2::D2CfgMgr::getD2CfgContext().

◆ getD2Params()

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

Fetches a reference to the D2Params.

Definition at line 50 of file d2_cfg_mgr.h.

Referenced by isc::d2::D2CfgMgr::getD2CfgContext().

◆ 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 57 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 109 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 116 of file d2_cfg_mgr.h.

References D2CfgContext(), and toElement().

+ Here is the call graph for this function:

◆ getKeys()

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

Fetches the map of TSIG keys.

Returns
returns a pointer to the key map.

Definition at line 83 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 70 of file d2_cfg_mgr.h.

◆ setControlSocketInfo()

void isc::d2::D2CfgContext::setControlSocketInfo ( const isc::data::ConstElementPtr control_socket)
inline

Sets information about the control socket.

Parameters
control_socketElement that holds control-socket map

Definition at line 102 of file d2_cfg_mgr.h.

◆ setForwardMgr()

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

Sets the forward domain list manager.

Parameters
forward_mgrpointer to the new forward manager

Definition at line 63 of file d2_cfg_mgr.h.

◆ setKeys()

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

Sets the map of TSIG keys.

Parameters
keyspointer to the new TSIG key map

Definition at line 90 of file d2_cfg_mgr.h.

◆ setReverseMgr()

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

Sets the reverse domain list manager.

Parameters
reverse_mgrpointer to the new reverse manager

Definition at line 76 of file d2_cfg_mgr.h.

◆ toElement()

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

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