14#include <boost/algorithm/string/split.hpp>
15#include <boost/algorithm/string/classification.hpp>
16#include <boost/make_shared.hpp>
28 const std::string& formatted_value,
30 return (boost::make_shared<OptionDescriptor>(opt, persist, formatted_value,
36 return (boost::make_shared<OptionDescriptor>(persist));
41 return (boost::make_shared<OptionDescriptor>(desc));
57 return (options_.
empty() && vendor_options_.
empty());
62 return (options_.
equals(other.options_) &&
63 vendor_options_.
equals(other.vendor_options_));
68 const std::string& option_space,
74 add(desc, option_space);
84 << option_space <<
"'");
89 vendor_options_.
addItem(desc, vendor_id);
91 options_.
addItem(desc, option_space);
105 <<
" does not exist");
110 OptionContainerTypeIndex::const_iterator od_itr = idx.find(desc.
option_->getType());
111 if (od_itr == idx.end()) {
113 << option_space <<
":" << desc.
option_->getType()
114 <<
", it does not exist");
117 idx.replace(od_itr, desc);
121std::list<std::string>
124 std::list<std::string> names;
125 for (std::list<uint32_t>::const_iterator
id = ids.begin();
126 id != ids.end(); ++
id) {
127 std::ostringstream s;
130 s <<
"vendor-" << *id;
131 names.push_back(s.str());
157 for (
auto opt_desc : *(
getAll(space))) {
171 "validateCreateOption: descriptor has no option instance");
175 uint16_t code = opt_desc.
option_->getType();
193 def = cfg_def->get(space, code);
198 if (!formatted_value.empty()) {
200 <<
" has a formatted value: '" << formatted_value
201 <<
"' but no option definition");
213 if (formatted_value.empty()) {
215 opt_desc.
option_ = def->optionFactory(universe, code, opt_desc.
option_->getData());
218 std::vector<std::string> split_vec;
219 boost::split(split_vec, formatted_value, boost::is_any_of(
","));
220 opt_desc.
option_ = def->optionFactory(universe, code, split_vec);
222 }
catch (
const std::exception& ex) {
224 <<
" from data specified, reason: " << ex.
what());
234 mergeInternal(options_, other.options_);
236 mergeInternal(vendor_options_, other.vendor_options_);
256CfgOption::encapsulateInternal(
const std::string& option_space) {
261 for (OptionContainer::const_iterator opt = options->begin();
262 opt != options->end(); ++opt) {
263 encapsulateInternal(opt->option_);
268CfgOption::encapsulateInternal(
const OptionPtr& option) {
270 const std::string& encap_space = option->getEncapsulatedSpace();
272 if (!encap_space.empty()) {
275 for (OptionContainer::const_iterator encap_opt =
276 encap_options->begin(); encap_opt != encap_options->end();
279 if (!option->getOption(encap_opt->option_->getType())) {
280 option->addOption(encap_opt->option_);
287 encapsulateInternal(encap_opt->option_);
293template <
typename Selector>
296 OptionDescriptor, Selector>& src_container,
298 OptionDescriptor, Selector>& dest_container)
const {
300 std::list<Selector> selectors = src_container.getOptionSpaceNames();
305 for (
typename std::list<Selector>::const_iterator it = selectors.begin();
306 it != selectors.end(); ++it) {
314 for (OptionContainer::const_iterator src_opt = src_all->begin();
315 src_opt != src_all->end(); ++src_opt) {
318 idx.equal_range(src_opt->option_->getType());
321 if (std::distance(range.first, range.second) == 0) {
322 dest_container.addItem(OptionDescriptor(*src_opt), *it);
331 return (options_.
getItems(option_space));
336 return (vendor_options_.
getItems(vendor_id));
343 if (!options || options->empty()) {
355 for (
auto option_space_from_list : option_space_names) {
357 auto options_in_space =
getAll(option_space_from_list);
358 for (
auto option_it = options_in_space->begin();
359 option_it != options_in_space->end();
364 if (option_it->option_ &&
365 (option_it->option_->getEncapsulatedSpace() == option_space)) {
366 option_it->option_->delOption(option_code);
372 auto& idx = options->get<1>();
373 return (idx.erase(option_code));
380 if (!vendor_options || vendor_options->empty()) {
385 auto& idx = vendor_options->get<1>();
386 return (idx.erase(option_code));
396 auto options =
getAll(space_name);
397 for (
auto option_it = options->begin(); option_it != options->end();
399 if (!option_it->option_) {
405 auto sub_options = option_it->option_->getOptions();
406 for (
auto sub = sub_options.begin(); sub != sub_options.end();
409 option_it->option_->delOption(sub->second->getType());
422 return (num_deleted);
436 for (std::list<std::string>::const_iterator name = names.begin();
437 name != names.end(); ++name) {
439 for (OptionContainer::const_iterator opt = opts->begin();
440 opt != opts->end(); ++opt) {
444 opt->contextToElement(map);
446 map->set(
"space", Element::create(*name));
448 uint16_t code = opt->option_->getType();
449 map->set(
"code", Element::create(code));
459 map->set(
"name", Element::create(def->getName()));
462 if (!opt->formatted_value_.empty()) {
463 map->set(
"csv-format", Element::create(
true));
464 map->set(
"data", Element::create(opt->formatted_value_));
466 map->set(
"csv-format", Element::create(
false));
467 std::vector<uint8_t> bin = opt->option_->toBinary();
469 map->set(
"data", Element::create(repr));
472 map->set(
"always-send", Element::create(opt->persistent_));
475 if (include_metadata) {
476 map->set(
"metadata", opt->getMetadata());
485 for (std::list<uint32_t>::const_iterator
id = ids.begin();
486 id != ids.end(); ++
id) {
488 for (OptionContainer::const_iterator opt = opts->begin();
489 opt != opts->end(); ++opt) {
493 opt->contextToElement(map);
495 std::ostringstream oss;
496 oss <<
"vendor-" << *id;
497 map->set(
"space", Element::create(oss.str()));
499 uint16_t code = opt->option_->getType();
500 map->set(
"code", Element::create(code));
510 map->set(
"name", Element::create(def->getName()));
513 if (!opt->formatted_value_.empty()) {
514 map->set(
"csv-format", Element::create(
true));
515 map->set(
"data", Element::create(opt->formatted_value_));
517 map->set(
"csv-format", Element::create(
false));
518 std::vector<uint8_t> bin = opt->option_->toBinary();
520 map->set(
"data", Element::create(repr));
523 map->set(
"always-send", Element::create(opt->persistent_));
A generic exception that is thrown if a parameter given to a method is considered invalid in that con...
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
A generic exception that is thrown if a function is called in a prohibited way.
void setId(const uint64_t id)
Sets element's database identifier.
Represents option data configuration for the DHCP server.
void encapsulate()
Appends encapsulated options to top-level options.
void replace(const OptionDescriptor &desc, const std::string &option_space)
Replaces the instance of an option within this collection.
static bool createDescriptorOption(CfgOptionDefPtr cfg_def, const std::string &space, OptionDescriptor &opt_desc)
Creates an option descriptor's option based on a set of option defs.
virtual isc::data::ElementPtr toElement() const
Unparse a configuration object.
void createOptions(CfgOptionDefPtr cfg_def)
Re-create the option in each descriptor based on given definitions.
isc::data::ElementPtr toElementWithMetadata(const bool include_metadata) const
Unparse a configuration object with optionally including the metadata.
size_t del(const std::string &option_space, const uint16_t option_code)
Deletes option for the specified option space and option code.
std::list< std::string > getOptionSpaceNames() const
Returns a list of configured option space names.
bool empty() const
Indicates the object is empty.
void mergeTo(CfgOption &other) const
Merges this configuration to another configuration.
void copyTo(CfgOption &other) const
Copies this configuration to another configuration.
CfgOption()
default constructor
std::list< std::string > getVendorIdsSpaceNames() const
Returns a list of option space names for configured vendor ids.
OptionContainerPtr getAll(const std::string &option_space) const
Returns all options for the specified option space.
void merge(CfgOptionDefPtr cfg_def, CfgOption &other)
Merges another option configuration into this one.
void add(const OptionPtr &option, const bool persistent, const std::string &option_space, const uint64_t id=0)
Adds instance of the option to the configuration.
bool equals(const CfgOption &other) const
Check if configuration is equal to other configuration.
std::list< uint32_t > getVendorIds() const
Returns a list of all configured vendor identifiers.
static OptionDefinitionPtr getOptionDef(const std::string &space, const uint16_t code)
Return the first option definition matching a particular option code.
static OptionDefinitionPtr getVendorOptionDef(const Option::Universe u, const uint32_t vendor_id, const uint16_t code)
Returns vendor option definition for a given vendor-id and code.
static uint32_t optionSpaceToVendorId(const std::string &option_space)
Converts option space name to vendor id.
static OptionDefinitionPtr getRuntimeOptionDef(const std::string &space, const uint16_t code)
Returns runtime (non-standard) option definition by space and option code.
static OptionDefinitionPtr getLastResortOptionDef(const std::string &space, const uint16_t code)
Returns last resort option definition by space and option code.
OptionPtr option_
Option instance.
std::string space_name_
Option space name.
bool equals(const OptionDescriptor &other) const
Checks if the one descriptor is equal to another.
std::string formatted_value_
Option value in textual (CSV) format.
static OptionDescriptorPtr create(const OptionPtr &opt, bool persist, const std::string &formatted_value="", data::ConstElementPtr user_context=data::ConstElementPtr())
Factory function creating an instance of the OptionDescriptor.
bool persistent_
Persistence flag.
uint64_t deleteItems(const uint64_t id)
Remove all options or option definitions with a given database identifier.
void addItem(const ItemType &item, const Selector &option_space)
Adds a new item to the option_space.
bool empty() const
Indicates the container is empty.
void clearItems()
Remove all items from the container.
std::list< Selector > getOptionSpaceNames() const
Get a list of existing option spaces.
ItemsContainerPtr getItems(const Selector &option_space) const
Get all items for the particular option space.
bool equals(const OptionSpaceContainer &other) const
Check if two containers are equal.
static bool validateName(const std::string &name)
Checks that the provided option space name is valid.
Universe
defines option universe DHCPv4 or DHCPv6
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
boost::shared_ptr< const Element > ConstElementPtr
boost::shared_ptr< Element > ElementPtr
std::pair< OptionContainerTypeIndex::const_iterator, OptionContainerTypeIndex::const_iterator > OptionContainerTypeRange
Pair of iterators to represent the range of options having the same option type value.
OptionContainer::nth_index< 1 >::type OptionContainerTypeIndex
Type of the index #1 - option type.
boost::shared_ptr< CfgOptionDef > CfgOptionDefPtr
Non-const pointer.
boost::shared_ptr< OptionDefinition > OptionDefinitionPtr
Pointer to option definition object.
boost::multi_index_container< OptionDescriptor, boost::multi_index::indexed_by< boost::multi_index::sequenced<>, boost::multi_index::hashed_non_unique< KeyFromKeyExtractor< boost::multi_index::const_mem_fun< Option, uint16_t, &Option::getType >, boost::multi_index::member< OptionDescriptor, OptionPtr, &OptionDescriptor::option_ > > >, boost::multi_index::hashed_non_unique< boost::multi_index::member< OptionDescriptor, bool, &OptionDescriptor::persistent_ > >, boost::multi_index::ordered_non_unique< boost::multi_index::const_mem_fun< data::BaseStampedElement, boost::posix_time::ptime, &data::BaseStampedElement::getModificationTime > >, boost::multi_index::hashed_non_unique< boost::multi_index::tag< OptionIdIndexTag >, boost::multi_index::const_mem_fun< data::BaseStampedElement, uint64_t, &data::BaseStampedElement::getId > > > > OptionContainer
Multi index container for DHCP option descriptors.
boost::shared_ptr< OptionDescriptor > OptionDescriptorPtr
A pointer to option descriptor.
boost::shared_ptr< OptionContainer > OptionContainerPtr
Pointer to the OptionContainer object.
boost::shared_ptr< Option > OptionPtr
string encodeHex(const vector< uint8_t > &binary)
Encode binary data in the base16 ('hex') format.
Defines the logger used by the top-level component of kea-lfc.
#define DHCP4_OPTION_SPACE
global std option spaces
#define DHCP6_OPTION_SPACE