rest_connection_pool_plugin.cc File Reference

#include <array>
#include <string>
#include "mysql/harness/config_option.h"
#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/rest_connection_pool_export.h"
#include "rest_connection_pool_config.h"
#include "rest_connection_pool_list.h"
#include "rest_connection_pool_status.h"

Classes
class	RestConnectionPoolPluginConfig
class	anonymous_namespace{rest_connection_pool_plugin.cc}::RestConnectionPoolConfigExposer

Namespaces
namespace	anonymous_namespace{rest_connection_pool_plugin.cc}

Macros
#define	GET_OPTION_CHECKED(option, section, name, value)

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 const char	kSectionName [] {"rest_connection_pool"}
static constexpr const char	kRequireRealm [] {"require_realm"}
static constexpr const std::array	supported_options
std::string	require_realm_connection_pool
static const std::array	route_name_param_tokens
static const std::array	connection_pool_list_def_tokens
static const std::array	connection_pool_summary_def_tokens
static const std::array	connection_pool_config_def_tokens
static const std::array	connection_pool_status_def_tokens
static const std::array	connection_pool_status_path_tokens
static const std::array	connection_pool_config_path_tokens
static const std::array	connection_pool_list_path_tokens
static const std::array	tags_append_tokens
static constexpr std::array	required
mysql_harness::Plugin REST_CONNECTION_POOL_EXPORT	harness_plugin_rest_connection_pool

Macro Definition Documentation

GET_OPTION_CHECKED

#define GET_OPTION_CHECKED	(		option,
			section,
			name,
			value
	)

Value:

  static_assert(mysql_harness::str_in_collection(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

connection_pool_config_def_tokens

const std::array connection_pool_config_def_tokens

static

Initial value:

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

connection_pool_config_path_tokens

const std::array connection_pool_config_path_tokens

static

Initial value:

{
    make_json_pointer_token("paths"),
    make_json_pointer_token("/connection_pool/{connectionPoolName}/config"),
}

connection_pool_list_def_tokens

const std::array connection_pool_list_def_tokens

static

Initial value:

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

connection_pool_list_path_tokens

const std::array connection_pool_list_path_tokens

static

Initial value:

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

connection_pool_status_def_tokens

const std::array connection_pool_status_def_tokens

static

Initial value:

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

connection_pool_status_path_tokens

const std::array connection_pool_status_path_tokens

static

Initial value:

{
    make_json_pointer_token("paths"),
    make_json_pointer_token("/connection_pool/{connectionPoolName}/status"),
}

connection_pool_summary_def_tokens

const std::array connection_pool_summary_def_tokens

static

Initial value:

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

harness_plugin_rest_connection_pool

mysql_harness::Plugin REST_CONNECTION_POOL_EXPORT harness_plugin_rest_connection_pool

Initial value:

= {
        mysql_harness::PLUGIN_ABI_VERSION,       
        mysql_harness::ARCHITECTURE_DESCRIPTOR,  
        "REST_CONNECTION_POOL",                  
        VERSION_NUMBER(0, 0, 1),
        
        required.size(),
        required.data(),
        
        0,
        nullptr,
        init,     
        nullptr,  
        start,    
        nullptr,  
        true,     
        supported_options.size(),
        supported_options.data(),
        expose_configuration,
}

kRequireRealm

constexpr const char kRequireRealm[] {"require_realm"}

staticconstexpr

kSectionName

constexpr const char kSectionName[] {"rest_connection_pool"}

staticconstexpr

require_realm_connection_pool

std::string require_realm_connection_pool

required

constexpr std::array required

staticconstexpr

Initial value:

{
    "logger",
    "rest_api",
}

route_name_param_tokens

const std::array route_name_param_tokens

static

Initial value:

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

supported_options

constexpr const std::array supported_options

staticconstexpr

Initial value:

{
    kRequireRealm,
}

tags_append_tokens

const std::array tags_append_tokens

static

Initial value:

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