config_ctl_info.h

Go to the documentation of this file.

// Copyright (C) 2018-2024 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 PROCESS_CONFIG_CTL_INFO_H
#define PROCESS_CONFIG_CTL_INFO_H
 
#include <cc/cfg_to_element.h>
#include <database/database_connection.h>
#include <util/optional.h>
 
#include <boost/shared_ptr.hpp>
#include <stdint.h>
#include <vector>
 
namespace isc {
namespace process {
 
class ConfigDbInfo : public isc::data::CfgToElement {
public:
    ConfigDbInfo() {}
 
    void setAccessString(const std::string& access_str, bool test_mode = false);
 
    std::string getAccessString() const {
        return (access_str_);
    }
 
    std::string redactedAccessString() const {
        return (db::DatabaseConnection::redactedAccessString(access_params_));
    }
 
    const db::DatabaseConnection::ParameterMap& getParameters() const {
        return (access_params_);
    }
 
    bool getParameterValue(const std::string& name,
                           std::string& value) const;
 
    virtual isc::data::ElementPtr toElement() const;
 
    bool equals(const ConfigDbInfo& other) const;
 
    bool operator==(const ConfigDbInfo& other) const {
        return (equals(other));
    }
 
    bool operator!=(const ConfigDbInfo& other) const {
        return (!equals(other));
    }
 
private:
    std::string access_str_;
 
    db::DatabaseConnection::ParameterMap access_params_;
};
 
typedef std::vector<ConfigDbInfo> ConfigDbInfoList;
 
class ConfigControlInfo : public isc::data::CfgToElement {
public:
 
    ConfigControlInfo()
        : config_fetch_wait_time_(30, true) {}
 
    ConfigControlInfo(const ConfigControlInfo& other);
 
    void setConfigFetchWaitTime(const util::Optional<uint16_t>& config_fetch_wait_time) {
        config_fetch_wait_time_ = config_fetch_wait_time;
    }
 
    const util::Optional<uint16_t>& getConfigFetchWaitTime() const {
        return (config_fetch_wait_time_);
    }
 
    void addConfigDatabase(const std::string& access_str);
 
    const ConfigDbInfoList& getConfigDatabases() const {
        return (db_infos_);
    }
 
    const ConfigDbInfo& findConfigDb(const std::string& param_name,
                                     const std::string& param_value);
 
    void clear();
 
    void merge(const ConfigControlInfo& other);
 
    virtual isc::data::ElementPtr toElement() const;
 
    static const ConfigDbInfo& EMPTY_DB();
 
    bool equals(const ConfigControlInfo& other) const;
 
private:
 
    util::Optional<uint16_t> config_fetch_wait_time_;
 
    ConfigDbInfoList db_infos_;
};
 
typedef boost::shared_ptr<ConfigControlInfo> ConfigControlInfoPtr;
 
typedef boost::shared_ptr<const ConfigControlInfo> ConstConfigControlInfoPtr;
 
} // namespace process
} // end namespace isc
 
#endif // PROCESS_CONFIG_CTL_INFO_H