MySQL 9.3.0
Source Code Documentation
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
mrs::interface::RestHandler Class Referenceabstract

#include <rest_handler.h>

Inheritance diagram for mrs::interface::RestHandler:
[legend]

Classes

class  Configuration
 

Public Types

enum class  Authorization { kNotNeeded , kRequires , kCheck }
 
using SqlSession = mysqlrouter::MySQLSession
 
using RequestContext = mrs::rest::RequestContext
 
using Parameters = mrs::interface::Parameters
 
using HttpResult = mrs::interface::HttpResult
 

Public Member Functions

virtual ~RestHandler ()=default
 
virtual void initialize (const Configuration &configuration)=0
 
virtual bool may_check_access () const =0
 
virtual Authorization requires_authentication () const =0
 
virtual const std::string & get_url_host () const =0
 
virtual const std::string & get_protocol () const =0
 
virtual const std::string & get_service_path () const =0
 
virtual const std::string & get_schema_path () const =0
 
virtual const std::string & get_db_object_path () const =0
 
virtual UniversalId get_service_id () const =0
 
virtual UniversalId get_db_object_id () const =0
 
virtual UniversalId get_schema_id () const =0
 
virtual uint32_t get_access_rights () const =0
 
virtual const Optionsget_options () const =0
 
virtual void authorization (RequestContext *ctxt)=0
 
virtual bool request_begin (RequestContext *ctxt)=0
 
virtual void request_end (RequestContext *ctxt)=0
 
virtual bool request_error (RequestContext *ctxt, const http::Error &e)=0
 
virtual HttpResult handle_get (RequestContext *ctxt)=0
 
virtual HttpResult handle_post (RequestContext *ctxt, const std::vector< uint8_t > &document)=0
 
virtual HttpResult handle_delete (RequestContext *ctxt)=0
 
virtual HttpResult handle_put (RequestContext *ctxt)=0
 

Member Typedef Documentation

◆ HttpResult

◆ Parameters

◆ RequestContext

◆ SqlSession

Member Enumeration Documentation

◆ Authorization

Enumerator
kNotNeeded 
kRequires 
kCheck 

Constructor & Destructor Documentation

◆ ~RestHandler()

virtual mrs::interface::RestHandler::~RestHandler ( )
virtualdefault

Member Function Documentation

◆ authorization()

◆ get_access_rights()

◆ get_db_object_id()

◆ get_db_object_path()

◆ get_options()

virtual const Options & mrs::interface::RestHandler::get_options ( ) const
pure virtual

Implemented in mrs::rest::Handler.

◆ get_protocol()

virtual const std::string & mrs::interface::RestHandler::get_protocol ( ) const
pure virtual

Implemented in mrs::rest::Handler.

◆ get_schema_id()

◆ get_schema_path()

◆ get_service_id()

◆ get_service_path()

◆ get_url_host()

virtual const std::string & mrs::interface::RestHandler::get_url_host ( ) const
pure virtual

Implemented in mrs::rest::Handler.

◆ handle_delete()

◆ handle_get()

◆ handle_post()

◆ handle_put()

◆ initialize()

virtual void mrs::interface::RestHandler::initialize ( const Configuration configuration)
pure virtual

◆ may_check_access()

◆ request_begin()

virtual bool mrs::interface::RestHandler::request_begin ( RequestContext ctxt)
pure virtual

◆ request_end()

virtual void mrs::interface::RestHandler::request_end ( RequestContext ctxt)
pure virtual

◆ request_error()

virtual bool mrs::interface::RestHandler::request_error ( RequestContext ctxt,
const http::Error e 
)
pure virtual

◆ requires_authentication()


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