#include <handler_authorize_login.h>

Inheritance diagram for mrs::endpoint::handler::HandlerAuthorizeLogin:

Public Types
using	Session = http::SessionManager::Session

using	SessionPtr = http::SessionManager::SessionPtr

using	Matcher = ::mysql_harness::MatcherInterface

Public Types inherited from mrs::rest::Handler
using	HttpUri = ::http::base::Uri

using	Protocol = ::mrs::endpoint::handler::Protocol

using	UriPathMatcher = ::http::base::UriPathMatcher

Public Types inherited from mrs::interface::RestHandler
enum class	Authorization { kNotNeeded , kRequires , kCheck }

using	SqlSession = mysqlrouter::MySQLSession

using	RequestContext = mrs::rest::RequestContext

using	Parameters = mrs::interface::Parameters

using	HttpResult = mrs::interface::HttpResult

Public Member Functions
	HandlerAuthorizeLogin (const Protocol protocol, const std::string &url_host, const UniversalId service_id, const std::string &service_path, const UriPathMatcher &rest_path_matcher, const std::string &options, const std::string &redirection, const std::optional< std::string > &redirection_validator, interface::AuthorizeManager *auth_manager)

Authorization	requires_authentication () const override

bool	may_check_access () const override

UniversalId	get_service_id () const override

UniversalId	get_db_object_id () const override

UniversalId	get_schema_id () const override

const std::string &	get_service_path () const override

const std::string &	get_db_object_path () const override

const std::string &	get_schema_path () const override

uint32_t	get_access_rights () const override

bool	request_begin (RequestContext *) override

bool	request_error (RequestContext *ctxt, const http::Error &e) override

HttpResult	handle_get (RequestContext *ctxt) override

HttpResult	handle_post (RequestContext *ctxt, const std::vector< uint8_t > &document) override

HttpResult	handle_delete (RequestContext *ctxt) override

HttpResult	handle_put (RequestContext *ctxt) override

Public Member Functions inherited from mrs::endpoint::handler::HandlerAuthorizeBase
void	request_end (RequestContext *ctxt) override

Public Member Functions inherited from mrs::rest::Handler
	Handler (const Protocol protocol, const std::string &url_host, const std::vector< UriPathMatcher > &rest_path_matcher, const std::optional< std::string > &options, interface::AuthorizeManager *auth_manager)

	~Handler () override

void	initialize (const Configuration &configuration) override

const std::string &	get_url_host () const override

const std::string &	get_protocol () const override

bool	may_check_access () const override

void	authorization (RequestContext *ctxt) override

bool	request_begin (RequestContext *ctxt) override

void	request_end (RequestContext *ctxt) override

bool	request_error (RequestContext *ctxt, const http::Error &e) override
	Error handler. More...

const interface::Options &	get_options () const override

void	throw_unauthorize_when_check_auth_fails (RequestContext *)

uint32_t	check_privileges (const std::vector< database::entry::AuthPrivilege > &privileges, const UniversalId &service_id, const std::string &service_path, const UniversalId &schema_id, const std::string &schema_path, const UniversalId &db_object_id, const std::string &db_object_path)

Public Member Functions inherited from mrs::interface::RestHandler
virtual	~RestHandler ()=default

virtual void	initialize (const Configuration &configuration)=0

Private Member Functions
std::string	append_status_parameters (const SessionPtr &session, const http::Error &error) const

void	set_session_cookie (RequestContext *ctxt) const

Private Attributes
UniversalId	service_id_

const std::string	service_path_

const std::string	redirection_

std::string	copy_url_

std::string	copy_path_

std::shared_ptr< Matcher >	redirection_validator_

Additional Inherited Members
Protected Member Functions inherited from mrs::rest::Handler
const std::string &	empty_path () const

Protected Attributes inherited from mrs::rest::Handler
interface::Options	options_

const std::string	url_host_

std::vector< UriPathMatcher >	rest_path_matcher_

std::vector< void * >	handler_id_

interface::AuthorizeManager *	authorization_manager_

const std::string	protocol_

std::shared_ptr< Configuration >	configuration_

bool	log_level_is_debug_

bool	log_level_is_info_

Member Typedef Documentation

◆ Matcher

using mrs::endpoint::handler::HandlerAuthorizeLogin::Matcher = ::mysql_harness::MatcherInterface

◆ Session

using mrs::endpoint::handler::HandlerAuthorizeLogin::Session = http::SessionManager::Session

◆ SessionPtr

using mrs::endpoint::handler::HandlerAuthorizeLogin::SessionPtr = http::SessionManager::SessionPtr

Constructor & Destructor Documentation

◆ HandlerAuthorizeLogin()

mrs::endpoint::handler::HandlerAuthorizeLogin::HandlerAuthorizeLogin	(	const Protocol	protocol,
		const std::string &	url_host,
		const UniversalId	service_id,
		const std::string &	service_path,
		const UriPathMatcher &	rest_path_matcher,
		const std::string &	options,
		const std::string &	redirection,
		const std::optional< std::string > &	redirection_validator,
		interface::AuthorizeManager *	auth_manager
	)

Member Function Documentation

◆ append_status_parameters()

