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	DLLEXPORT

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

Functions
static void	init (mysql_harness::PluginFuncEnv *env)
static JsonPointer::Token	make_json_pointer_token (std::string_view token)
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	metadata_name_param_tokens
static const std::array	cluster_name_param_tokens
static const std::array	metadata_status_def_tokens
static const std::array	metadata_list_def_tokens
static const std::array	metadata_summary_def_tokens
static const std::array	metadata_config_def_tokens
static const std::array	cluster_node_summary_def_tokens
static const std::array	cluster_node_list_def_tokens
static const std::array	cluster_summary_def_tokens
static const std::array	cluster_list_def_tokens
static const std::array	metadata_status_path_tokens
static const std::array	metadata_config_path_tokens
static const std::array	metadata_list_path_tokens
static const std::array	tags_append_tokens
static constexpr std::array	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);

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

)

make_json_pointer_token()

static JsonPointer::Token make_json_pointer_token ( std::string_view  token )

static

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 cluster_list_def_tokens

static

Initial value:

{
    make_json_pointer_token("definitions"),
    make_json_pointer_token("ClusterList"),
}

cluster_name_param_tokens

const std::array cluster_name_param_tokens

static

Initial value:

{
    make_json_pointer_token("parameters"),
    make_json_pointer_token("clusterNameParam"),
}

cluster_node_list_def_tokens

const std::array cluster_node_list_def_tokens

static

Initial value:

{
    make_json_pointer_token("definitions"),
    make_json_pointer_token("ClusterNodeList"),
}

cluster_node_summary_def_tokens

const std::array cluster_node_summary_def_tokens

static

Initial value:

{
    make_json_pointer_token("definitions"),
    make_json_pointer_token("ClusterNodeSummary"),
}

cluster_summary_def_tokens

const std::array cluster_summary_def_tokens

static

Initial value:

{
    make_json_pointer_token("definitions"),
    make_json_pointer_token("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,
}

kRequireRealm

constexpr char kRequireRealm[] {"require_realm"}

staticconstexpr

kSectionName

constexpr char kSectionName[] {"rest_metadata_cache"}

staticconstexpr

metadata_config_def_tokens

const std::array metadata_config_def_tokens

static

Initial value:

{
    make_json_pointer_token("definitions"),
    make_json_pointer_token("MetadataConfig"),
}

metadata_config_path_tokens

const std::array metadata_config_path_tokens

static

Initial value:

{
    make_json_pointer_token("paths"),
    make_json_pointer_token("/metadata/{metadataName}/config"),
}

metadata_list_def_tokens

const std::array metadata_list_def_tokens

static

Initial value:

{
    make_json_pointer_token("definitions"),
    make_json_pointer_token("MetadataList"),
}

metadata_list_path_tokens

const std::array metadata_list_path_tokens

static

Initial value:

{
    make_json_pointer_token("paths"),
    make_json_pointer_token("/metadata"),
}

metadata_name_param_tokens

const std::array metadata_name_param_tokens

static

Initial value:

{
    make_json_pointer_token("parameters"),
    make_json_pointer_token("metadataNameParam"),
}

metadata_status_def_tokens

const std::array metadata_status_def_tokens

static

Initial value:

{
    make_json_pointer_token("definitions"),
    make_json_pointer_token("MetadataStatus"),
}

metadata_status_path_tokens

const std::array metadata_status_path_tokens

static

Initial value:

{
    make_json_pointer_token("paths"),
    make_json_pointer_token("/metadata/{metadataName}/status"),
}

metadata_summary_def_tokens

const std::array metadata_summary_def_tokens

static

Initial value:

{
    make_json_pointer_token("definitions"),
    make_json_pointer_token("MetadataSummary"),
}

require_realm_metadata_cache

std::string require_realm_metadata_cache

required

constexpr std::array required

staticconstexpr

Initial value:

{
    "logger",
    
    "rest_api",
}

tags_append_tokens

const std::array tags_append_tokens

static

Initial value:

{
    make_json_pointer_token("tags"),
    make_json_pointer_token("-"),
}