Cutelyst  2.14.2
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)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectList & children () const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const
 
bool disconnect (const QObject *receiver, const char *method) const
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const
 
bool inherits (const char *className) const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const
 
bool isWindowType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval, Qt::TimerType timerType)
 
QThreadthread () const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Definition at line 26 of file authenticationstore.h.

Constructor & Destructor Documentation

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

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().

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

Reimplement this if your store supports automatic user update

Definition at line 51 of file authenticationstore.cpp.

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

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().

bool AuthenticationStore::canAutoUpdateUser ( ) const
virtual

Reimplement this if your store supports automatic user update

Definition at line 46 of file authenticationstore.cpp.

Referenced by Cutelyst::AuthenticationRealm::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().

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

References QVariant::fromValue().

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

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

References QVariant::value().

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