Kea 2.5.8
isc::d2::TSIGKeyInfoListParser Class Reference

Parser for a list of TSIGKeyInfos. More...

#include <d2_config.h>

+ Inheritance diagram for isc::d2::TSIGKeyInfoListParser:

Public Member Functions

TSIGKeyInfoMapPtr parse (data::ConstElementPtr key_list_config)
 Performs the parsing of the given list "tsig-key" elements.
 
- 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 a list of TSIGKeyInfos.

This class parses a list of "tsig-key" configuration elements. The TSIGKeyInfo instances are added to the given storage upon commit.

Definition at line 788 of file d2_config.h.

Member Function Documentation

◆ parse()

TSIGKeyInfoMapPtr isc::d2::TSIGKeyInfoListParser::parse ( data::ConstElementPtr  key_list_config)

Performs the parsing of the given list "tsig-key" elements.

Creates an empty TSIGKeyInfoMap

Instantiates a TSIGKeyInfoParser It iterates over each key entry in the list:

  1. Pass the element configuration to the parser's parse method
  2. Add the new TSIGKeyInfo instance to the key map
Parameters
key_list_configis the list of "tsig_key" elements to parse.
Returns
a map containing the TSIGKeyInfo instances

Definition at line 454 of file d2_config.cc.

References isc::data::SimpleParser::getPosition(), isc_throw, and isc::d2::TSIGKeyInfoParser::parse().

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

+ Here is the call graph for this function:

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