Kea 2.7.5
host_data_source_factory.h
Go to the documentation of this file.
1// Copyright (C) 2015-2024 Internet Systems Consortium, Inc. ("ISC")
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7#ifndef HOST_DATA_SOURCE_FACTORY_H
8#define HOST_DATA_SOURCE_FACTORY_H
9
13
14#include <functional>
15#include <string>
16#include <vector>
17#include <map>
18
19namespace isc {
20namespace dhcp {
21
27public:
28 NoHostDataSourceManager(const char* file, size_t line, const char* what) :
29 isc::Exception(file, line, what) {}
30};
31
41
43public:
65 static void add(HostDataSourceList& sources, const std::string& dbaccess);
66
75 static bool del(HostDataSourceList& sources, const std::string& db_type);
76
93 static bool del(HostDataSourceList& sources, const std::string& db_type,
94 const std::string& dbaccess, bool if_unusable = true);
95
101
103 typedef std::function<std::string ()> DBVersion;
104
117 static bool registerFactory(const std::string& db_type,
118 const Factory& factory,
119 bool no_log = false,
120 DBVersion db_version = DBVersion());
121
131 static bool deregisterFactory(const std::string& db_type,
132 bool no_log = false);
133
138 static bool registeredFactory(const std::string& db_type);
139
145 static void logRegistered();
146
148 static std::list<std::string> getDBVersions();
149
150private:
152 static std::map<std::string, std::pair<Factory, DBVersion>> map_;
153};
154
155} // end of isc::dhcp namespace
156} // end of isc namespace
157
158#endif
This is a base class for exceptions thrown from the DNS library module.
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
std::map< std::string, std::string > ParameterMap
Database configuration parameter map.
static void logRegistered()
Logs out all registered backends.
static bool deregisterFactory(const std::string &db_type, bool no_log=false)
Deregister a host data source factory.
static void add(HostDataSourceList &sources, const std::string &dbaccess)
Create and add an instance of a host data source.
std::function< HostDataSourcePtr(const db::DatabaseConnection::ParameterMap &) Factory)
Type of host data source factory.
static bool registerFactory(const std::string &db_type, const Factory &factory, bool no_log=false, DBVersion db_version=DBVersion())
Register a host data source factory.
static std::list< std::string > getDBVersions()
Return extended version info for registered backends.
static bool del(HostDataSourceList &sources, const std::string &db_type)
Delete a host data source.
static bool registeredFactory(const std::string &db_type)
Check if a host data source factory was registered.
std::function< std::string()> DBVersion
Type of host mgr version.
No host data source instance exception.
NoHostDataSourceManager(const char *file, size_t line, const char *what)
boost::shared_ptr< BaseHostDataSource > HostDataSourcePtr
HostDataSource pointer.
std::vector< HostDataSourcePtr > HostDataSourceList
HostDataSource list.
Defines the logger used by the top-level component of kea-lfc.