Cutelyst  1.5.0
Public Member Functions | List of all members
Cutelyst::AuthenticationStore Class Referenceabstract
Inheritance diagram for Cutelyst::AuthenticationStore:
Inheritance graph
[legend]

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 28 of file authenticationstore.h.

Member Function Documentation

virtual AuthenticationUser Cutelyst::AuthenticationStore::autoCreateUser ( Context c,
const ParamsMultiMap userinfo 
) const
virtual

Reimplement this if your store supports automatic user creation

virtual AuthenticationUser Cutelyst::AuthenticationStore::autoUpdateUser ( Context c,
const ParamsMultiMap userinfo 
) const
virtual

Reimplement this if your store supports automatic user update

virtual bool Cutelyst::AuthenticationStore::canAutoCreateUser ( ) const
virtual

Reimplement this if your store supports automatic user creation

virtual bool Cutelyst::AuthenticationStore::canAutoUpdateUser ( ) const
virtual

Reimplement this if your store supports automatic user update

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.

virtual QVariant Cutelyst::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.

virtual AuthenticationUser Cutelyst::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.