base_command_mgr.h

Go to the documentation of this file.

// Copyright (C) 2017-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 BASE_COMMAND_MGR_H
#define BASE_COMMAND_MGR_H
 
#include <cc/data.h>
#include <exceptions/exceptions.h>
#include <functional>
#include <map>
#include <string>
 
namespace isc {
namespace config {
 
class InvalidCommandHandler : public Exception {
public:
    InvalidCommandHandler(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { }
};
 
class InvalidCommandName : public Exception {
public:
    InvalidCommandName(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { }
};
 
class BaseCommandMgr {
public:
 
    typedef std::function<isc::data::ConstElementPtr (const std::string& name,
        const isc::data::ConstElementPtr& params)> CommandHandler;
 
    typedef std::function<isc::data::ConstElementPtr (const std::string& name,
        const isc::data::ConstElementPtr& params,
        const isc::data::ConstElementPtr& original)> ExtendedCommandHandler;
 
    BaseCommandMgr();
 
    virtual ~BaseCommandMgr() { }
 
    virtual isc::data::ConstElementPtr
    processCommand(const isc::data::ConstElementPtr& cmd);
 
    void registerCommand(const std::string& cmd, CommandHandler handler);
 
    void registerExtendedCommand(const std::string& cmd,
                                 ExtendedCommandHandler handler);
 
    void deregisterCommand(const std::string& cmd);
 
    void deregisterAll();
 
    // representation of the structure.
    static std::string getHash(const isc::data::ConstElementPtr& config);
 
protected:
 
    virtual isc::data::ConstElementPtr
    handleCommand(const std::string& cmd_name,
                  const isc::data::ConstElementPtr& params,
                  const isc::data::ConstElementPtr& original_cmd);
 
    struct HandlersPair {
        CommandHandler handler;
        ExtendedCommandHandler extended_handler;
    };
 
    typedef std::map<std::string, HandlersPair> HandlerContainer;
 
    HandlerContainer handlers_;
 
private:
 
    isc::data::ConstElementPtr
    listCommandsHandler(const std::string& name,
                        const isc::data::ConstElementPtr& params);
};
 
} // end of namespace isc::config
} // end of namespace isc
 
#endif