MySQL 8.0.30
Source Code Documentation
HttpAuthBackendComponent Class Reference

public API of the HttpAuthBackend plugin. More...

#include <http_auth_backend_component.h>

Public Types

using value_type = std::map< std::string, std::shared_ptr< HttpAuthBackend > >
 

Public Member Functions

void add_backend (const std::string &name, std::shared_ptr< HttpAuthBackend > backend)
 register an authentication backend. More...
 
void remove_backend (const std::string &name)
 unregister an authentication backend. More...
 
std::error_code authenticate (const std::string &inst, const std::string &username, const std::string &authdata)
 authenticate user against auth-backend. More...
 

Static Public Member Functions

static HttpAuthBackendComponentget_instance ()
 get instance of Component. More...
 

Private Member Functions

 HttpAuthBackendComponent (HttpAuthBackendComponent const &)=delete
 
void operator= (HttpAuthBackendComponent const &)=delete
 
 HttpAuthBackendComponent ()=default
 

Private Attributes

std::mutex backends_m_
 
value_type auth_backends_
 

Detailed Description

public API of the HttpAuthBackend plugin.

Member Typedef Documentation

◆ value_type

using HttpAuthBackendComponent::value_type = std::map<std::string, std::shared_ptr<HttpAuthBackend> >

Constructor & Destructor Documentation

◆ HttpAuthBackendComponent() [1/2]

HttpAuthBackendComponent::HttpAuthBackendComponent ( HttpAuthBackendComponent const &  )
privatedelete

◆ HttpAuthBackendComponent() [2/2]

HttpAuthBackendComponent::HttpAuthBackendComponent ( )
privatedefault

Member Function Documentation

◆ add_backend()

void HttpAuthBackendComponent::add_backend ( const std::string &  name,
std::shared_ptr< HttpAuthBackend backend 
)

register an authentication backend.

◆ authenticate()

std::error_code HttpAuthBackendComponent::authenticate ( const std::string &  inst,
const std::string &  username,
const std::string &  authdata 
)

authenticate user against auth-backend.

Returns
error
Return values
falseauthentication without error.

◆ get_instance()

HttpAuthBackendComponent & HttpAuthBackendComponent::get_instance ( )
static

get instance of Component.

◆ operator=()

void HttpAuthBackendComponent::operator= ( HttpAuthBackendComponent const &  )
privatedelete

◆ remove_backend()

void HttpAuthBackendComponent::remove_backend ( const std::string &  name)

unregister an authentication backend.

Member Data Documentation

◆ auth_backends_

value_type HttpAuthBackendComponent::auth_backends_
private

◆ backends_m_

std::mutex HttpAuthBackendComponent::backends_m_
private

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