mrs::interface::RestHandler Class Reference

#include <rest_handler.h>

Inheritance diagram for mrs::interface::RestHandler:

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 Options &	get_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

using mrs::interface::RestHandler::HttpResult = mrs::interface::HttpResult

Parameters

using mrs::interface::RestHandler::Parameters = mrs::interface::Parameters

RequestContext

using mrs::interface::RestHandler::RequestContext = mrs::rest::RequestContext

SqlSession

using mrs::interface::RestHandler::SqlSession = mysqlrouter::MySQLSession

Member Enumeration Documentation

Authorization

enum class mrs::interface::RestHandler::Authorization

strong

Enumerator
kNotNeeded
kRequires
kCheck

Constructor & Destructor Documentation

~RestHandler()

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

virtualdefault

Member Function Documentation

authorization()

virtual void mrs::interface::RestHandler::authorization ( RequestContext *  ctxt )

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeUser, mrs::rest::Handler, mrs::endpoint::handler::HandlerContentFile, mrs::endpoint::handler::HandlerDbObjectMetadata, mrs::endpoint::handler::HandlerDbObjectOpenAPI, mrs::endpoint::handler::HandlerDbObjectTable, mrs::endpoint::handler::HandlerDbSchemaMetadata, mrs::endpoint::handler::HandlerDbSchemaMetadataCatalog, mrs::endpoint::handler::HandlerDbSchemaOpenAPI, mrs::endpoint::handler::HandlerDbServiceOpenAPI, mrs::endpoint::handler::HandlerRedirection, and mrs::endpoint::handler::HandlerString.

get_access_rights()

virtual uint32_t mrs::interface::RestHandler::get_access_rights ( ) const

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeAuthApps, mrs::endpoint::handler::HandlerAuthorizeCompleted, mrs::endpoint::handler::HandlerAuthorizeLogin, mrs::endpoint::handler::HandlerAuthorizeLogout, mrs::endpoint::handler::HandlerAuthorizeStatus, mrs::endpoint::handler::HandlerAuthorizeUser, mrs::endpoint::handler::HandlerContentFile, mrs::endpoint::handler::HandlerDbObjectFunction, mrs::endpoint::handler::HandlerDbObjectMetadata, mrs::endpoint::handler::HandlerDbObjectOpenAPI, mrs::endpoint::handler::HandlerDbObjectScript, mrs::endpoint::handler::HandlerDbObjectSP, mrs::endpoint::handler::HandlerDbObjectTable, mrs::endpoint::handler::HandlerDbSchemaMetadata, mrs::endpoint::handler::HandlerDbSchemaMetadataCatalog, mrs::endpoint::handler::HandlerDbSchemaOpenAPI, mrs::endpoint::handler::HandlerDbServiceDebug, mrs::endpoint::handler::HandlerDbServiceMetadata, mrs::endpoint::handler::HandlerDbServiceOpenAPI, mrs::endpoint::handler::HandlerDebug, mrs::endpoint::handler::HandlerRedirection, and mrs::endpoint::handler::HandlerString.

get_db_object_id()

virtual UniversalId mrs::interface::RestHandler::get_db_object_id ( ) const

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeAuthApps, mrs::endpoint::handler::HandlerAuthorizeCompleted, mrs::endpoint::handler::HandlerAuthorizeLogin, mrs::endpoint::handler::HandlerAuthorizeLogout, mrs::endpoint::handler::HandlerAuthorizeStatus, mrs::endpoint::handler::HandlerContentFile, mrs::endpoint::handler::HandlerDbObjectMetadata, mrs::endpoint::handler::HandlerDbObjectOpenAPI, mrs::endpoint::handler::HandlerDbObjectTable, mrs::endpoint::handler::HandlerDbSchemaMetadata, mrs::endpoint::handler::HandlerDbSchemaMetadataCatalog, mrs::endpoint::handler::HandlerDbSchemaOpenAPI, mrs::endpoint::handler::HandlerDbServiceDebug, mrs::endpoint::handler::HandlerDbServiceMetadata, mrs::endpoint::handler::HandlerDbServiceOpenAPI, mrs::endpoint::handler::HandlerDebug, mrs::endpoint::handler::HandlerRedirection, and mrs::endpoint::handler::HandlerString.

get_db_object_path()

