MySQL 8.0.40
Source Code Documentation
Public Member Functions | Private Attributes | List of all members
RestApiHandler Class Referenceabstract

handler for REST API calls. More...

#include <rest_api_component.h>

Inheritance diagram for RestApiHandler:
[legend]

Public Member Functions

 RestApiHandler (const std::string &require_realm, HttpMethod::Bitset allowed_methods)
 
bool try_handle_request (HttpRequest &req, const std::string &base_path, const std::vector< std::string > &path_matches) override
 try to handle the request. More...
 
virtual bool on_handle_request (HttpRequest &req, const std::string &base_path, const std::vector< std::string > &path_matches)=0
 
- Public Member Functions inherited from BaseRestApiHandler
 BaseRestApiHandler ()=default
 
 BaseRestApiHandler (const BaseRestApiHandler &)=default
 
 BaseRestApiHandler (BaseRestApiHandler &&)=default
 
BaseRestApiHandler & operator= (const BaseRestApiHandler &)=default
 
BaseRestApiHandler & operator= (BaseRestApiHandler &&)=default
 
virtual ~BaseRestApiHandler ()
 

Private Attributes

std::string require_realm_
 
HttpMethod::Bitset allowed_methods_
 

Detailed Description

handler for REST API calls.

  • may require authentication
  • enforces HTTP Methods

Constructor & Destructor Documentation

◆ RestApiHandler()

RestApiHandler::RestApiHandler ( const std::string &  require_realm,
HttpMethod::Bitset  allowed_methods 
)
inline

Member Function Documentation

◆ on_handle_request()

virtual bool RestApiHandler::on_handle_request ( HttpRequest &  req,
const std::string &  base_path,
const std::vector< std::string > &  path_matches 
)
pure virtual

Implemented in RestConnectionPoolConfig, RestConnectionPoolList, RestConnectionPoolStatus, RestClustersList, RestClustersNodes, RestMetadataCacheConfig, RestMetadataCacheList, RestMetadataCacheStatus, RestRouterStatus, RestRoutingBlockedHosts, RestRoutingConfig, RestRoutingConnections, RestRoutingDestinations, RestRoutingHealth, RestRoutingList, RestRoutingRoutesStatus, and RestRoutingStatus.

◆ try_handle_request()

bool RestApiHandler::try_handle_request ( HttpRequest &  req,
const std::string &  base_path,
const std::vector< std::string > &  path_matches 
)
overridevirtual

try to handle the request.

Returns
success
Return values
truerequest has been handled and a response has been sent
falserequest has not been handled (no response has been sent)

Implements BaseRestApiHandler.

Member Data Documentation

◆ allowed_methods_

HttpMethod::Bitset RestApiHandler::allowed_methods_
private

◆ require_realm_

std::string RestApiHandler::require_realm_
private
The documentation for this class was generated from the following files: