Leosac::Module::WebSockAPI::ICRUDResourceHandler Class Reference

A common interface for CRUD handler. More...

#include <CRUDResourceHandler.hpp>

Inheritance diagram for Leosac::Module::WebSockAPI::ICRUDResourceHandler:

Public Types
enum	Verb { Verb::CREATE, Verb::READ, Verb::UPDATE, Verb::DELETE }

Public Member Functions
boost::optional< json >	process (const ClientMessage &msg)

Protected Types
using	ActionActionParam = std::pair< SecurityContext::Action, SecurityContext::ActionParam >
	A pair of Action and a generic ActionParam union. More...

Protected Member Functions
virtual UserSecurityContext &	security_context () const =0
	Helper function that returns the security context. More...

Private Member Functions
virtual std::vector< ActionActionParam >	required_permission (Verb verb, const json &req) const =0
virtual boost::optional< json >	create_impl (const json &req)=0
virtual boost::optional< json >	read_impl (const json &req)=0
virtual boost::optional< json >	update_impl (const json &req)=0
virtual boost::optional< json >	delete_impl (const json &req)=0
void	enforce_permission (const std::vector< ActionActionParam > &)

Static Private Member Functions
static Verb	verb_from_request_type (const std::string &)

Detailed Description

A common interface for CRUD handler.

Definition at line 40 of file CRUDResourceHandler.hpp.

Member Typedef Documentation

ActionActionParam

using Leosac::Module::WebSockAPI::ICRUDResourceHandler::ActionActionParam = std::pair<SecurityContext::Action, SecurityContext::ActionParam>

protected

A pair of Action and a generic ActionParam union.

Definition at line 57 of file CRUDResourceHandler.hpp.

Member Enumeration Documentation

Verb

enum Leosac::Module::WebSockAPI::ICRUDResourceHandler::Verb

strong

Enumerator
CREATE
READ
UPDATE
DELETE

Definition at line 43 of file CRUDResourceHandler.hpp.

Member Function Documentation

create_impl()

virtual boost::optional<json> Leosac::Module::WebSockAPI::ICRUDResourceHandler::create_impl ( const json &  req )

privatepure virtual

Implemented in Leosac::Module::LedBuzzer::CRUDHandler< ObjectT, ObjectIdKey, SerializerT >, Leosac::Module::WebSockAPI::CredentialCRUD, Leosac::Module::WebSockAPI::GroupCRUD, Leosac::Module::WebSockAPI::ScheduleCRUD, Leosac::Module::WebSockAPI::MembershipCRUD, Leosac::Module::WebSockAPI::AccessPointCRUD, Leosac::Module::WebSockAPI::DoorCRUD, Leosac::Module::WebSockAPI::ZoneCRUD, Leosac::Module::Piface::CRUDHandler, Leosac::Module::WebSockAPI::UserCRUD, and Leosac::Module::Wiegand::CRUDHandler.

delete_impl()

virtual boost::optional<json> Leosac::Module::WebSockAPI::ICRUDResourceHandler::delete_impl ( const json &  req )

privatepure virtual

Implemented in Leosac::Module::WebSockAPI::GroupCRUD, Leosac::Module::WebSockAPI::ScheduleCRUD, Leosac::Module::WebSockAPI::UserCRUD, Leosac::Module::LedBuzzer::CRUDHandler< ObjectT, ObjectIdKey, SerializerT >, Leosac::Module::WebSockAPI::MembershipCRUD, Leosac::Module::WebSockAPI::CredentialCRUD, Leosac::Module::WebSockAPI::AccessPointCRUD, Leosac::Module::Piface::CRUDHandler, Leosac::Module::WebSockAPI::DoorCRUD, Leosac::Module::WebSockAPI::ZoneCRUD, and Leosac::Module::Wiegand::CRUDHandler.

enforce_permission()

void ICRUDResourceHandler::enforce_permission ( const std::vector< ActionActionParam > &  permissions )

private

Definition at line 50 of file CRUDResourceHandler.cpp.

process()

boost::optional< json > ICRUDResourceHandler::process

(

const ClientMessage &

msg

)

Definition at line 64 of file CRUDResourceHandler.cpp.

read_impl()

virtual boost::optional<json> Leosac::Module::WebSockAPI::ICRUDResourceHandler::read_impl ( const json &  req )

privatepure virtual

Implemented in Leosac::Module::WebSockAPI::GroupCRUD, Leosac::Module::LedBuzzer::CRUDHandler< ObjectT, ObjectIdKey, SerializerT >, Leosac::Module::WebSockAPI::MembershipCRUD, Leosac::Module::WebSockAPI::CredentialCRUD, Leosac::Module::WebSockAPI::ScheduleCRUD, Leosac::Module::WebSockAPI::UserCRUD, Leosac::Module::WebSockAPI::AccessPointCRUD, Leosac::Module::WebSockAPI::DoorCRUD, Leosac::Module::WebSockAPI::ZoneCRUD, Leosac::Module::Piface::CRUDHandler, and Leosac::Module::Wiegand::CRUDHandler.

required_permission()

virtual std::vector<ActionActionParam> Leosac::Module::WebSockAPI::ICRUDResourceHandler::required_permission ( Verb  verb, const json &  req  ) const

privatepure virtual

Implemented in Leosac::Module::LedBuzzer::CRUDHandler< ObjectT, ObjectIdKey, SerializerT >, Leosac::Module::WebSockAPI::AccessPointCRUD, Leosac::Module::WebSockAPI::CredentialCRUD, Leosac::Module::WebSockAPI::DoorCRUD, Leosac::Module::WebSockAPI::GroupCRUD, Leosac::Module::WebSockAPI::ScheduleCRUD, Leosac::Module::WebSockAPI::ZoneCRUD, Leosac::Module::WebSockAPI::MembershipCRUD, Leosac::Module::WebSockAPI::UserCRUD, Leosac::Module::Piface::CRUDHandler, and Leosac::Module::Wiegand::CRUDHandler.

security_context()

virtual UserSecurityContext& Leosac::Module::WebSockAPI::ICRUDResourceHandler::security_context ( ) const

protectedpure virtual

Helper function that returns the security context.

Implemented in Leosac::Module::WebSockAPI::ExternalCRUDResourceHandler, and Leosac::Module::WebSockAPI::CRUDResourceHandler.

update_impl()

virtual boost::optional<json> Leosac::Module::WebSockAPI::ICRUDResourceHandler::update_impl ( const json &  req )

privatepure virtual

Implemented in Leosac::Module::WebSockAPI::GroupCRUD, Leosac::Module::WebSockAPI::ScheduleCRUD, Leosac::Module::WebSockAPI::UserCRUD, Leosac::Module::LedBuzzer::CRUDHandler< ObjectT, ObjectIdKey, SerializerT >, Leosac::Module::WebSockAPI::MembershipCRUD, Leosac::Module::WebSockAPI::CredentialCRUD, Leosac::Module::WebSockAPI::AccessPointCRUD, Leosac::Module::Piface::CRUDHandler, Leosac::Module::WebSockAPI::DoorCRUD, Leosac::Module::WebSockAPI::ZoneCRUD, and Leosac::Module::Wiegand::CRUDHandler.

verb_from_request_type()

ICRUDResourceHandler::Verb ICRUDResourceHandler::verb_from_request_type ( const std::string &  req )

staticprivate

Definition at line 32 of file CRUDResourceHandler.cpp.

---

The documentation for this class was generated from the following files:

• src/modules/websock-api/api/CRUDResourceHandler.hpp
• src/modules/websock-api/api/CRUDResourceHandler.cpp