virtual const std::string & mrs::interface::RestHandler::get_db_object_path ( ) const

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeAuthApps, mrs::endpoint::handler::HandlerAuthorizeCompleted, mrs::endpoint::handler::HandlerAuthorizeLogin, mrs::endpoint::handler::HandlerAuthorizeLogout, mrs::endpoint::handler::HandlerAuthorizeStatus, mrs::endpoint::handler::HandlerContentFile, mrs::endpoint::handler::HandlerDbObjectMetadata, mrs::endpoint::handler::HandlerDbObjectOpenAPI, mrs::endpoint::handler::HandlerDbObjectTable, mrs::endpoint::handler::HandlerDbSchemaMetadata, mrs::endpoint::handler::HandlerDbSchemaMetadataCatalog, mrs::endpoint::handler::HandlerDbSchemaOpenAPI, mrs::endpoint::handler::HandlerDbServiceDebug, mrs::endpoint::handler::HandlerDbServiceMetadata, mrs::endpoint::handler::HandlerDbServiceOpenAPI, mrs::endpoint::handler::HandlerDebug, mrs::endpoint::handler::HandlerRedirection, and mrs::endpoint::handler::HandlerString.

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()

virtual UniversalId mrs::interface::RestHandler::get_schema_id ( ) const

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeAuthApps, mrs::endpoint::handler::HandlerAuthorizeCompleted, mrs::endpoint::handler::HandlerAuthorizeLogin, mrs::endpoint::handler::HandlerAuthorizeLogout, mrs::endpoint::handler::HandlerAuthorizeStatus, mrs::endpoint::handler::HandlerContentFile, mrs::endpoint::handler::HandlerDbObjectMetadata, mrs::endpoint::handler::HandlerDbObjectOpenAPI, mrs::endpoint::handler::HandlerDbObjectTable, mrs::endpoint::handler::HandlerDbSchemaMetadata, mrs::endpoint::handler::HandlerDbSchemaMetadataCatalog, mrs::endpoint::handler::HandlerDbSchemaOpenAPI, mrs::endpoint::handler::HandlerDbServiceDebug, mrs::endpoint::handler::HandlerDbServiceMetadata, mrs::endpoint::handler::HandlerDbServiceOpenAPI, mrs::endpoint::handler::HandlerDebug, mrs::endpoint::handler::HandlerRedirection, and mrs::endpoint::handler::HandlerString.

get_schema_path()

virtual const std::string & mrs::interface::RestHandler::get_schema_path ( ) const

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeAuthApps, mrs::endpoint::handler::HandlerAuthorizeCompleted, mrs::endpoint::handler::HandlerAuthorizeLogin, mrs::endpoint::handler::HandlerAuthorizeLogout, mrs::endpoint::handler::HandlerAuthorizeStatus, mrs::endpoint::handler::HandlerContentFile, mrs::endpoint::handler::HandlerDbObjectMetadata, mrs::endpoint::handler::HandlerDbObjectOpenAPI, mrs::endpoint::handler::HandlerDbObjectTable, mrs::endpoint::handler::HandlerDbSchemaMetadata, mrs::endpoint::handler::HandlerDbSchemaMetadataCatalog, mrs::endpoint::handler::HandlerDbSchemaOpenAPI, mrs::endpoint::handler::HandlerDbServiceDebug, mrs::endpoint::handler::HandlerDbServiceMetadata, mrs::endpoint::handler::HandlerDbServiceOpenAPI, mrs::endpoint::handler::HandlerDebug, mrs::endpoint::handler::HandlerRedirection, and mrs::endpoint::handler::HandlerString.

get_service_id()

virtual UniversalId mrs::interface::RestHandler::get_service_id ( ) const

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeAuthApps, mrs::endpoint::handler::HandlerAuthorizeCompleted, mrs::endpoint::handler::HandlerAuthorizeLogin, mrs::endpoint::handler::HandlerAuthorizeLogout, mrs::endpoint::handler::HandlerAuthorizeStatus, mrs::endpoint::handler::HandlerContentFile, mrs::endpoint::handler::HandlerDbObjectMetadata, mrs::endpoint::handler::HandlerDbObjectOpenAPI, mrs::endpoint::handler::HandlerDbObjectTable, mrs::endpoint::handler::HandlerDbSchemaMetadata, mrs::endpoint::handler::HandlerDbSchemaMetadataCatalog, mrs::endpoint::handler::HandlerDbSchemaOpenAPI, mrs::endpoint::handler::HandlerDbServiceDebug, mrs::endpoint::handler::HandlerDbServiceMetadata, mrs::endpoint::handler::HandlerDbServiceOpenAPI, mrs::endpoint::handler::HandlerDebug, mrs::endpoint::handler::HandlerRedirection, and mrs::endpoint::handler::HandlerString.

