Kea  2.1.7-git
isc::dhcp::ClientClassDefParser Class Reference

Parser for a single client class definition. More...

#include <client_class_def_parser.h>

+ Inheritance diagram for isc::dhcp::ClientClassDefParser:

Public Member Functions

virtual ~ClientClassDefParser ()
 Virtual destructor. More...
 
void checkParametersSupported (const isc::data::ConstElementPtr &class_def_cfg, const uint16_t family)
 Iterates over class parameters and checks if they are supported. More...
 
void parse (ClientClassDictionaryPtr &class_dictionary, isc::data::ConstElementPtr client_class_def, uint16_t family, bool append_error_position=true, bool check_dependencies=true)
 Parses an entry that describes single client class definition. 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...
 

Protected Member Functions

virtual boost::shared_ptr< OptionDataListParsercreateOptionDataListParser (const uint16_t address_family, CfgOptionDefPtr cfg_option_def) const
 Returns an instance of the OptionDataListParser to be used in parsing the option-data structure. More...
 
- 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...
 

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. 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...
 

Detailed Description

Parser for a single client class definition.

This parser creates an instance of a client class definition.

Definition at line 84 of file client_class_def_parser.h.

Constructor & Destructor Documentation

◆ ~ClientClassDefParser()

virtual isc::dhcp::ClientClassDefParser::~ClientClassDefParser ( )
inlinevirtual

Virtual destructor.

Definition at line 88 of file client_class_def_parser.h.

References isc::dhcp::ExpressionParser::parse().

+ Here is the call graph for this function:

Member Function Documentation

◆ checkParametersSupported()

void isc::dhcp::ClientClassDefParser::checkParametersSupported ( const isc::data::ConstElementPtr class_def_cfg,
const uint16_t  family 
)

Iterates over class parameters and checks if they are supported.

This method should be called by hooks libraries which do not use Bison to validate class syntax prior to parsing the client class information.

Parameters
class_def_cfgclass configuration entry.
familythe address family of the client class.
Exceptions
DhcpConfigErrorif any of the parameters is not supported.

Definition at line 261 of file client_class_def_parser.cc.

References isc_throw, and isc::data::Element::map.

◆ createOptionDataListParser()

boost::shared_ptr< OptionDataListParser > isc::dhcp::ClientClassDefParser::createOptionDataListParser ( const uint16_t  address_family,
CfgOptionDefPtr  cfg_option_def 
) const
protectedvirtual

Returns an instance of the OptionDataListParser to be used in parsing the option-data structure.

This function can be overridden in the child classes to supply a custom parser for option data.

Parameters
address_familyAF_INET (for DHCPv4) or AF_INET6 (for DHCPv6).
cfg_option_defstructure holding option definitions.
Returns
an instance of the OptionDataListParser.

Definition at line 304 of file client_class_def_parser.cc.

◆ parse()

void isc::dhcp::ClientClassDefParser::parse ( ClientClassDictionaryPtr class_dictionary,
isc::data::ConstElementPtr  client_class_def,
uint16_t  family,
bool  append_error_position = true,
bool  check_dependencies = true 
)

Parses an entry that describes single client class definition.

Attempts to add the new class directly into the given dictionary. This done here to detect duplicate classes prior to commit().

Parameters
class_dictionarydictionary into which the class should be added
client_class_defa configuration entry to be parsed.
familythe address family of the client class.
append_error_positionBoolean flag indicating if position of the parsed string within parsed JSON should be appended. The default setting is to append it, but it is typically set to false when this parser is used by hooks libraries.
check_dependenciesindicates if the parser should evaluate an expression to see if the referenced client classes exist.
Exceptions
DhcpConfigErrorif parsing was unsuccessful.

Definition at line 70 of file client_class_def_parser.cc.

References isc::dhcp::builtinNames, isc::asiolink::IOAddress::getFamily(), isc_throw, isc::dhcp::isClientClassDefined(), isc::asiolink::IOAddress::isV4Bcast(), isc::data::Element::map, isc::dhcp::ExpressionParser::parse(), isc::dhcp::OptionDefParser::parse(), isc::data::SimpleParser::setListDefaults(), and isc::Exception::what().

Referenced by isc::dhcp::ClientClassDefListParser::parse().

+ Here is the call graph for this function:

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