Cutelyst  1.7.0
authenticationuser.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 AUTHENTICATIONUSER_H
21 #define AUTHENTICATIONUSER_H
22 
23 #include <QDataStream>
24 #include <QVariantMap>
25 
26 #include <Cutelyst/cutelyst_global.h>
27 #include <Cutelyst/paramsmultimap.h>
28 #include <Cutelyst/plugin.h>
29 
30 namespace Cutelyst {
31 
32 class AuthenticationRealm;
33 class CUTELYST_PLUGIN_AUTHENTICATION_EXPORT AuthenticationUser : public QVariantMap
34 {
35 public:
40 
44  AuthenticationUser(const QString &id);
45  virtual ~AuthenticationUser();
46 
50  QString id() const;
51 
55  void setId(const QString &id);
56 
60  bool isNull() const;
61 
65  AuthenticationRealm *authRealm();
66 
70  void setAuthRealm(AuthenticationRealm *authRealm);
71 
76  virtual bool checkPassword(const QString &password) const;
77 
78 private:
79  QString m_id;
80  AuthenticationRealm *m_realm;
81 };
82 
83 }
84 
85 Q_DECLARE_METATYPE(Cutelyst::AuthenticationUser)
86 QDataStream &operator<<(QDataStream &out, const Cutelyst::AuthenticationUser &myObj);
87 QDataStream &operator>>(QDataStream &in, Cutelyst::AuthenticationUser &myObj);
88 
89 #endif // AUTHENTICATIONUSER_H
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7