Kea  2.3.2-git
isc::agent::AgentSimpleParser Class Reference

#include <simple_parser.h>

+ Inheritance diagram for isc::agent::AgentSimpleParser:

Public Member Functions

void checkTlsSetup (const isc::data::ConstElementPtr &config)
 Check TLS setup consistency i.e. More...
 
void parse (const CtrlAgentCfgContextPtr &ctx, const isc::data::ConstElementPtr &config, bool check_only)
 Parses the control agent configuration. More...
 
- Public Member Functions inherited from isc::data::SimpleParser
uint16_t getUint16 (isc::data::ConstElementPtr scope, const std::string &name)
 Returns a value converted to uint16_t. More...
 
uint32_t getUint32 (isc::data::ConstElementPtr scope, const std::string &name)
 Returns a value converted to uint32_t. More...
 
uint8_t getUint8 (ConstElementPtr scope, const std::string &name)
 Get an uint8_t value. More...
 
const isc::util::Triplet< uint32_t > parseIntTriplet (const data::ConstElementPtr &scope, const std::string &name)
 Parses an integer triplet. More...
 

Static Public Member Functions

static size_t setAllDefaults (const isc::data::ElementPtr &global)
 Sets all defaults for Control Agent configuration. More...
 
- Static Public Member Functions inherited from isc::data::SimpleParser
static void checkKeywords (const SimpleKeywords &keywords, isc::data::ConstElementPtr scope)
 Checks acceptable keywords with their expected type. More...
 
static void checkRequired (const SimpleRequiredKeywords &required, isc::data::ConstElementPtr scope)
 Checks that all required keywords are present. More...
 
static size_t deriveParams (isc::data::ConstElementPtr parent, isc::data::ElementPtr child, const ParamsList &params)
 Derives (inherits) parameters from parent scope to a child. More...
 
static isc::asiolink::IOAddress getAddress (const ConstElementPtr &scope, const std::string &name)
 Returns a IOAddress parameter from a scope. More...
 
static bool getBoolean (isc::data::ConstElementPtr scope, const std::string &name)
 Returns a boolean parameter from a scope. More...
 
static double getDouble (const ConstElementPtr &scope, const std::string &name)
 Returns a floating point parameter from a scope. More...
 
static int64_t getInteger (isc::data::ConstElementPtr scope, const std::string &name)
 Returns an integer parameter from a scope. More...
 
static int64_t getInteger (isc::data::ConstElementPtr scope, const std::string &name, int64_t min, int64_t max)
 Returns an integer parameter from a scope and checks its range. More...
 
static const data::Element::PositiongetPosition (const std::string &name, const data::ConstElementPtr parent)
 Utility method that returns position of an element. More...
 
static std::string getString (isc::data::ConstElementPtr scope, const std::string &name)
 Returns a string parameter from a scope. More...
 
static size_t setDefaults (isc::data::ElementPtr scope, const SimpleDefaults &default_values)
 Sets the default values. More...
 
static size_t setListDefaults (isc::data::ConstElementPtr list, const SimpleDefaults &default_values)
 Sets the default values for all entries in a list. More...
 

Static Public Attributes

static const isc::data::SimpleDefaults AGENT_DEFAULTS
 This table defines default values for global options. More...
 
static const isc::data::SimpleDefaults AUTH_DEFAULTS
 This table defines default values for authentication. More...
 
static const isc::data::SimpleDefaults SOCKET_DEFAULTS
 This table defines default values for control sockets. More...
 

Additional Inherited Members

- Protected Member Functions inherited from isc::data::SimpleParser
template<typename target_type , target_type convert>
target_type getAndConvert (isc::data::ConstElementPtr scope, const std::string &name, const std::string &type_name)
 Returns a converted value from a scope. More...
 
template<typename int_type >
int_type getIntType (isc::data::ConstElementPtr scope, const std::string &name)
 Returns an integer value with range checking from a scope. More...
 

Detailed Description

Definition at line 23 of file bin/agent/simple_parser.h.

Member Function Documentation

◆ checkTlsSetup()

void isc::agent::AgentSimpleParser::checkTlsSetup ( const isc::data::ConstElementPtr config)

Check TLS setup consistency i.e.

all or none.

Parameters
config- Element tree structure that holds configuration.
Exceptions
ConfigErrorwhen the configuration is not consistent.

Definition at line 105 of file bin/agent/simple_parser.cc.

References isc_throw.

Referenced by isc::agent::CtrlAgentCfgMgr::parse().

◆ parse()

void isc::agent::AgentSimpleParser::parse ( const CtrlAgentCfgContextPtr ctx,
const isc::data::ConstElementPtr config,
bool  check_only 
)

Parses the control agent configuration.

Parameters
ctx- parsed information will be stored here
config- Element tree structure that holds configuration
check_only- if true the configuration is verified only, not applied
Exceptions
ConfigErrorif any issues are encountered.

Definition at line 132 of file bin/agent/simple_parser.cc.

References isc::hooks::HooksConfig::get(), isc::data::SimpleParser::getBoolean(), isc::data::SimpleParser::getString(), isc::hooks::HooksConfig::loadLibraries(), isc::hooks::HooksLibrariesParser::parse(), and isc::hooks::HooksConfig::verifyLibraries().

Referenced by isc::agent::CtrlAgentCfgMgr::parse().

+ Here is the call graph for this function:

◆ setAllDefaults()

size_t isc::agent::AgentSimpleParser::setAllDefaults ( const isc::data::ElementPtr global)
static

Sets all defaults for Control Agent configuration.


This method sets global, option data and option definitions defaults.

Parameters
globalscope to be filled in with defaults.
Returns
number of default values added

Definition at line 67 of file bin/agent/simple_parser.cc.

References isc::data::SimpleParser::setDefaults().

Referenced by isc::agent::CtrlAgentCfgMgr::parse().

+ Here is the call graph for this function:

Member Data Documentation

◆ AGENT_DEFAULTS

const SimpleDefaults isc::agent::AgentSimpleParser::AGENT_DEFAULTS
static
Initial value:
= {
{ "http-host", Element::string, "127.0.0.1" },
{ "http-port", Element::integer, "8000" },
{ "trust-anchor", Element::string, "" },
{ "cert-file", Element::string, "" },
{ "key-file", Element::string, "" },
{ "cert-required", Element::boolean, "true" }
}

This table defines default values for global options.

These are global Control Agent parameters.

Definition at line 51 of file bin/agent/simple_parser.h.

◆ AUTH_DEFAULTS

const SimpleDefaults isc::agent::AgentSimpleParser::AUTH_DEFAULTS
static
Initial value:
= {
{ "type", Element::string, "basic" },
{ "realm", Element::string, "kea-control-agent" },
{ "directory", Element::string, "" }
}

This table defines default values for authentication.

Definition at line 52 of file bin/agent/simple_parser.h.

◆ SOCKET_DEFAULTS

const SimpleDefaults isc::agent::AgentSimpleParser::SOCKET_DEFAULTS
static
Initial value:
= {
{ "socket-type", Element::string, "unix" }
}

This table defines default values for control sockets.

Definition at line 53 of file bin/agent/simple_parser.h.


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