cutelyst 3.9.1
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
Cutelyst::AuthenticationRealm Class Reference
Inheritance diagram for Cutelyst::AuthenticationRealm:
Inheritance graph
[legend]

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.
virtual AuthenticationUser authenticate (Context *c, const ParamsMultiMap &authinfo)
 Tries to authenticate the user with authinfo returning a non null AuthenticationUser on success.
AuthenticationCredential * credential () 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.
AuthenticationStore * store () 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)
Public Member Functions inherited from QObject
 QObject (QObject *parent)
bool blockSignals (bool block)
const QObjectList & children () const const
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void deleteLater ()
void destroyed (QObject *obj)
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool disconnect (const QObject *receiver, const char *method) const const
void dumpObjectInfo ()
void dumpObjectInfo () const const
void dumpObjectTree ()
void dumpObjectTree () const const
QList< QByteArray > dynamicPropertyNames () const const
virtual bool event (QEvent *e)
virtual bool eventFilter (QObject *watched, QEvent *event)
T findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
bool inherits (const char *className) const const
void installEventFilter (QObject *filterObj)
bool isWidgetType () const const
bool isWindowType () const const
void killTimer (int id)
virtual const QMetaObject * metaObject () const const
void moveToThread (QThread *targetThread)
QString objectName () const const
void objectNameChanged (const QString &objectName, QPrivateSignal)
QObject * parent () const const
QVariant property (const char *name) const const
 Q_CLASSINFO (Name, Value)
 Q_DISABLE_COPY (Class)
 Q_DISABLE_COPY_MOVE (Class)
 Q_DISABLE_MOVE (Class)
 Q_EMIT Q_EMIT
 Q_ENUM (...)
 Q_ENUM_NS (...)
 Q_ENUMS (...)
 Q_FLAG (...)
 Q_FLAG_NS (...)
 Q_FLAGS (...)
 Q_GADGET Q_GADGET
 Q_INTERFACES (...)
 Q_INVOKABLE Q_INVOKABLE
 Q_NAMESPACE Q_NAMESPACE
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 Q_OBJECT Q_OBJECT
 Q_PROPERTY (...)
 Q_REVISION Q_REVISION
 Q_SET_OBJECT_NAME (Object)
 Q_SIGNAL Q_SIGNAL
 Q_SIGNALS Q_SIGNALS
 Q_SLOT Q_SLOT
 Q_SLOTS Q_SLOTS
T qFindChild (const QObject *obj, const QString &name)
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T > qFindChildren (const QObject *obj, const QString &name)
T qobject_cast (const QObject *object)
T qobject_cast (QObject *object)
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void removeEventFilter (QObject *obj)
void setObjectName (const QString &name)
void setParent (QObject *parent)
bool setProperty (const char *name, const QVariant &value)
bool signalsBlocked () const const
int startTimer (int interval, Qt::TimerType timerType)
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThread * thread () const const

Static Public Attributes

static char * defaultRealm
 default realm name

Friends

class Authentication
class AuthenticationPrivate

Additional Inherited Members

Public Types inherited from Cutelyst::Component
enum  Modifier {
  None , OnlyExecute , BeforeExecute , AroundExecute ,
  AfterExecute
}
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 *context, Functor functor, 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)
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString tr (const char *sourceText, const char *disambiguation, int n)
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef QObjectList
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)
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 const
int receivers (const char *signal) const const
QObject * sender () const const
int senderSignalIndex () const const
virtual void timerEvent (QTimerEvent *event)
Properties inherited from QObject
 objectName

Detailed Description

Definition at line 17 of file authenticationrealm.h.

Constructor & Destructor Documentation

◆ AuthenticationRealm()

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

Definition at line 20 of file authenticationrealm.cpp.

References Cutelyst::Component::Component(), QObject::QObject(), credential(), Cutelyst::Component::name(), QObject::parent(), Cutelyst::Component::setName(), QObject::setObjectName(), and store().

◆ ~AuthenticationRealm()

AuthenticationRealm::~AuthenticationRealm ( )
overridevirtual

Definition at line 34 of file authenticationrealm.cpp.

Member Function Documentation

◆ authenticate()

AuthenticationUser AuthenticationRealm::authenticate ( Context * c,
const ParamsMultiMap & authinfo )
virtual

Definition at line 69 of file authenticationrealm.cpp.

Referenced by Cutelyst::Authentication::authenticate().

◆ credential()

AuthenticationCredential * AuthenticationRealm::credential ( ) const

Definition at line 43 of file authenticationrealm.cpp.

Referenced by AuthenticationRealm().

◆ findUser()

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

Definition at line 48 of file authenticationrealm.cpp.

References Cutelyst::AuthenticationUser::authRealm(), Cutelyst::AuthenticationUser::isNull(), Cutelyst::Component::name(), and Cutelyst::AuthenticationUser::setAuthRealm().

Referenced by Cutelyst::CredentialPassword::authenticate(), and Cutelyst::Authentication::findUser().

◆ persistUser()

AuthenticationUser AuthenticationRealm::persistUser ( Context * c,
const AuthenticationUser & user )

Definition at line 81 of file authenticationrealm.cpp.

References QObject::objectName, and Cutelyst::Session::setValue().

◆ removePersistedUser()

void AuthenticationRealm::removePersistedUser ( Context * c)

Definition at line 74 of file authenticationrealm.cpp.

References Cutelyst::Session::deleteValues().

◆ restoreUser()

AuthenticationUser AuthenticationRealm::restoreUser ( Context * c,
const QVariant & frozenUser )

Definition at line 89 of file authenticationrealm.cpp.

References Cutelyst::AuthenticationUser::isNull(), QVariant::isNull(), QObject::objectName, Cutelyst::AuthenticationUser::setAuthRealm(), and userIsRestorable().

◆ store()

AuthenticationStore * AuthenticationRealm::store ( ) const

Definition at line 38 of file authenticationrealm.cpp.

Referenced by AuthenticationRealm().

◆ userIsRestorable()

QVariant AuthenticationRealm::userIsRestorable ( Context * c)

Definition at line 114 of file authenticationrealm.cpp.

References Cutelyst::Session::value().

Referenced by restoreUser().

◆ Authentication

friend class Authentication
friend

Definition at line 76 of file authenticationrealm.h.

◆ AuthenticationPrivate

friend class AuthenticationPrivate
friend

Definition at line 77 of file authenticationrealm.h.

Member Data Documentation

◆ defaultRealm

char * AuthenticationRealm::defaultRealm
static

Definition at line 22 of file authenticationrealm.h.