Wt
3.3.0
|
A user. More...
#include <Wt/Auth/User>
Public Types | |
enum | Status { Disabled, Normal } |
Enumeration for a user's account status. More... | |
enum | EmailTokenRole { VerifyEmail, LostPassword } |
Enumeration for an email token stored for the user. More... | |
Public Member Functions | |
User () | |
Default constructor. | |
User (const std::string &id, const AbstractUserDatabase &database) | |
Constructor. | |
AbstractUserDatabase * | database () const |
Returns the user database. | |
bool | operator== (const User &other) const |
Comparison operator. | |
bool | operator!= (const User &other) const |
Comparison operator. | |
bool | isValid () const |
Returns whether the user is valid. | |
const std::string & | id () const |
Returns the user id. | |
WString | identity (const std::string &provider) const |
Returns the user's identity. | |
void | addIdentity (const std::string &provider, const WString &identity) |
Adds (or modifies) a user's identity. | |
void | setPassword (const PasswordHash &password) const |
Sets a password. | |
PasswordHash | password () const |
Returns the password. | |
void | setEmail (const std::string &address) const |
Sets the email address. | |
std::string | email () const |
Returns the email address. | |
void | setUnverifiedEmail (const std::string &address) const |
Sets the unverified email address. | |
std::string | unverifiedEmail () const |
Returns the unverified email address. | |
Status | status () const |
Returns the account status. | |
Token | emailToken () const |
Returns the email token. | |
EmailTokenRole | emailTokenRole () const |
Returns the email token role. | |
void | setEmailToken (const Token &token, EmailTokenRole role) const |
Sets an email token. | |
void | clearEmailToken () const |
Clears the email token. | |
void | addAuthToken (const Token &token) const |
Adds an authentication token. | |
void | removeAuthToken (const std::string &hash) const |
Removes an authentication token. | |
void | setAuthenticated (bool success) const |
Logs the result of an authentication attempt. | |
int | failedLoginAttempts () const |
Returns the number of consecutive unsuccessful login attempts. | |
WDateTime | lastLoginAttempt () const |
Returns the last login attempt. |
A user.
This class represents a user. It is a value class that stores only the user id and a reference to an AbstractUserDatabase to access its properties.
An object can point to a valid user, or be invalid. Invalid users are typically used as return value for database queries which did not match with an existing user.
Not all methods are valid or applicable to your authentication system. See AbstractUserDatabase for a discussion.
Enumeration for a user's account status.
Wt::Auth::User::User | ( | ) |
Wt::Auth::User::User | ( | const std::string & | id, |
const AbstractUserDatabase & | database | ||
) |
Constructor.
Creates a user with id id
, and whose information is stored in the database
.
void Wt::Auth::User::addAuthToken | ( | const Token & | token | ) | const |
Adds an authentication token.
void Wt::Auth::User::clearEmailToken | ( | ) | const |
Clears the email token.
AbstractUserDatabase* Wt::Auth::User::database | ( | ) | const |
Returns the user database.
This returns the user database passed in the constructor, or 0 if the user is invalid, and was constructed using the default constructor.
std::string Wt::Auth::User::email | ( | ) | const |
Returns the email address.
Token Wt::Auth::User::emailToken | ( | ) | const |
Returns the email token.
User::EmailTokenRole Wt::Auth::User::emailTokenRole | ( | ) | const |
Returns the email token role.
int Wt::Auth::User::failedLoginAttempts | ( | ) | const |
Returns the number of consecutive unsuccessful login attempts.
const std::string& Wt::Auth::User::id | ( | ) | const |
Returns the user id.
This returns the id that uniquely identifies the user, and acts as a "primary key" to obtain other information for the user in the database.
bool Wt::Auth::User::isValid | ( | ) | const |
Returns whether the user is valid.
A invalid user is a sentinel value returned by methods that query the database but could not identify a matching user.
WDateTime Wt::Auth::User::lastLoginAttempt | ( | ) | const |
Returns the last login attempt.
bool Wt::Auth::User::operator!= | ( | const User & | other | ) | const |
Comparison operator.
bool Wt::Auth::User::operator== | ( | const User & | other | ) | const |
Comparison operator.
Two users are equal if they have the same identity and the same database.
PasswordHash Wt::Auth::User::password | ( | ) | const |
Returns the password.
void Wt::Auth::User::removeAuthToken | ( | const std::string & | hash | ) | const |
Removes an authentication token.
void Wt::Auth::User::setAuthenticated | ( | bool | success | ) | const |
Logs the result of an authentication attempt.
This changes the number of failed login attempts, and stores the current date as the last login attempt time.
void Wt::Auth::User::setEmail | ( | const std::string & | address | ) | const |
Sets the email address.
void Wt::Auth::User::setEmailToken | ( | const Token & | token, |
EmailTokenRole | role | ||
) | const |
Sets an email token.
void Wt::Auth::User::setPassword | ( | const PasswordHash & | password | ) | const |
Sets a password.
void Wt::Auth::User::setUnverifiedEmail | ( | const std::string & | address | ) | const |
Sets the unverified email address.
User::Status Wt::Auth::User::status | ( | ) | const |
Returns the account status.
std::string Wt::Auth::User::unverifiedEmail | ( | ) | const |
Returns the unverified email address.