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 13 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 11 of file authenticationstore.cpp.

Referenced by Cutelyst::StoreHtpasswd::StoreHtpasswd(), and Cutelyst::StoreMinimal::StoreMinimal().

~AuthenticationStore()

AuthenticationStore::~AuthenticationStore ( )

virtual

Definition at line 16 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 25 of file authenticationstore.cpp.

autoUpdateUser()

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

virtual

Reimplement this if your store supports automatic user update

Definition at line 38 of file authenticationstore.cpp.

canAutoCreateUser()

bool AuthenticationStore::canAutoCreateUser ( ) const

virtual

Reimplement this if your store supports automatic user creation

Definition at line 20 of file authenticationstore.cpp.

canAutoUpdateUser()

bool AuthenticationStore::canAutoUpdateUser ( ) const

virtual

Reimplement this if your store supports automatic user update

Definition at line 33 of file authenticationstore.cpp.

findUser()

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

pure virtual

Retrieve the user that matches the user info

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

References forSession(), and fromSession().

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::StoreHtpasswd, and Cutelyst::StoreMinimal.

Definition at line 46 of file authenticationstore.cpp.

Referenced by findUser().

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::StoreHtpasswd, and Cutelyst::StoreMinimal.

Definition at line 52 of file authenticationstore.cpp.

Referenced by findUser().