mrs::interface::AuthorizeHandler Class Reference

#include <authorize_handler.h>

Inheritance diagram for mrs::interface::AuthorizeHandler:

Public Types
using	SqlSessionCached = collector::MysqlCacheManager::CachedObject
using	AuthUser = mrs::database::entry::AuthUser
using	AuthApp = mrs::database::entry::AuthApp
using	RequestContext = rest::RequestContext
using	Session = http::SessionManager::Session
using	SessionPtr = http::SessionManager::SessionPtr
using	UserManager = mrs::users::UserManager

Public Member Functions
virtual	~AuthorizeHandler ()=default
virtual bool	redirects (RequestContext &ctxt) const =0
virtual std::set< UniversalId >	get_service_ids () const =0
virtual UniversalId	get_id () const =0
virtual const std::string &	get_handler_name () const =0
virtual const AuthApp &	get_entry () const =0
virtual UserManager &	get_user_manager ()=0
virtual bool	authorize (RequestContext &ctxt, const SessionPtr &session, AuthUser *out_user)=0
virtual std::optional< std::string >	get_session_id_from_request_data (RequestContext &ctxt)=0
virtual void	pre_authorize_account (AuthorizeHandler *handler, const std::string &account)=0

Member Typedef Documentation

AuthApp

using mrs::interface::AuthorizeHandler::AuthApp = mrs::database::entry::AuthApp

AuthUser

using mrs::interface::AuthorizeHandler::AuthUser = mrs::database::entry::AuthUser

RequestContext

using mrs::interface::AuthorizeHandler::RequestContext = rest::RequestContext

Session

using mrs::interface::AuthorizeHandler::Session = http::SessionManager::Session

SessionPtr

using mrs::interface::AuthorizeHandler::SessionPtr = http::SessionManager::SessionPtr

SqlSessionCached

using mrs::interface::AuthorizeHandler::SqlSessionCached = collector::MysqlCacheManager::CachedObject

UserManager

using mrs::interface::AuthorizeHandler::UserManager = mrs::users::UserManager

Constructor & Destructor Documentation

~AuthorizeHandler()

virtual mrs::interface::AuthorizeHandler::~AuthorizeHandler ( )

virtualdefault

Member Function Documentation

authorize()

virtual bool mrs::interface::AuthorizeHandler::authorize ( RequestContext &  ctxt, const SessionPtr &  session, AuthUser *  out_user  )

pure virtual

Implemented in mrs::authentication::Oauth2Handler, mrs::authentication::SaslHandler, and mrs::authentication::WwwAuthenticationHandler.

get_entry()

virtual const AuthApp & mrs::interface::AuthorizeHandler::get_entry ( ) const

pure virtual

Implemented in mrs::authentication::Oauth2Handler, mrs::authentication::SaslHandler, and mrs::authentication::WwwAuthenticationHandler.

get_handler_name()

virtual const std::string & mrs::interface::AuthorizeHandler::get_handler_name ( ) const

pure virtual

Implemented in mrs::authentication::MysqlHandler, mrs::authentication::Oauth2FacebookHandler, mrs::authentication::Oauth2GoogleHandler, mrs::authentication::Oauth2OidcHandler, and mrs::authentication::ScramHandler.

get_id()

virtual UniversalId mrs::interface::AuthorizeHandler::get_id ( ) const

pure virtual

Implemented in mrs::authentication::MysqlHandler, mrs::authentication::Oauth2Handler, and mrs::authentication::SaslHandler.

get_service_ids()

virtual std::set< UniversalId > mrs::interface::AuthorizeHandler::get_service_ids ( ) const

pure virtual

Implemented in mrs::authentication::MysqlHandler, mrs::authentication::Oauth2Handler, and mrs::authentication::SaslHandler.

get_session_id_from_request_data()

virtual std::optional< std::string > mrs::interface::AuthorizeHandler::get_session_id_from_request_data ( RequestContext &  ctxt )

pure virtual

Implemented in mrs::authentication::ScramHandler, mrs::authentication::WwwAuthenticationHandler, and mrs::authentication::Oauth2Handler.

get_user_manager()

virtual UserManager & mrs::interface::AuthorizeHandler::get_user_manager ( )

pure virtual

Implemented in mrs::authentication::Oauth2Handler, mrs::authentication::SaslHandler, and mrs::authentication::WwwAuthenticationHandler.

pre_authorize_account()

virtual void mrs::interface::AuthorizeHandler::pre_authorize_account ( AuthorizeHandler *  handler, const std::string &  account  )

pure virtual

redirects()

virtual bool mrs::interface::AuthorizeHandler::redirects ( RequestContext &  ctxt ) const

pure virtual

Implemented in mrs::authentication::Oauth2Handler, mrs::authentication::SaslHandler, mrs::authentication::ScramHandler, and mrs::authentication::WwwAuthenticationHandler.

---

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

• router/src/mysql_rest_service/include/mrs/interface/authorize_handler.h