blob: 2e55d20ea6de5eb02bee6b00c3b573409f489dbf (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
// Copyright (C) 2012-2019 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
#ifndef DBACCESS_PARSER_H
#define DBACCESS_PARSER_H
#include <cc/data.h>
#include <cc/simple_parser.h>
#include <database/database_connection.h>
#include <exceptions/exceptions.h>
#include <string>
namespace isc {
namespace db {
/// @brief Parse Database Parameters
///
/// This class is the parser for the database configuration. This is a
/// map under the top-level "lease-database", "host-database" and
/// "config-database" elements, and comprises a map of strings.
class DbAccessParser: public isc::data::SimpleParser {
public:
/// @brief Constructor
DbAccessParser();
/// The destructor.
virtual ~DbAccessParser()
{}
/// @brief Parse configuration value.
///
/// Parses the set of strings forming the database access specification and
/// checks that all are OK. In particular it checks:
///
/// - "type" is "memfile", "mysql" or "postgresql"
/// - "lfc-interval" is a number from the range of 0 to 4294967295.
/// - "connect-timeout" is a number from the range of 0 to 4294967295.
/// - "port" is a number from the range of 0 to 65535.
///
/// Once all has been validated, constructs the database access string.
///
/// @param [out] access_string Generated database access string.
/// @param database_config The configuration value for the "*-database"
/// identifier.
///
/// @throw isc::dhcp::DbConfigError The 'type' keyword contains an
/// unknown database type or is missing from the list of
/// database access keywords.
void parse(std::string& access_string,
isc::data::ConstElementPtr database_config);
/// @brief Get database access parameters
///
/// Used in testing to check that the configuration information has been
/// parsed correctly.
///
/// @return Reference to the internal map of keyword/value pairs
/// representing database access information. This is valid only
/// for so long as the the parser remains in existence.
const DatabaseConnection::ParameterMap& getDbAccessParameters() const {
return (values_);
}
protected:
/// @brief Construct database access string
///
/// Constructs the database access string from the stored parameters.
///
/// @return Database access string
std::string getDbAccessString() const;
private:
DatabaseConnection::ParameterMap values_; ///< Stored parameter values
};
} // namespace db
} // namespace isc
#endif // DBACCESS_PARSER_H
|
