MySQL 8.4.7
Source Code Documentation
Classes | Namespaces | Macros | Typedefs | Functions | Variables
rest_metadata_cache_plugin.cc File Reference
#include <array>
#include <string>
#include "mysql/harness/config_parser.h"
#include "mysql/harness/dynamic_config.h"
#include "mysql/harness/loader.h"
#include "mysql/harness/logging/logging.h"
#include "mysql/harness/plugin.h"
#include "mysql/harness/plugin_config.h"
#include "mysql/harness/section_config_exposer.h"
#include "mysql/harness/utility/string.h"
#include "mysqlrouter/component/http_server_component.h"
#include "mysqlrouter/http_constants.h"
#include "mysqlrouter/rest_api_component.h"
#include "mysqlrouter/supported_rest_options.h"
#include "rest_clusters_list.h"
#include "rest_clusters_nodes.h"
#include "rest_metadata_cache_config.h"
#include "rest_metadata_cache_list.h"
#include "rest_metadata_cache_status.h"

Classes

class  RestMetadataCachePluginConfig
 
class  anonymous_namespace{rest_metadata_cache_plugin.cc}::RestMetadataCacheConfigExposer
 

Namespaces

namespace  anonymous_namespace{rest_metadata_cache_plugin.cc}
 

Macros

#define GET_OPTION_CHECKED(option, section, name, value)
 
#define STR(s)    { s, strlen(s), rapidjson::kPointerInvalidIndex }
 
#define DLLEXPORT
 

Typedefs

using StringOption = mysql_harness::StringOption
 
using JsonPointer = RestApiComponent::JsonPointer
 
using JsonValue = RestApiComponent::JsonValue
 

Functions

static void init (mysql_harness::PluginFuncEnv *env)
 
std::string json_pointer_stringfy (const JsonPointer &ptr)
 
static void spec_adder (RestApiComponent::JsonDocument &spec_doc)
 
static void start (mysql_harness::PluginFuncEnv *env)
 
static void expose_configuration (mysql_harness::PluginFuncEnv *env, const char *, bool initial)
 

Variables

static constexpr char kSectionName [] {"rest_metadata_cache"}
 
static constexpr char kRequireRealm [] {"require_realm"}
 
std::string require_realm_metadata_cache
 
static const std::array< JsonPointer::Token, 2 > metadata_name_param_tokens
 
static const std::array< JsonPointer::Token, 2 > cluster_name_param_tokens
 
static const std::array< JsonPointer::Token, 2 > metadata_status_def_tokens
 
static const std::array< JsonPointer::Token, 2 > metadata_list_def_tokens
 
static const std::array< JsonPointer::Token, 2 > metadata_summary_def_tokens
 
static const std::array< JsonPointer::Token, 2 > metadata_config_def_tokens
 
static const std::array< JsonPointer::Token, 2 > cluster_node_summary_def_tokens
 
static const std::array< JsonPointer::Token, 2 > cluster_node_list_def_tokens
 
static const std::array< JsonPointer::Token, 2 > cluster_summary_def_tokens
 
static const std::array< JsonPointer::Token, 2 > cluster_list_def_tokens
 
static const std::array< JsonPointer::Token, 2 > metadata_status_path_tokens
 
static const std::array< JsonPointer::Token, 2 > metadata_config_path_tokens
 
static const std::array< JsonPointer::Token, 2 > metadata_list_path_tokens
 
static const std::array< JsonPointer::Token, 2 > tags_append_tokens
 
static const std::array< const char *, 2 > required
 
mysql_harness::Plugin DLLEXPORT harness_plugin_rest_metadata_cache
 

Macro Definition Documentation

◆ DLLEXPORT

#define DLLEXPORT

◆ GET_OPTION_CHECKED

#define GET_OPTION_CHECKED (   option,
  section,
  name,
  value 
)
Value:
static_assert( \
mysql_harness::str_in_collection(rest_plugin_supported_options, name)); \
option = get_option(section, name, value);
mysql_harness::str_in_collection
constexpr bool str_in_collection(const T &t, const std::string_view &k)
Definition: string.h:94
name
case opt name
Definition: sslopt-case.h:29
rest_plugin_supported_options
static constexpr std::array< const char *, 1 > rest_plugin_supported_options
Definition: supported_rest_options.h:31

◆ STR

#define STR (   s)     { s, strlen(s), rapidjson::kPointerInvalidIndex }

Typedef Documentation

◆ JsonPointer

using JsonPointer = RestApiComponent::JsonPointer

◆ JsonValue

using JsonValue = RestApiComponent::JsonValue

◆ StringOption

using StringOption = mysql_harness::StringOption

Function Documentation

◆ expose_configuration()

static void expose_configuration ( mysql_harness::PluginFuncEnv *  env,
const char *  ,
bool  initial 
)
static

