Cutelyst  1.7.0
authenticationrealm.h
1 /*
2  * Copyright (C) 2013-2015 Daniel Nicoletti <dantti12@gmail.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB. If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19 
20 #ifndef AUTHENTICATIONREALM_H
21 #define AUTHENTICATIONREALM_H
22 
23 #include <Cutelyst/cutelyst_global.h>
24 #include <Cutelyst/Plugins/Authentication/authenticationuser.h>
25 #include <Cutelyst/component.h>
26 
27 namespace Cutelyst {
28 
29 class Context;
30 class AuthenticationStore;
31 class AuthenticationCredential;
32 class CUTELYST_PLUGIN_AUTHENTICATION_EXPORT AuthenticationRealm : public Component
33 {
34  Q_OBJECT
35 public:
39  explicit AuthenticationRealm(AuthenticationStore *store, AuthenticationCredential *credential, QObject *parent = nullptr);
40  virtual ~AuthenticationRealm();
41 
45  AuthenticationStore *store() const;
46 
50  AuthenticationCredential *credential() const;
51 
55  virtual AuthenticationUser findUser(Context *c, const ParamsMultiMap &userinfo);
56 
60  virtual AuthenticationUser authenticate(Context *c, const ParamsMultiMap &authinfo);
61 
62 protected:
67  void removePersistedUser(Context *c);
68 
73  AuthenticationUser persistUser(Context *c, const AuthenticationUser &user);
74 
79  AuthenticationUser restoreUser(Context *c, const QVariant &frozenUser);
80 
85  QVariant userIsRestorable(Context *c);
86 
87 private:
88  friend class Authentication;
89  friend class AuthenticationPrivate;
90 
91  AuthenticationStore *m_store;
92  AuthenticationCredential *m_credential;
93 };
94 
95 }
96 
97 #endif // AUTHENTICATIONREALM_H
QMap< QString, QString > ParamsMultiMap
The Cutelyst Component base class.
Definition: component.h:40
The Cutelyst Context.
Definition: context.h:52
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7