Inheritance diagram for Cutelyst::AuthenticationRealm:

[legend]

Public Member Functions
	AuthenticationRealm (AuthenticationStore store, AuthenticationCredential credential, const QString &name=QLatin1String(defaultRealm), QObject *parent=nullptr)
	Constructs a new AuthenticationRealm object with the given parent.

virtual AuthenticationUser	authenticate (Context *c, const ParamsMultiMap &authinfo)
	Tries to authenticate the user with `authinfo` returning a non null AuthenticationUser on success.

AuthenticationCredential *	credential () const
	Returns the authentication credential object.

virtual AuthenticationUser	findUser (Context *c, const ParamsMultiMap &userinfo)
	Tries to find the user with `authinfo` returning a non null AuthenticationUser on success.

AuthenticationUser	persistUser (Context *c, const AuthenticationUser &user)
	Stores the user on the session.

void	removePersistedUser (Context *c)
	Removes the user from the session.

AuthenticationUser	restoreUser (Context *c, const QVariant &frozenUser)
	Retrieves the user from the store.

AuthenticationStore *	store () const
	Returns the authentication store object.

QVariant	userIsRestorable (Context *c)
	Checks if user can be retrieved.

Public Member Functions inherited from Cutelyst::Component
	Component (QObject *parent=nullptr)

bool	execute (Context *c)

virtual bool	init (Application *application, const QVariantHash &args)

virtual Modifiers	modifiers () const

QString	name () const

QString	reverse () const

void	setName (const QString &name)

void	setReverse (const QString &reverse)

Static Public Attributes
static char *	defaultRealm
	default realm name

Friends
class	Authentication

class	AuthenticationPrivate

Additional Inherited Members
Public Types inherited from Cutelyst::Component
enum	Modifier { None , OnlyExecute , BeforeExecute , AroundExecute , AfterExecute }

Protected Member Functions inherited from Cutelyst::Component
	Component (ComponentPrivate d, QObject parent=nullptr)
	A derived class using pimpl should call this constructor, to reduce the number of memory allocations.

virtual bool	afterExecute (Context *c)

void	applyRoles (const QStack< Component * > &roles)

virtual bool	aroundExecute (Context c, QStack< Component > stack)

virtual bool	beforeExecute (Context *c)

virtual bool	dispatcherReady (const Dispatcher dispatch, Controller controller)

virtual bool	doExecute (Context *c)

Detailed Description

Definition at line 17 of file authenticationrealm.h.

Constructor & Destructor Documentation

◆ AuthenticationRealm()

AuthenticationRealm::AuthenticationRealm	(	AuthenticationStore *	store,
		AuthenticationCredential *	credential,
		const QString &	name = `QLatin1String(defaultRealm)`,
		QObject *	parent = `nullptr`
	)

explicit

Note: This class will take ownership of store and credential.

Definition at line 20 of file authenticationrealm.cpp.

References Cutelyst::Component::name(), and Cutelyst::Component::setName().

◆ ~AuthenticationRealm()

AuthenticationRealm::~AuthenticationRealm ( )

overridevirtual

Definition at line 34 of file authenticationrealm.cpp.

Member Function Documentation

◆ authenticate()

AuthenticationUser AuthenticationRealm::authenticate	(	Context *	c,
		const ParamsMultiMap &	authinfo
	)

virtual

Definition at line 69 of file authenticationrealm.cpp.

References Cutelyst::AuthenticationCredential::authenticate().

Referenced by Cutelyst::Authentication::authenticate().

◆ credential()

AuthenticationCredential * AuthenticationRealm::credential ( ) const

Definition at line 43 of file authenticationrealm.cpp.

◆ findUser()

AuthenticationUser AuthenticationRealm::findUser	(	Context *	c,
		const ParamsMultiMap &	userinfo
	)

virtual

Definition at line 48 of file authenticationrealm.cpp.

References Cutelyst::AuthenticationUser::authRealm(), Cutelyst::AuthenticationStore::autoCreateUser(), Cutelyst::AuthenticationStore::autoUpdateUser(), Cutelyst::AuthenticationStore::canAutoCreateUser(), Cutelyst::AuthenticationStore::canAutoUpdateUser(), Cutelyst::AuthenticationStore::findUser(), Cutelyst::AuthenticationUser::isNull(), Cutelyst::Component::name(), and Cutelyst::AuthenticationUser::setAuthRealm().

Referenced by Cutelyst::CredentialPassword::authenticate(), and Cutelyst::Authentication::findUser().

◆ persistUser()

AuthenticationUser AuthenticationRealm::persistUser	(	Context *	c,
		const AuthenticationUser &	user
	)

Definition at line 81 of file authenticationrealm.cpp.

References Cutelyst::AuthenticationStore::forSession(), and Cutelyst::Session::setValue().

◆ removePersistedUser()

void AuthenticationRealm::removePersistedUser ( Context * c )

Definition at line 74 of file authenticationrealm.cpp.

References Cutelyst::Session::deleteValues().

Referenced by Cutelyst::Authentication::logout().

◆ restoreUser()

AuthenticationUser AuthenticationRealm::restoreUser	(	Context *	c,
		const QVariant &	frozenUser
	)

Definition at line 89 of file authenticationrealm.cpp.

References Cutelyst::AuthenticationStore::fromSession(), Cutelyst::AuthenticationUser::isNull(), Cutelyst::AuthenticationUser::setAuthRealm(), and userIsRestorable().

◆ store()

AuthenticationStore * AuthenticationRealm::store ( ) const

Definition at line 38 of file authenticationrealm.cpp.

◆ userIsRestorable()

QVariant AuthenticationRealm::userIsRestorable ( Context * c )

Definition at line 114 of file authenticationrealm.cpp.

References Cutelyst::Session::value().

Referenced by restoreUser().

Friends And Related Symbol Documentation

◆ Authentication

friend class Authentication

friend

Definition at line 76 of file authenticationrealm.h.

◆ AuthenticationPrivate

friend class AuthenticationPrivate

friend

Definition at line 77 of file authenticationrealm.h.

Member Data Documentation

◆ defaultRealm

char * AuthenticationRealm::defaultRealm

static

Definition at line 22 of file authenticationrealm.h.

Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members