// 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 HTTP_COMMAND_RESPONSE_CREATOR_H
#define HTTP_COMMAND_RESPONSE_CREATOR_H

#include <config/http_command_config.h>
#include <http/response_creator.h>
#include <boost/shared_ptr.hpp>

namespace isc {
namespace config {

/// @brief Concrete implementation of the HTTP response creator used
/// for HTTP control socket.
///
/// See the documentation of the @ref isc::http::HttpResponseCreator for
/// the basic information how HTTP response creators are utilized by
/// the libkea-http library to generate HTTP responses.
///
/// This creator expects that received requests are encapsulated in the
/// @ref isc::http::PostHttpRequestJson objects. The generated responses
/// are encapsulated in the HttpResponseJson objects.
///
/// This class uses @ref CommandMgr singleton to process commands
/// conveyed in the HTTP body. The JSON responses returned by the manager
/// are placed in the body of the generated HTTP responses.
class HttpCommandResponseCreator : public http::HttpResponseCreator {
public:

    /// @brief Constructor
    ///
    /// @param config The HTTP control socket config.
    HttpCommandResponseCreator(HttpCommandConfigPtr config) : config_(config) {
    }

    /// @brief virtual destructor.
    virtual ~HttpCommandResponseCreator() = default;

    /// @brief Create a new request.
    ///
    /// This method creates a bare instance of the @ref
    /// isc::http::PostHttpRequestJson.
    ///
    /// @return Pointer to the new instance of the @ref
    /// isc::http::PostHttpRequestJson.
    virtual http::HttpRequestPtr createNewHttpRequest() const;

    /// @brief Creates stock HTTP response.
    ///
    /// @param request Pointer to an object representing HTTP request.
    /// @param status_code Status code of the response.
    /// @return Pointer to an @ref isc::http::HttpResponseJson object
    /// representing stock HTTP response.
    virtual http::HttpResponsePtr
    createStockHttpResponse(const http::HttpRequestPtr& request,
                            const http::HttpStatusCode& status_code) const;

    /// @brief Returns HTTP control socket config.
    HttpCommandConfigPtr getHttpCommandConfig() const {
        return (config_);
    }

private:

    /// @brief Creates un-finalized stock HTTP response.
    ///
    /// The un-finalized response is the response that can't be sent over the
    /// wire until @c finalize() is called, which commits the contents of the
    /// message body.
    ///
    /// @param request Pointer to an object representing HTTP request.
    /// @param status_code Status code of the response.
    /// @return Pointer to an @ref isc::http::HttpResponseJson object
    /// representing stock HTTP response.
    http::HttpResponsePtr
    createStockHttpResponseInternal(const http::HttpRequestPtr& request,
                                    const http::HttpStatusCode& status_code) const;

    /// @brief Creates implementation specific HTTP response.
    ///
    /// @param request Pointer to an object representing HTTP request.
    /// @return Pointer to an object representing HTTP response.
    virtual http::HttpResponsePtr
    createDynamicHttpResponse(http::HttpRequestPtr request);

    /// @brief Checks the services argument.
    ///
    /// If the command includes a services argument it must match the response
    /// creator's service name. If not an error response is returned.
    ///
    /// @param command The command.
    /// @return A response with the error or null.
    data::ConstElementPtr checkService(data::ConstElementPtr command) const;

    /// @brief Returns HTTP control socket config.
    ///
    /// Used for HTTP authentication.
    HttpCommandConfigPtr config_;
};

/// @brief Pointer to the @ref HttpCommandResponseCreator.
typedef boost::shared_ptr<HttpCommandResponseCreator>
    HttpCommandResponseCreatorPtr;

} // end of namespace isc::config
} // end of namespace isc

#endif
