summaryrefslogtreecommitdiff
path: root/redfish-core/include/node.hpp
diff options
context:
space:
mode:
authorBorawski.Lukasz <lukasz.borawski@intel.com>2018-01-19 16:22:14 +0300
committerBorawski.Lukasz <lukasz.borawski@intel.com>2018-01-23 10:59:21 +0300
commit86e1b661547fda86c7b92e6e23a50a10d8c9ebd4 (patch)
tree6c424b161952b5f08f7419cb3b1d5b5227798006 /redfish-core/include/node.hpp
parent00b92f793490f4cb4c63292bd3866b65b65b67ea (diff)
downloadbmcweb-86e1b661547fda86c7b92e6e23a50a10d8c9ebd4.tar.xz
Node abstraction layer
Change-Id: I3cbad5b566cd005d33a9fbd18ff4e6669dae3a31 Signed-off-by: Borawski.Lukasz <lukasz.borawski@intel.com>
Diffstat (limited to 'redfish-core/include/node.hpp')
-rw-r--r--redfish-core/include/node.hpp115
1 files changed, 115 insertions, 0 deletions
diff --git a/redfish-core/include/node.hpp b/redfish-core/include/node.hpp
new file mode 100644
index 0000000000..46b37d970d
--- /dev/null
+++ b/redfish-core/include/node.hpp
@@ -0,0 +1,115 @@
+/*
+// Copyright (c) 2018 Intel Corporation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+*/
+#pragma once
+
+#include "crow.h"
+#include "privileges.hpp"
+#include "token_authorization_middleware.hpp"
+
+namespace redfish {
+
+/**
+ * @brief Abstract class used for implementing Redfish nodes.
+ *
+ */
+class Node {
+ public:
+ template <typename CrowApp, typename... Params>
+ Node(CrowApp& app, PrivilegeProvider& provider, std::string odataType,
+ std::string odataId, Params... params)
+ : odataType(odataType), odataId(odataId) {
+
+ // privileges for the node as defined in the privileges_registry.json
+ entityPrivileges = provider.getPrivileges(odataId, odataType);
+
+ app.route_dynamic(std::move(odataId))
+ .methods("GET"_method, "PATCH"_method, "POST"_method,
+ "DELETE"_method)([&](const crow::request& req,
+ crow::response& res, Params... params) {
+ std::vector<std::string> paramVec = {params...};
+ dispatchRequest(app, req, res, paramVec);
+ });
+ }
+
+ template <typename CrowApp>
+ void dispatchRequest(CrowApp& app, const crow::request& req,
+ crow::response& res,
+ const std::vector<std::string>& params) {
+ // drop requests without required privileges
+ auto ctx =
+ app.template get_context<crow::TokenAuthorization::Middleware>(req);
+
+ if (!entityPrivileges.isMethodAllowed(req.method, ctx.session->username)) {
+ res.code = static_cast<int>(HttpRespCode::METHOD_NOT_ALLOWED);
+ res.end();
+ return;
+ }
+
+ switch (req.method) {
+ case "GET"_method:
+ doGet(res, req, params);
+ break;
+
+ case "PATCH"_method:
+ doPatch(res, req, params);
+ break;
+
+ case "POST"_method:
+ doPost(res, req, params);
+ break;
+
+ case "DELETE"_method:
+ doDelete(res, req, params);
+ break;
+
+ default:
+ res.code = static_cast<int>(HttpRespCode::NOT_FOUND);
+ res.end();
+ }
+ return;
+ }
+
+ protected:
+ const std::string odataType;
+ const std::string odataId;
+
+ // Node is designed to be an abstract class, so doGet is pure virutal
+ virtual void doGet(crow::response& res, const crow::request& req,
+ const std::vector<std::string>& params) = 0;
+
+ virtual void doPatch(crow::response& res, const crow::request& req,
+ const std::vector<std::string>& params) {
+ res.code = static_cast<int>(HttpRespCode::METHOD_NOT_ALLOWED);
+ res.end();
+ }
+
+ virtual void doPost(crow::response& res, const crow::request& req,
+ const std::vector<std::string>& params) {
+ res.code = static_cast<int>(HttpRespCode::METHOD_NOT_ALLOWED);
+ res.end();
+ }
+
+ virtual void doDelete(crow::response& res, const crow::request& req,
+ const std::vector<std::string>& params) {
+ res.code = static_cast<int>(HttpRespCode::METHOD_NOT_ALLOWED);
+ res.end();
+ }
+
+ EntityPrivileges entityPrivileges;
+};
+
+} // namespace redfish
+