cmd_response_creator.h

Go to the documentation of this file.

// Copyright (C) 2021-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 CMD__RESPONSE_CREATOR_H
#define CMD__RESPONSE_CREATOR_H
 
#include <http/response_creator.h>
#include <http/basic_auth_config.h>
#include <boost/shared_ptr.hpp>
#include <unordered_set>
 
namespace isc {
namespace config {

class CmdResponseCreator : public http::HttpResponseCreator {
public:

    CmdResponseCreator(http::HttpAuthConfigPtr http_auth_config,
                       std::unordered_set<std::string> command_accept_list) :
        http::HttpResponseCreator(), http_auth_config_(http_auth_config),
        command_accept_list_(command_accept_list) {
    }

    virtual ~CmdResponseCreator() = default;

    virtual http::HttpRequestPtr createNewHttpRequest() const;

    virtual http::HttpResponsePtr
    createStockHttpResponse(const http::HttpRequestPtr& request,
                            const http::HttpStatusCode& status_code) const;

    http::HttpResponseJsonPtr
    filterCommand(const http::HttpRequestPtr& request,
                  const data::ConstElementPtr& body,
                  const std::unordered_set<std::string>& accept);

    static bool EMULATE_AGENT_RESPONSE;

    http::HttpAuthConfigPtr getAuthConfig() const {
        return (http_auth_config_);
    }

    std::unordered_set<std::string> getCommandAcceptList() const {
        return (command_accept_list_);
    }
 
private:

    http::HttpResponsePtr
    createStockHttpResponseInternal(const http::HttpRequestPtr& request,
                                    const http::HttpStatusCode& status_code) const;

    virtual http::HttpResponsePtr
    createDynamicHttpResponse(http::HttpRequestPtr request);

    http::HttpAuthConfigPtr http_auth_config_;

    std::unordered_set<std::string> command_accept_list_;
};

typedef boost::shared_ptr<CmdResponseCreator> CmdResponseCreatorPtr;
 
} // end of namespace isc::config
} // end of namespace isc
 
#endif