Cutelyst  2.13.0
Public Member Functions | Static Public Attributes | Friends | List of all members
Cutelyst::AuthenticationRealm Class Reference
Inheritance diagram for Cutelyst::AuthenticationRealm:
Inheritance graph

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. More...
virtual AuthenticationUser authenticate (Context *c, const ParamsMultiMap &authinfo)
 Tries to authenticate the user with authinfo returning a non null AuthenticationUser on success.
AuthenticationCredentialcredential () 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.
AuthenticationStorestore () 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


class Authentication
class AuthenticationPrivate

Additional Inherited Members

- Public Types inherited from Cutelyst::Component
enum  Modifier {
  None, OnlyExecute, BeforeExecute, AroundExecute,
- 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 30 of file authenticationrealm.h.

Constructor & Destructor Documentation

◆ AuthenticationRealm()

AuthenticationRealm::AuthenticationRealm ( AuthenticationStore store,
AuthenticationCredential credential,
const QString &  name = QLatin1String(defaultRealm),
QObject *  parent = nullptr 
This class will take ownership of store and credential.

Definition at line 34 of file authenticationrealm.cpp.

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