d_cfg_mgr.h

Go to the documentation of this file.

// Copyright (C) 2013-2026 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 D_CFG_MGR_H
#define D_CFG_MGR_H
 
#include <cc/data.h>
#include <cc/cfg_to_element.h>
#include <cc/user_context.h>
#include <process/config_base.h>
#include <exceptions/exceptions.h>
 
#include <stdint.h>
 
#include <functional>
#include <list>
#include <string>
 
namespace isc {
namespace process {

typedef std::map<std::string, isc::data::ConstElementPtr> ElementMap;

class DCfgMgrBaseError : public isc::Exception {
public:
    DCfgMgrBaseError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { }
};

class DCfgMgrBase {
public:
    DCfgMgrBase(ConfigPtr context);

    virtual ~DCfgMgrBase();

    isc::data::ConstElementPtr
    simpleParseConfig(isc::data::ConstElementPtr config,
                      bool check_only = false,
                      const std::function<void()>& post_config_cb = nullptr);

    ConfigPtr& getContext() {
        return (context_);
    }

    virtual std::string getConfigSummary(const uint32_t selection) = 0;

    isc::data::ConstElementPtr
    redactConfig(isc::data::ConstElementPtr const& config) const;
 
protected:
    virtual void setCfgDefaults(isc::data::ElementPtr mutable_config);

    virtual ConfigPtr createNewContext() = 0;

    void resetContext();

    void setContext(ConfigPtr& context);

    virtual isc::data::ConstElementPtr parse(isc::data::ConstElementPtr config,
                                             bool check_only);

    virtual std::list<std::list<std::string>> jsonPathsToRedact() const;
 
private:
    ConfigPtr context_;
};

typedef boost::shared_ptr<DCfgMgrBase> DCfgMgrBasePtr;
 
} // end of isc::process namespace
} // end of isc namespace
 
#endif // D_CFG_MGR_H