get_service_path()

virtual const std::string & mrs::interface::RestHandler::get_service_path ( ) const

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeAuthApps, mrs::endpoint::handler::HandlerAuthorizeCompleted, mrs::endpoint::handler::HandlerAuthorizeLogin, mrs::endpoint::handler::HandlerAuthorizeLogout, mrs::endpoint::handler::HandlerAuthorizeStatus, mrs::endpoint::handler::HandlerContentFile, mrs::endpoint::handler::HandlerDbObjectMetadata, mrs::endpoint::handler::HandlerDbObjectOpenAPI, mrs::endpoint::handler::HandlerDbObjectTable, mrs::endpoint::handler::HandlerDbSchemaMetadata, mrs::endpoint::handler::HandlerDbSchemaMetadataCatalog, mrs::endpoint::handler::HandlerDbSchemaOpenAPI, mrs::endpoint::handler::HandlerDbServiceDebug, mrs::endpoint::handler::HandlerDbServiceMetadata, mrs::endpoint::handler::HandlerDbServiceOpenAPI, mrs::endpoint::handler::HandlerDebug, mrs::endpoint::handler::HandlerRedirection, and mrs::endpoint::handler::HandlerString.

get_url_host()

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

pure virtual

Implemented in mrs::rest::Handler.

handle_delete()

virtual HttpResult mrs::interface::RestHandler::handle_delete ( RequestContext *  ctxt )

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeAuthApps, mrs::endpoint::handler::HandlerAuthorizeCompleted, mrs::endpoint::handler::HandlerAuthorizeLogin, mrs::endpoint::handler::HandlerAuthorizeLogout, mrs::endpoint::handler::HandlerAuthorizeStatus, mrs::endpoint::handler::HandlerDebug, mrs::endpoint::handler::HandlerContentFile, mrs::endpoint::handler::HandlerDbObjectFunction, mrs::endpoint::handler::HandlerDbObjectMetadata, mrs::endpoint::handler::HandlerDbObjectOpenAPI, mrs::endpoint::handler::HandlerDbObjectScript, mrs::endpoint::handler::HandlerDbObjectSP, mrs::endpoint::handler::HandlerDbObjectTable, mrs::endpoint::handler::HandlerDbSchemaMetadata, mrs::endpoint::handler::HandlerDbSchemaMetadataCatalog, mrs::endpoint::handler::HandlerDbSchemaOpenAPI, mrs::endpoint::handler::HandlerDbServiceDebug, mrs::endpoint::handler::HandlerDbServiceMetadata, mrs::endpoint::handler::HandlerDbServiceOpenAPI, mrs::endpoint::handler::HandlerRedirection, and mrs::endpoint::handler::HandlerString.

handle_get()

virtual HttpResult mrs::interface::RestHandler::handle_get ( RequestContext *  ctxt )

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeAuthApps, mrs::endpoint::handler::HandlerAuthorizeCompleted, mrs::endpoint::handler::HandlerAuthorizeLogin, mrs::endpoint::handler::HandlerAuthorizeLogout, mrs::endpoint::handler::HandlerAuthorizeStatus, mrs::endpoint::handler::HandlerContentFile, mrs::endpoint::handler::HandlerDbObjectFunction, mrs::endpoint::handler::HandlerDbObjectMetadata, mrs::endpoint::handler::HandlerDbObjectOpenAPI, mrs::endpoint::handler::HandlerDbObjectScript, mrs::endpoint::handler::HandlerDbObjectSP, mrs::endpoint::handler::HandlerDbObjectTable, mrs::endpoint::handler::HandlerDbSchemaMetadata, mrs::endpoint::handler::HandlerDbSchemaMetadataCatalog, mrs::endpoint::handler::HandlerDbSchemaOpenAPI, mrs::endpoint::handler::HandlerDbServiceDebug, mrs::endpoint::handler::HandlerDbServiceMetadata, mrs::endpoint::handler::HandlerDbServiceOpenAPI, mrs::endpoint::handler::HandlerDebug, mrs::endpoint::handler::HandlerRedirection, and mrs::endpoint::handler::HandlerString.

handle_post()

