Wt  3.3.9
Public Types | Public Member Functions | List of all members
Wt::Auth::Dbo::AuthInfo< UserType > Class Template Reference

A default implementation for authentication data in Wt::Dbo. More...

#include <Wt/Auth/Dbo/AuthInfo>

Inheritance diagram for Wt::Auth::Dbo::AuthInfo< UserType >:
Inheritance graph
[legend]

Public Types

typedef AuthToken< AuthInfo< UserType > > AuthTokenType
 Type for an auth token.
 
typedef Wt::Dbo::collection< Wt::Dbo::ptr< AuthTokenType > > AuthTokens
 Type for a collection of auth tokens.
 
typedef AuthIdentity< AuthInfo< UserType > > AuthIdentityType
 Type for an identity.
 
typedef Wt::Dbo::collection< Wt::Dbo::ptr< AuthIdentityType > > AuthIdentities
 Type for a collection of identites.
 

Public Member Functions

 AuthInfo ()
 Constructor.
 
void setUser (Wt::Dbo::ptr< UserType > user)
 Sets the user. More...
 
Wt::Dbo::ptr< UserType > user () const
 Returns a reference to the user. More...
 
void setPassword (const std::string &hash, const std::string &hashFunction, const std::string &hashSalt)
 Sets a password.
 
const std::string & passwordHash () const
 Returns the password hash. More...
 
const std::string & passwordMethod () const
 Returns the password method. More...
 
const std::string & passwordSalt () const
 Returns the password salt. More...
 
void setEmail (const std::string &email)
 Sets the email address.
 
const std::string & email () const
 Returns the email address. More...
 
void setUnverifiedEmail (const std::string &email)
 Sets the unverified email address.
 
const std::string & unverifiedEmail () const
 Returns the unverified email address. More...
 
void setEmailToken (const std::string &hash, const WDateTime &expires, User::EmailTokenRole role)
 Sets the email token.
 
const std::string & emailToken () const
 Returns the email token. More...
 
const Wt::WDateTimeemailTokenExpires () const
 Returns the email token expiration date. More...
 
User::EmailTokenRole emailTokenRole () const
 Returns the email token role. More...
 
void setStatus (User::Status status)
 Sets the status.
 
User::Status status () const
 Returns the status. More...
 
void setFailedLoginAttempts (int count)
 Sets the number of failed login attempts.
 
int failedLoginAttempts () const
 Returns the number of failed login attempts. More...
 
void setLastLoginAttempt (const Wt::WDateTime &dt)
 Sets the time of the last login attempt.
 
const Wt::WDateTimelastLoginAttempt () const
 Returns the time of the last login attempt. More...
 
const AuthTokensauthTokens () const
 Returns the authentication tokens (read-only).
 
AuthTokensauthTokens ()
 Returns the authentication tokens.
 
const AuthIdentitiesauthIdentities () const
 Returns the authentication identities (read-only).
 
AuthIdentitiesauthIdentities ()
 Returns the authentication identities.
 
WString identity (const std::string &provider) const
 Finds an identity of a particular provider. More...
 
template<class Action >
void persist (Action &a)
 Wt::Dbo persist implementation.
 
- Public Member Functions inherited from Wt::Dbo::Dbo< AuthInfo< UserType > >
 Dbo ()
 Constructor.
 
 Dbo (const Dbo< AuthInfo< UserType > > &other)
 Copy constructor.
 
dbo_traits< AuthInfo< UserType > >::IdType id () const
 Returns the database id. More...
 
Sessionsession () const
 Returns the session. More...
 
void setDirty ()
 Marks the object as modified. More...
 
bool isDirty () const
 Returns whether this object is dirty. More...
 
ptr< AuthInfo< UserType > > self () const
 Returns a dbo::ptr to this object. More...
 

Detailed Description

template<class UserType>
class Wt::Auth::Dbo::AuthInfo< UserType >

A default implementation for authentication data in Wt::Dbo.

This class implements the requirements for use as a data type in Wt::Auth::Dbo::UserDatabase.

It is a template class, and needs as parameter the Dbo type which models a user (e.g. name, birth date, ...). Thus, this class only carries the authentication information for that user.

It contains collections to two other types:

To use these classes, you need to map three classes to tables of your choice.

class User; // your user Dbo type
session->mapClass<User>("user");
session->mapClass<AuthInfo>("auth_info");
See also
UserDatabase

Member Function Documentation

template<class UserType >
const std::string& Wt::Auth::Dbo::AuthInfo< UserType >::email ( ) const

Returns the email address.

See also
setEmail()
template<class UserType >
const std::string& Wt::Auth::Dbo::AuthInfo< UserType >::emailToken ( ) const

Returns the email token.

See also
setEmailToken()
template<class UserType >
const Wt::WDateTime& Wt::Auth::Dbo::AuthInfo< UserType >::emailTokenExpires ( ) const

Returns the email token expiration date.

See also
setEmailToken()
template<class UserType >
User::EmailTokenRole Wt::Auth::Dbo::AuthInfo< UserType >::emailTokenRole ( ) const

Returns the email token role.

See also
setEmailToken()
template<class UserType >
int Wt::Auth::Dbo::AuthInfo< UserType >::failedLoginAttempts ( ) const

Returns the number of failed login attempts.

See also
failedLoginAttempts()
template<class UserType >
WString Wt::Auth::Dbo::AuthInfo< UserType >::identity ( const std::string &  provider) const

Finds an identity of a particular provider.

Note, a user could in theory have multiple identities from a single provider. If there are multiple, only one of them is returned.

template<class UserType >
const Wt::WDateTime& Wt::Auth::Dbo::AuthInfo< UserType >::lastLoginAttempt ( ) const

Returns the time of the last login attempt.

See also
setLastLoginAttempt()
template<class UserType >
const std::string& Wt::Auth::Dbo::AuthInfo< UserType >::passwordHash ( ) const

Returns the password hash.

See also
setPassword()
template<class UserType >
const std::string& Wt::Auth::Dbo::AuthInfo< UserType >::passwordMethod ( ) const

Returns the password method.

See also
setPassword()
template<class UserType >
const std::string& Wt::Auth::Dbo::AuthInfo< UserType >::passwordSalt ( ) const

Returns the password salt.

See also
setPassword()
template<class UserType >
void Wt::Auth::Dbo::AuthInfo< UserType >::setUser ( Wt::Dbo::ptr< UserType >  user)

Sets the user.

This sets the user that owns this authentication information.

template<class UserType >
User::Status Wt::Auth::Dbo::AuthInfo< UserType >::status ( ) const

Returns the status.

See also
setStatus()
template<class UserType >
const std::string& Wt::Auth::Dbo::AuthInfo< UserType >::unverifiedEmail ( ) const

Returns the unverified email address.

See also
setUnverifiedEmail()
template<class UserType >
Wt::Dbo::ptr<UserType> Wt::Auth::Dbo::AuthInfo< UserType >::user ( ) const

Returns a reference to the user.

See also
setUser()

Generated on Tue Nov 21 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11