std::string mrs::endpoint::handler::HandlerAuthorizeLogin::append_status_parameters	(	const SessionPtr &	session,
		const http::Error &	error
	)		const

private

◆ get_access_rights()

uint32_t mrs::endpoint::handler::HandlerAuthorizeLogin::get_access_rights ( ) const

overridevirtual

Implements mrs::interface::RestHandler.

◆ get_db_object_id()

UniversalId mrs::endpoint::handler::HandlerAuthorizeLogin::get_db_object_id ( ) const

overridevirtual

Implements mrs::interface::RestHandler.

◆ get_db_object_path()

const std::string & mrs::endpoint::handler::HandlerAuthorizeLogin::get_db_object_path ( ) const

overridevirtual

Implements mrs::interface::RestHandler.

◆ get_schema_id()

UniversalId mrs::endpoint::handler::HandlerAuthorizeLogin::get_schema_id ( ) const

overridevirtual

Implements mrs::interface::RestHandler.

◆ get_schema_path()

const std::string & mrs::endpoint::handler::HandlerAuthorizeLogin::get_schema_path ( ) const

overridevirtual

Implements mrs::interface::RestHandler.

◆ get_service_id()

UniversalId mrs::endpoint::handler::HandlerAuthorizeLogin::get_service_id ( ) const

overridevirtual

Implements mrs::interface::RestHandler.

◆ get_service_path()

const std::string & mrs::endpoint::handler::HandlerAuthorizeLogin::get_service_path ( ) const

overridevirtual

Implements mrs::interface::RestHandler.

◆ handle_delete()

HttpResult mrs::endpoint::handler::HandlerAuthorizeLogin::handle_delete ( RequestContext * ctxt )

overridevirtual

Implements mrs::interface::RestHandler.

◆ handle_get()

HttpResult mrs::endpoint::handler::HandlerAuthorizeLogin::handle_get ( RequestContext * ctxt )

overridevirtual

Implements mrs::interface::RestHandler.

◆ handle_post()

HttpResult mrs::endpoint::handler::HandlerAuthorizeLogin::handle_post	(	RequestContext *	ctxt,
		const std::vector< uint8_t > &	document
	)

overridevirtual

Implements mrs::interface::RestHandler.

◆ handle_put()

HttpResult mrs::endpoint::handler::HandlerAuthorizeLogin::handle_put ( RequestContext * ctxt )

overridevirtual

Implements mrs::interface::RestHandler.

◆ may_check_access()

bool mrs::endpoint::handler::HandlerAuthorizeLogin::may_check_access ( ) const

overridevirtual

Implements mrs::interface::RestHandler.

◆ request_begin()

bool mrs::endpoint::handler::HandlerAuthorizeLogin::request_begin ( RequestContext * ctxt )

overridevirtual

Implements mrs::interface::RestHandler.

◆ request_error()

bool mrs::endpoint::handler::HandlerAuthorizeLogin::request_error	(	RequestContext *	ctxt,
		const http::Error &	e
	)

overridevirtual

Reimplemented from mrs::endpoint::handler::HandlerAuthorizeBase.

◆ requires_authentication()

mrs::rest::Handler::Authorization mrs::endpoint::handler::HandlerAuthorizeLogin::requires_authentication ( ) const

overridevirtual

Implements mrs::interface::RestHandler.

◆ set_session_cookie()

void mrs::endpoint::handler::HandlerAuthorizeLogin::set_session_cookie ( RequestContext * ctxt ) const

private

Member Data Documentation

◆ copy_path_

std::string mrs::endpoint::handler::HandlerAuthorizeLogin::copy_path_

private

◆ copy_url_

std::string mrs::endpoint::handler::HandlerAuthorizeLogin::copy_url_

private

◆ redirection_

const std::string mrs::endpoint::handler::HandlerAuthorizeLogin::redirection_

private

◆ redirection_validator_

std::shared_ptr<Matcher> mrs::endpoint::handler::HandlerAuthorizeLogin::redirection_validator_

private

◆ service_id_

UniversalId mrs::endpoint::handler::HandlerAuthorizeLogin::service_id_

private

◆ service_path_

const std::string mrs::endpoint::handler::HandlerAuthorizeLogin::service_path_

private

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

router/src/mysql_rest_service/src/mrs/endpoint/handler/authentication/handler_authorize_login.h
router/src/mysql_rest_service/src/mrs/endpoint/handler/authentication/handler_authorize_login.cc

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ Matcher

◆ Session

◆ SessionPtr

Constructor & Destructor Documentation

◆ HandlerAuthorizeLogin()

Member Function Documentation

◆ append_status_parameters()

◆ get_access_rights()

◆ get_db_object_id()

◆ get_db_object_path()

◆ get_schema_id()

◆ get_schema_path()

◆ get_service_id()

◆ get_service_path()

◆ handle_delete()

◆ handle_get()

◆ handle_post()

◆ handle_put()

◆ may_check_access()

◆ request_begin()

◆ request_error()

◆ requires_authentication()

◆ set_session_cookie()

Member Data Documentation

◆ copy_path_

◆ copy_url_

◆ redirection_

◆ redirection_validator_

◆ service_id_

◆ service_path_