Kea 2.5.9
isc::d2::DnsServerInfoParser Class Reference

Parser for DnsServerInfo. More...

#include <d2_config.h>

+ Inheritance diagram for isc::d2::DnsServerInfoParser:

Public Member Functions

DnsServerInfoPtr parse (data::ConstElementPtr server_config, data::ConstElementPtr domain_config, const TSIGKeyInfoMapPtr keys)
 Performs the actual parsing of the given "dns-server" element.
 
- 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.
 
uint32_t getUint32 (isc::data::ConstElementPtr scope, const std::string &name)
 Returns a value converted to uint32_t.
 
uint8_t getUint8 (ConstElementPtr scope, const std::string &name)
 Get an uint8_t value.
 
const isc::util::Triplet< uint32_t > parseIntTriplet (const data::ConstElementPtr &scope, const std::string &name)
 Parses an integer triplet.
 

Additional Inherited Members

- 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.
 
static void checkRequired (const SimpleRequiredKeywords &required, isc::data::ConstElementPtr scope)
 Checks that all required keywords are present.
 
static size_t deriveParams (isc::data::ConstElementPtr parent, isc::data::ElementPtr child, const ParamsList &params)
 Derives (inherits) parameters from parent scope to a child.
 
static isc::asiolink::IOAddress getAddress (const ConstElementPtr &scope, const std::string &name)
 Returns a IOAddress parameter from a scope.
 
static bool getBoolean (isc::data::ConstElementPtr scope, const std::string &name)
 Returns a boolean parameter from a scope.
 
static double getDouble (const ConstElementPtr &scope, const std::string &name)
 Returns a floating point parameter from a scope.
 
static int64_t getInteger (isc::data::ConstElementPtr scope, const std::string &name)
 Returns an integer parameter from a scope.
 
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.
 
static const data::Element::PositiongetPosition (const std::string &name, const data::ConstElementPtr parent)
 Utility method that returns position of an element.
 
static std::string getString (isc::data::ConstElementPtr scope, const std::string &name)
 Returns a string parameter from a scope.
 
static size_t setDefaults (isc::data::ElementPtr scope, const SimpleDefaults &default_values)
 Sets the default values.
 
static size_t setListDefaults (isc::data::ConstElementPtr list, const SimpleDefaults &default_values)
 Sets the default values for all entries in a list.
 
- 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.
 
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.
 

Detailed Description

Parser for DnsServerInfo.

This class parses the configuration element "dns-server" and creates an instance of a DnsServerInfo.

Definition at line 821 of file d2_config.h.

Member Function Documentation

◆ parse()

DnsServerInfoPtr isc::d2::DnsServerInfoParser::parse ( data::ConstElementPtr  server_config,
data::ConstElementPtr  domain_config,
const TSIGKeyInfoMapPtr  keys 
)

Performs the actual parsing of the given "dns-server" element.

Parses a configuration for the elements needed to instantiate a DnsServerInfo, validates those entries, creates a DnsServerInfo instance and returns it.

Parameters
server_configis the "dns-server" configuration to parse
domain_configthe parent domain's configuration
keysmap of defined TSIG keys
Returns
a pointer to the newly created server instance
Exceptions
D2CfgErrorif:
  1. hostname is not blank, hostname is not yet supported
  2. ip_address is invalid
  3. port is 0
Todo:
when resolvable hostname is supported we create the entry as follows:
// When hostname is specified, create a valid, blank IOAddress
// and then create the DnsServerInfo.
serverInfo.reset(new DnsServerInfo(hostname, io_addr, port));
Represents a specific DNS Server.
Definition: d2_config.h:431

Resolution will be done prior to connection during transaction processing. Until then we'll throw unsupported.

Definition at line 500 of file d2_config.cc.

References isc::data::SimpleParser::getInteger(), isc::data::SimpleParser::getPosition(), isc::data::SimpleParser::getString(), and isc_throw.

Referenced by isc::d2::DnsServerInfoListParser::parse().

+ Here is the call graph for this function:

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