Leosac  0.8.0
Open Source Access Control
AccessOverview.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2014-2016 Leosac
3 
4  This file is part of Leosac.
5 
6  Leosac is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Affero General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  Leosac is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Affero General Public License for more details.
15 
16  You should have received a copy of the GNU Affero General Public License
17  along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
20 #pragma once
21 
22 #include "MethodHandler.hpp"
23 
24 namespace Leosac
25 {
26 namespace Module
27 {
28 namespace WebSockAPI
29 {
31 
50 {
51  public:
53 
55 
56  protected:
57  std::vector<ActionActionParam>
58  required_permission(const json &req) const override;
59 
60  private:
61  virtual json process_impl(const json &req) override;
62 };
63 }
64 }
65 }
Leosac::Module::WebSockAPI::AccessOverview::AccessOverview
AccessOverview(RequestContext ctx)
Definition: AccessOverview.cpp:31
Leosac::Module::WebSockAPI::AccessOverview
Retrieve an overview of the access permission of users against doors.
Definition: AccessOverview.hpp:49
json
nlohmann::json json
Definition: WSServer.cpp:76
Leosac::Module::WebSockAPI::AccessOverview::required_permission
std::vector< ActionActionParam > required_permission(const json &req) const override
Return a list of "Action" / "ActionParam" that must pass before the request is processed.
Definition: AccessOverview.cpp:90
Leosac::Module::WebSockAPI::MethodHandler
The base class for API method handler implementation.
Definition: MethodHandler.hpp:46
Leosac
This is the header file for a generated source file, GitSHA1.cpp.
Definition: APIStatusCode.hpp:22
Leosac::Module::WebSockAPI::AccessOverview::create
static MethodHandlerUPtr create(RequestContext)
Definition: AccessOverview.cpp:36
Leosac::Module::WebSockAPI::AccessOverview::process_impl
virtual json process_impl(const json &req) override
The API method implementation.
Definition: AccessOverview.cpp:41
Leosac::Module::WebSockAPI::MethodHandlerUPtr
std::unique_ptr< MethodHandler > MethodHandlerUPtr
Definition: WebSockFwd.hpp:36
Leosac::Module::WebSockAPI::json
nlohmann::json json
Definition: AccessOverview.hpp:30
Leosac::Module::WebSockAPI::RequestContext
Holds valuable pointer to provide context to a request.
Definition: RequestContext.hpp:36
MethodHandler.hpp