Leosac  0.8.0
Open Source Access Control
MethodHandler.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 "ActionActionParam.hpp"
23 #include "RequestContext.hpp"
24 #include "core/SecurityContext.hpp"
26 #include <nlohmann/json.hpp>
27 
28 namespace Leosac
29 {
30 namespace Module
31 {
32 namespace WebSockAPI
33 {
34 
35 using json = nlohmann::json;
36 
47 {
48  public:
50 
52  : ctx_(ctx)
53  {
54  }
55 
56  virtual ~MethodHandler() = default;
57 
64  json process(const ClientMessage &msg);
65 
70  {
71  return nullptr;
72  }
73 
75 
81 
82  protected:
87  virtual std::vector<ActionActionParam>
88  required_permission(const json &req) const = 0;
89 
91 
92  private:
99  virtual json process_impl(const json &req) = 0;
100 };
101 }
102 }
103 }
Leosac::Module::WebSockAPI::MethodHandler::exec_context
ExecutionContext exec_context()
Returns a representation of the execution context of this request.
Definition: MethodHandler.cpp:52
Leosac::UserSecurityContext
A SecurityContext object for users.
Definition: UserSecurityContext.hpp:31
ActionActionParam.hpp
Leosac::Module::WebSockAPI::MethodHandler::Factory
MethodHandlerUPtr(*)(RequestContext) Factory
Definition: MethodHandler.hpp:49
Leosac::Module::WebSockAPI::MethodHandler::required_permission
virtual std::vector< ActionActionParam > required_permission(const json &req) const =0
Return a list of "Action" / "ActionParam" that must pass before the request is processed.
json
nlohmann::json json
Definition: WSServer.cpp:76
Leosac::Module::WebSockAPI::ClientMessage
A message sent by a client to Leosac.
Definition: Messages.hpp:54
RequestContext.hpp
Leosac::Module::WebSockAPI::MethodHandler
The base class for API method handler implementation.
Definition: MethodHandler.hpp:46
SecurityContext.hpp
Leosac
This is the header file for a generated source file, GitSHA1.cpp.
Definition: APIStatusCode.hpp:22
Leosac::ExecutionContext
An ExecutionContext is passed around to service so they have context about who is making the call and...
Definition: SecurityContext.hpp:301
Leosac::Module::WebSockAPI::MethodHandler::ctx_
RequestContext ctx_
Definition: MethodHandler.hpp:90
Leosac::Module::WebSockAPI::MethodHandler::create
static MethodHandlerUPtr create(RequestContext)
An example method that should be implemented in all subclasses.
Definition: MethodHandler.hpp:69
Leosac::Module::WebSockAPI::MethodHandlerUPtr
std::unique_ptr< MethodHandler > MethodHandlerUPtr
Definition: WebSockFwd.hpp:36
Leosac::Module::WebSockAPI::MethodHandler::process
json process(const ClientMessage &msg)
The public process() method.
Definition: MethodHandler.cpp:30
Leosac::Module::WebSockAPI::MethodHandler::~MethodHandler
virtual ~MethodHandler()=default
Leosac::Module::WebSockAPI::MethodHandler::security_context
UserSecurityContext & security_context()
Definition: MethodHandler.cpp:44
Leosac::Module::WebSockAPI::MethodHandler::MethodHandler
MethodHandler(RequestContext ctx)
Definition: MethodHandler.hpp:51
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
Leosac::Module::WebSockAPI::MethodHandler::process_impl
virtual json process_impl(const json &req)=0
The API method implementation.
UserSecurityContext.hpp