netconf_config.h

Go to the documentation of this file.

// Copyright (C) 2018-2025 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 NETCONF_CONFIG_H
#define NETCONF_CONFIG_H
 
#include <cc/cfg_to_element.h>
#include <cc/data.h>
#include <cc/simple_parser.h>
#include <cc/user_context.h>
#include <exceptions/exceptions.h>
#include <http/url.h>
 
#include <cstdint>
#include <string>
#include <unordered_map>
 
namespace isc {
namespace netconf {


class CfgControlSocket : public isc::data::UserContext,
    public isc::data::CfgToElement {
public:
    enum Type {
        UNIX,    //< Unix socket.
        HTTP,    //< HTTP socket.
        STDOUT   //< standard output.
    };  // Type

    CfgControlSocket(Type type, const std::string& name,
                     const isc::http::Url& url);

    virtual ~CfgControlSocket() = default;

    Type getType() const {
        return (type_);
    }

    const std::string getName() const {
        return (name_);
    }

    const isc::http::Url getUrl() const {
        return (url_);
    }

    static Type stringToType(const std::string& type);

    static const std::string typeToString(CfgControlSocket::Type type);

    isc::data::ElementPtr toElement() const override final;
 
private:
    Type type_;

    const std::string name_;

    const isc::http::Url url_;
};  // CfgControlSocket

using CfgControlSocketPtr = std::shared_ptr<CfgControlSocket>;

class CfgServer : public isc::data::UserContext, public isc::data::CfgToElement {
public:
    CfgServer(const std::string& model, CfgControlSocketPtr ctrl_sock);

    virtual ~CfgServer() = default;

    const std::string getModel() const {
        return (model_);
    }

    const CfgControlSocketPtr& getCfgControlSocket() const {
        return (control_socket_);
    }

    bool getBootUpdate() const {
        return (boot_update_);
    }

    void setBootUpdate(bool boot_update) {
        boot_update_ = boot_update;
    }

    bool getSubscribeChanges() const {
        return (subscribe_changes_);
    }

    bool getSubscribeNotifications() const {
        return (subscribe_notifications_);
    }

    void setSubscribeChanges(bool subscribe_changes) {
        subscribe_changes_ = subscribe_changes;
    }

    void setSubscribeNotifications(bool subscribe_notifications) {
        subscribe_notifications_ = subscribe_notifications;
    }

    bool getValidateChanges() const {
        return (validate_changes_);
    }

    void setValidateChanges(bool validate_changes) {
        validate_changes_ = validate_changes;
    }

    std::string toText() const;

    isc::data::ElementPtr toElement() const override final;
 
private:
    const std::string model_;

    bool boot_update_;

    bool subscribe_changes_;

    bool subscribe_notifications_;

    bool validate_changes_;

    CfgControlSocketPtr control_socket_;
};  // CfgServer

using CfgServerPtr = std::shared_ptr<CfgServer>;

using CfgServersMap = std::unordered_map<std::string, CfgServerPtr>;

using CfgServersMapPair = std::pair<std::string, CfgServerPtr>;

using CfgServersMapPtr = std::shared_ptr<CfgServersMap>;

std::ostream& operator<<(std::ostream& os, const CfgServer& server);

class ControlSocketConfigParser : public data::SimpleParser {
public:
    CfgControlSocketPtr parse(data::ConstElementPtr ctrl_sock_config);
};  // ControlSocketConfigParser

class ServerConfigParser : public data::SimpleParser {
public:
    CfgServerPtr parse(data::ConstElementPtr server_config);
};  // ServerConfigParser
 
}  // namespace netconf
}  // namespace isc
 
#endif  // NETCONF_CONFIG_H