virtual HttpResult mrs::interface::RestHandler::handle_post ( RequestContext *  ctxt, const std::vector< uint8_t > &  document  )

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeAuthApps, mrs::endpoint::handler::HandlerAuthorizeCompleted, mrs::endpoint::handler::HandlerAuthorizeLogin, mrs::endpoint::handler::HandlerAuthorizeLogout, mrs::endpoint::handler::HandlerAuthorizeStatus, mrs::endpoint::handler::HandlerDebug, mrs::endpoint::handler::HandlerContentFile, mrs::endpoint::handler::HandlerDbObjectFunction, mrs::endpoint::handler::HandlerDbObjectMetadata, mrs::endpoint::handler::HandlerDbObjectOpenAPI, mrs::endpoint::handler::HandlerDbObjectScript, mrs::endpoint::handler::HandlerDbObjectSP, mrs::endpoint::handler::HandlerDbObjectTable, mrs::endpoint::handler::HandlerDbSchemaMetadata, mrs::endpoint::handler::HandlerDbSchemaMetadataCatalog, mrs::endpoint::handler::HandlerDbSchemaOpenAPI, mrs::endpoint::handler::HandlerDbServiceDebug, mrs::endpoint::handler::HandlerDbServiceMetadata, mrs::endpoint::handler::HandlerDbServiceOpenAPI, mrs::endpoint::handler::HandlerRedirection, and mrs::endpoint::handler::HandlerString.

handle_put()

virtual HttpResult mrs::interface::RestHandler::handle_put ( RequestContext *  ctxt )

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeAuthApps, mrs::endpoint::handler::HandlerAuthorizeCompleted, mrs::endpoint::handler::HandlerAuthorizeLogin, mrs::endpoint::handler::HandlerAuthorizeLogout, mrs::endpoint::handler::HandlerAuthorizeStatus, mrs::endpoint::handler::HandlerAuthorizeUser, mrs::endpoint::handler::HandlerDebug, mrs::endpoint::handler::HandlerContentFile, mrs::endpoint::handler::HandlerDbObjectFunction, mrs::endpoint::handler::HandlerDbObjectMetadata, mrs::endpoint::handler::HandlerDbObjectOpenAPI, mrs::endpoint::handler::HandlerDbObjectScript, mrs::endpoint::handler::HandlerDbObjectSP, mrs::endpoint::handler::HandlerDbObjectTable, mrs::endpoint::handler::HandlerDbSchemaMetadata, mrs::endpoint::handler::HandlerDbSchemaMetadataCatalog, mrs::endpoint::handler::HandlerDbSchemaOpenAPI, mrs::endpoint::handler::HandlerDbServiceDebug, mrs::endpoint::handler::HandlerDbServiceMetadata, mrs::endpoint::handler::HandlerDbServiceOpenAPI, mrs::endpoint::handler::HandlerRedirection, and mrs::endpoint::handler::HandlerString.

initialize()

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

pure virtual

may_check_access()

virtual bool mrs::interface::RestHandler::may_check_access ( ) const

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeAuthApps, mrs::endpoint::handler::HandlerAuthorizeCompleted, mrs::endpoint::handler::HandlerAuthorizeLogin, mrs::endpoint::handler::HandlerAuthorizeLogout, mrs::endpoint::handler::HandlerAuthorizeStatus, and mrs::rest::Handler.

request_begin()

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

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeLogin, and mrs::rest::Handler.

request_end()

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

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeBase, and mrs::rest::Handler.

request_error()

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

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeBase, mrs::endpoint::handler::HandlerAuthorizeLogin, and mrs::rest::Handler.

requires_authentication()

virtual Authorization mrs::interface::RestHandler::requires_authentication ( ) const

pure virtual

Implemented in mrs::endpoint::handler::HandlerAuthorizeAuthApps, mrs::endpoint::handler::HandlerAuthorizeCompleted, mrs::endpoint::handler::HandlerAuthorizeLogin, mrs::endpoint::handler::HandlerAuthorizeLogout, mrs::endpoint::handler::HandlerAuthorizeStatus, mrs::endpoint::handler::HandlerContentFile, mrs::endpoint::handler::HandlerDbObjectMetadata, mrs::endpoint::handler::HandlerDbObjectOpenAPI, mrs::endpoint::handler::HandlerDbObjectTable, mrs::endpoint::handler::HandlerDbSchemaMetadata, mrs::endpoint::handler::HandlerDbSchemaMetadataCatalog, mrs::endpoint::handler::HandlerDbSchemaOpenAPI, mrs::endpoint::handler::HandlerDbServiceDebug, mrs::endpoint::handler::HandlerDbServiceMetadata, mrs::endpoint::handler::HandlerDbServiceOpenAPI, mrs::endpoint::handler::HandlerDebug, mrs::endpoint::handler::HandlerRedirection, and mrs::endpoint::handler::HandlerString.

---

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

• router/src/mysql_rest_service/include/mrs/interface/rest_handler.h