◆ init()

static void init ( mysql_harness::PluginFuncEnv *  env)
static

◆ json_pointer_stringfy()

std::string json_pointer_stringfy ( const JsonPointer &  ptr)

◆ spec_adder()

static void spec_adder ( RestApiComponent::JsonDocument &  spec_doc)
static

◆ start()

static void start ( mysql_harness::PluginFuncEnv *  env)
static

Variable Documentation

◆ cluster_list_def_tokens

const std::array<JsonPointer::Token, 2> cluster_list_def_tokens
static
Initial value:
{
{STR("definitions"), STR("ClusterList")}}
STR
#define STR(s)
Definition: rest_metadata_cache_plugin.cc:154

◆ cluster_name_param_tokens

const std::array<JsonPointer::Token, 2> cluster_name_param_tokens
static
Initial value:
{
{STR("parameters"), STR("clusterNameParam")}}

◆ cluster_node_list_def_tokens

const std::array<JsonPointer::Token, 2> cluster_node_list_def_tokens
static
Initial value:
{
{STR("definitions"), STR("ClusterNodeList")}}

◆ cluster_node_summary_def_tokens

const std::array<JsonPointer::Token, 2> cluster_node_summary_def_tokens
static
Initial value:
{
{STR("definitions"), STR("ClusterNodeSummary")}}

◆ cluster_summary_def_tokens

const std::array<JsonPointer::Token, 2> cluster_summary_def_tokens
static
Initial value:
{
{STR("definitions"), STR("ClusterSummary")}}

◆ harness_plugin_rest_metadata_cache

mysql_harness::Plugin DLLEXPORT harness_plugin_rest_metadata_cache
Initial value:
= {
mysql_harness::PLUGIN_ABI_VERSION,
mysql_harness::ARCHITECTURE_DESCRIPTOR,
"REST_METADATA_CACHE",
VERSION_NUMBER(0, 0, 1),
required.size(),
required.data(),
0,
nullptr,
init,
nullptr,
start,
nullptr,
true,
rest_plugin_supported_options.size(),
rest_plugin_supported_options.data(),
expose_configuration,
}
expose_configuration
static void expose_configuration(mysql_harness::PluginFuncEnv *env, const char *, bool initial)
Definition: rest_metadata_cache_plugin.cc:893
init
static void init(mysql_harness::PluginFuncEnv *env)
Definition: rest_metadata_cache_plugin.cc:89
required
static const std::array< const char *, 2 > required
Definition: rest_metadata_cache_plugin.cc:862
start
static void start(mysql_harness::PluginFuncEnv *env)
Definition: rest_metadata_cache_plugin.cc:826

◆ kRequireRealm

constexpr char kRequireRealm[] {"require_realm"}
staticconstexpr

◆ kSectionName

constexpr char kSectionName[] {"rest_metadata_cache"}
staticconstexpr

◆ metadata_config_def_tokens

const std::array<JsonPointer::Token, 2> metadata_config_def_tokens
static
Initial value:
{
{STR("definitions"), STR("MetadataConfig")}}

◆ metadata_config_path_tokens

const std::array<JsonPointer::Token, 2> metadata_config_path_tokens
static
Initial value:
{
{STR("paths"), STR("/metadata/{metadataName}/config")}}

◆ metadata_list_def_tokens

const std::array<JsonPointer::Token, 2> metadata_list_def_tokens
static
Initial value:
{
{STR("definitions"), STR("MetadataList")}}

◆ metadata_list_path_tokens

const std::array<JsonPointer::Token, 2> metadata_list_path_tokens
static
Initial value:
{
{STR("paths"), STR("/metadata")}}

◆ metadata_name_param_tokens

const std::array<JsonPointer::Token, 2> metadata_name_param_tokens
static
Initial value:
{
{STR("parameters"), STR("metadataNameParam")}}

◆ metadata_status_def_tokens

const std::array<JsonPointer::Token, 2> metadata_status_def_tokens
static
Initial value:
{
{STR("definitions"), STR("MetadataStatus")}}

◆ metadata_status_path_tokens

const std::array<JsonPointer::Token, 2> metadata_status_path_tokens
static
Initial value:
{
{STR("paths"), STR("/metadata/{metadataName}/status")}}

◆ metadata_summary_def_tokens

const std::array<JsonPointer::Token, 2> metadata_summary_def_tokens
static
Initial value:
{
{STR("definitions"), STR("MetadataSummary")}}

◆ require_realm_metadata_cache

std::string require_realm_metadata_cache

◆ required

const std::array<const char *, 2> required
static
Initial value:
= {{
"logger",
"rest_api",
}}

◆ tags_append_tokens

const std::array<JsonPointer::Token, 2> tags_append_tokens
static
Initial value:
{
{STR("tags"), STR("-")}}