Cutelyst::AuthenticationStore Class Reference

Inheritance diagram for Cutelyst::AuthenticationStore:

Public Member Functions
	AuthenticationStore (QObject *parent=nullptr)
virtual AuthenticationUser	autoCreateUser (Context *c, const ParamsMultiMap &userinfo) const
virtual AuthenticationUser	autoUpdateUser (Context *c, const ParamsMultiMap &userinfo) const
virtual bool	canAutoCreateUser () const
virtual bool	canAutoUpdateUser () const
virtual AuthenticationUser	findUser (Context *c, const ParamsMultiMap &userinfo)=0
virtual QVariant	forSession (Context *c, const AuthenticationUser &user)
virtual AuthenticationUser	fromSession (Context *c, const QVariant &frozenUser)

Detailed Description

Definition at line 26 of file authenticationstore.h.

Constructor & Destructor Documentation

AuthenticationStore()

AuthenticationStore::AuthenticationStore ( QObject *  parent = nullptr )

explicit

Constructs a new authentication store object with the given parent.

Definition at line 24 of file authenticationstore.cpp.

Member Function Documentation

autoCreateUser()

AuthenticationUser AuthenticationStore::autoCreateUser ( Context *  c, const ParamsMultiMap &  userinfo  ) const

virtual

Reimplement this if your store supports automatic user creation

Definition at line 39 of file authenticationstore.cpp.

Referenced by Cutelyst::AuthenticationRealm::findUser().

autoUpdateUser()

AuthenticationUser AuthenticationStore::autoUpdateUser ( Context *  c, const ParamsMultiMap &  userinfo  ) const

virtual

Reimplement this if your store supports automatic user update

Definition at line 49 of file authenticationstore.cpp.

Referenced by Cutelyst::AuthenticationRealm::findUser().

canAutoCreateUser()

bool AuthenticationStore::canAutoCreateUser ( ) const

virtual

Reimplement this if your store supports automatic user creation

Definition at line 34 of file authenticationstore.cpp.

Referenced by Cutelyst::AuthenticationRealm::findUser().

canAutoUpdateUser()

bool AuthenticationStore::canAutoUpdateUser ( ) const

virtual

Reimplement this if your store supports automatic user update

Definition at line 44 of file authenticationstore.cpp.

Referenced by Cutelyst::AuthenticationRealm::findUser().

findUser()

virtual AuthenticationUser Cutelyst::AuthenticationStore::findUser ( Context *  c, const ParamsMultiMap &  userinfo  )

pure virtual

Retrieve the user that matches the user info

Implemented in Cutelyst::StoreMinimal, and Cutelyst::StoreHtpasswd.

Referenced by Cutelyst::AuthenticationRealm::findUser().

forSession()

QVariant AuthenticationStore::forSession ( Context *  c, const AuthenticationUser &  user  )

virtual

Reimplement this so that you return a serializable value that can be used to identify the user. The default implementation just returns the user.

Reimplemented in Cutelyst::StoreMinimal, and Cutelyst::StoreHtpasswd.

Definition at line 54 of file authenticationstore.cpp.

Referenced by Cutelyst::AuthenticationRealm::persistUser().

fromSession()

AuthenticationUser AuthenticationStore::fromSession ( Context *  c, const QVariant &  frozenUser  )

virtual

Reimplement this so that you return a User that was stored in the session.

The default implementation just returns the user.

Reimplemented in Cutelyst::StoreMinimal, and Cutelyst::StoreHtpasswd.

Definition at line 60 of file authenticationstore.cpp.

Referenced by Cutelyst::AuthenticationRealm::restoreUser().