xref: /openbmc/bmcweb/features/redfish/include/redfish.hpp (revision 84aad24d55fb0e53128928961ac36242aabb799d)

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright OpenBMC Authors
#pragma once

#include "app.hpp"
#include "async_resp.hpp"
#include "http_request.hpp"
#include "redfish_oem_routing.hpp"
#include "sub_request.hpp"
#include "verb.hpp"

#include <memory>

namespace redfish
{
/*
 * @brief Top level class installing and providing Redfish services
 */
class RedfishService
{
  public:
    /*
     * @brief Redfish service constructor
     *
     * Loads Redfish configuration and installs schema resources
     *
     * @param[in] app   Crow app on which Redfish will initialize
     */
    explicit RedfishService(App& app);

    // Temporary change to make redfish instance available in other places
    // like query delegation.
    static RedfishService& getInstance(App& app)
    {
        static RedfishService redfish(app);
        return redfish;
    }

    void validate()
    {
        oemRouter.validate();
    }

    template <StringLiteral Rule>
    auto& newRoute(HttpVerb method)
    {
        return oemRouter.newRule<Rule>(method);
    }

    void handleSubRoute(
        const crow::Request& req,
        const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) const
    {
        auto subReq = std::make_shared<SubRequest>(req);
        if (!subReq->needHandling())
        {
            return;
        }
        oemRouter.handle(subReq, asyncResp);
    }

    OemRouter oemRouter;
};

template <StringLiteral Path>
auto& REDFISH_SUB_ROUTE(RedfishService& service, HttpVerb method)
{
    return service.newRoute<Path>(method);
}

} // namespace redfish