Cutelyst  1.8.0
Public Member Functions | Protected Member Functions | Friends | List of all members
Cutelyst::AuthenticationRealm Class Reference
Inheritance diagram for Cutelyst::AuthenticationRealm:
Inheritance graph
[legend]

Public Member Functions

 AuthenticationRealm (AuthenticationStore *store, AuthenticationCredential *credential, QObject *parent=nullptr)
 Constructs a new AuthenticationRealm object with the given parent.
 
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.
 
AuthenticationStorestore () const
 Returns the authentication store object.
 
- 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)
 

Protected Member Functions

AuthenticationUser persistUser (Context *c, const AuthenticationUser &user)
 Stores the user on the session TODO move out on Cutelyst2.
 
void removePersistedUser (Context *c)
 Removes the user from the session TODO move out on Cutelyst2.
 
AuthenticationUser restoreUser (Context *c, const QVariant &frozenUser)
 Retrieves the user from the store TODO move out on Cutelyst2.
 
QVariant userIsRestorable (Context *c)
 Checks if user can be retrieved TODO move out on Cutelyst2.
 
- Protected Member Functions inherited from Cutelyst::Component
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)
 

Friends

class Authentication
 
class AuthenticationPrivate
 

Additional Inherited Members

- Public Types inherited from Cutelyst::Component
enum  Modifier {
  None, OnlyExecute, BeforeExecute, AroundExecute,
  AfterExecute
}
 

Detailed Description

Definition at line 32 of file authenticationrealm.h.