<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Wt: Wt::Auth::Dbo::AuthInfo< UserType > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="namespaceWt_1_1Auth.html">Auth</a> </li>
<li class="navelem"><b>Dbo</b> </li>
<li class="navelem"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">AuthInfo</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::Auth::Dbo::AuthInfo< UserType > Class Template Reference<div class="ingroups"><a class="el" href="group__auth.html">Authentication module (Wt::Auth)</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::Auth::Dbo::AuthInfo" --><!-- doxytag: inherits="Dbo< AuthInfo< UserType > >" -->
<p>A default implementation for authentication data in Wt::Dbo.
<a href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#details">More...</a></p>
<p><code>#include <Wt/Auth/Dbo/AuthInfo></code></p>
<div class="dynheader">
Inheritance diagram for Wt::Auth::Dbo::AuthInfo< UserType >:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1Auth_1_1Dbo_1_1AuthInfo__inherit__graph.png" border="0" usemap="#Wt_1_1Auth_1_1Dbo_1_1AuthInfo_3_01UserType_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1Auth_1_1Dbo_1_1AuthInfo_3_01UserType_01_4_inherit__map" id="Wt_1_1Auth_1_1Dbo_1_1AuthInfo_3_01UserType_01_4_inherit__map">
<area shape="rect" href="classWt_1_1Dbo_1_1Dbo.html" title="Wt::Dbo::Dbo\< AuthInfo\< UserType \> \>" alt="" coords="5,5,256,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58fefb577610dae54b4597ee014e92c1"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::AuthTokenType" ref="a58fefb577610dae54b4597ee014e92c1" args="" -->
typedef <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthToken.html">AuthToken</a>< <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">AuthInfo</a><br class="typebreak"/>
< UserType > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a58fefb577610dae54b4597ee014e92c1">AuthTokenType</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Type for an auth token. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02807c5c070546362d1fa7a53ab04dfe"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::AuthTokens" ref="a02807c5c070546362d1fa7a53ab04dfe" args="" -->
typedef <a class="el" href="classWt_1_1Dbo_1_1collection.html">Wt::Dbo::collection</a><br class="typebreak"/>
< <a class="el" href="classWt_1_1Dbo_1_1ptr.html">Wt::Dbo::ptr</a>< <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a58fefb577610dae54b4597ee014e92c1">AuthTokenType</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a02807c5c070546362d1fa7a53ab04dfe">AuthTokens</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Type for a collection of auth tokens. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a100cd93e291e2ff801070aebd9d2941d"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::AuthIdentityType" ref="a100cd93e291e2ff801070aebd9d2941d" args="" -->
typedef <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthIdentity.html">AuthIdentity</a>< <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">AuthInfo</a><br class="typebreak"/>
< UserType > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a100cd93e291e2ff801070aebd9d2941d">AuthIdentityType</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Type for an identity. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a564653a9fce934f9e1f928a496a5097a"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::AuthIdentities" ref="a564653a9fce934f9e1f928a496a5097a" args="" -->
typedef <a class="el" href="classWt_1_1Dbo_1_1collection.html">Wt::Dbo::collection</a><br class="typebreak"/>
< <a class="el" href="classWt_1_1Dbo_1_1ptr.html">Wt::Dbo::ptr</a><br class="typebreak"/>
< <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a100cd93e291e2ff801070aebd9d2941d">AuthIdentityType</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a564653a9fce934f9e1f928a496a5097a">AuthIdentities</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Type for a collection of identites. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab33a7895532323d3f28d207059b5097b"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::AuthInfo" ref="ab33a7895532323d3f28d207059b5097b" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#ab33a7895532323d3f28d207059b5097b">AuthInfo</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a59f5bec40360c29e58cc9768a34c3b17">setUser</a> (<a class="el" href="classWt_1_1Dbo_1_1ptr.html">Wt::Dbo::ptr</a>< UserType > user)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the user. <a href="#a59f5bec40360c29e58cc9768a34c3b17"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Dbo_1_1ptr.html">Wt::Dbo::ptr</a>< UserType > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a5b04c89018a84a74d5b6a70bcc6a8cca">user</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to the user. <a href="#a5b04c89018a84a74d5b6a70bcc6a8cca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2191e53206f15013363feb05a3be73a6"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::setPassword" ref="a2191e53206f15013363feb05a3be73a6" args="(const std::string &hash, const std::string &hashFunction, const std::string &hashSalt)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a2191e53206f15013363feb05a3be73a6">setPassword</a> (const std::string &hash, const std::string &hashFunction, const std::string &hashSalt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a password. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a16dae17db68c95a7a57b68634e72348a">passwordHash</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the password hash. <a href="#a16dae17db68c95a7a57b68634e72348a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a59f66173f4045e35b07b0bff28d24184">passwordMethod</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the password method. <a href="#a59f66173f4045e35b07b0bff28d24184"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a2c2c2cccb2a8ddbf740a1b724fdec6a5">passwordSalt</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the password salt. <a href="#a2c2c2cccb2a8ddbf740a1b724fdec6a5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a440b112adee40904355ed86891ca1d54"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::setEmail" ref="a440b112adee40904355ed86891ca1d54" args="(const std::string &email)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a440b112adee40904355ed86891ca1d54">setEmail</a> (const std::string &email)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the email address. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#ac0b7f87aece2a4b2e8f2aab91ec7cfd9">email</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the email address. <a href="#ac0b7f87aece2a4b2e8f2aab91ec7cfd9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7d7ce46c45fcc62fb1a08dfe0b6b580"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::setUnverifiedEmail" ref="ac7d7ce46c45fcc62fb1a08dfe0b6b580" args="(const std::string &email)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#ac7d7ce46c45fcc62fb1a08dfe0b6b580">setUnverifiedEmail</a> (const std::string &email)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the unverified email address. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#ad3c9531a4fa3e3a34cef371f51fba8b5">unverifiedEmail</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the unverified email address. <a href="#ad3c9531a4fa3e3a34cef371f51fba8b5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad3af62b385629fea391ebdc3aa55190"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::setEmailToken" ref="aad3af62b385629fea391ebdc3aa55190" args="(const std::string &hash, const WDateTime &expires, User::EmailTokenRole role)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#aad3af62b385629fea391ebdc3aa55190">setEmailToken</a> (const std::string &hash, const <a class="el" href="classWt_1_1WDateTime.html">WDateTime</a> &expires, <a class="el" href="classWt_1_1Auth_1_1User.html#a9156dfab4821e49aa7e109f3f1a2674b">User::EmailTokenRole</a> role)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the email token. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a0c8d3a4ed86fdcf790026b0da816a477">emailToken</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the email token. <a href="#a0c8d3a4ed86fdcf790026b0da816a477"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1WDateTime.html">Wt::WDateTime</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a8372cc6fb40b765e9c56d6e9692fca1b">emailTokenExpires</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the email token expiration date. <a href="#a8372cc6fb40b765e9c56d6e9692fca1b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Auth_1_1User.html#a9156dfab4821e49aa7e109f3f1a2674b">User::EmailTokenRole</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a45f5242d8b75fc4441cbc2af88c436c2">emailTokenRole</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the email token role. <a href="#a45f5242d8b75fc4441cbc2af88c436c2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c02f3cf8aad52505c42872c82de7647"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::setStatus" ref="a5c02f3cf8aad52505c42872c82de7647" args="(User::Status status)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a5c02f3cf8aad52505c42872c82de7647">setStatus</a> (<a class="el" href="classWt_1_1Auth_1_1User.html#ac8a61657a320eef6ae6e2c394bdd4437">User::Status</a> status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the status. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Auth_1_1User.html#ac8a61657a320eef6ae6e2c394bdd4437">User::Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a748c289a52d3346593668137a93184b0">status</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the status. <a href="#a748c289a52d3346593668137a93184b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab00f7e9259cf4e77e77a8e41bbf0384a"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::setFailedLoginAttempts" ref="ab00f7e9259cf4e77e77a8e41bbf0384a" args="(int count)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#ab00f7e9259cf4e77e77a8e41bbf0384a">setFailedLoginAttempts</a> (int count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the number of failed login attempts. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#afbbf25496cf67943a291f970a37c45b7">failedLoginAttempts</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of failed login attempts. <a href="#afbbf25496cf67943a291f970a37c45b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89558444eebc260b392e25d892486335"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::setLastLoginAttempt" ref="a89558444eebc260b392e25d892486335" args="(const Wt::WDateTime &dt)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a89558444eebc260b392e25d892486335">setLastLoginAttempt</a> (const <a class="el" href="classWt_1_1WDateTime.html">Wt::WDateTime</a> &dt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the time of the last login attempt. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1WDateTime.html">Wt::WDateTime</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#ae4235a44c46de9abd899d294865d3a47">lastLoginAttempt</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the time of the last login attempt. <a href="#ae4235a44c46de9abd899d294865d3a47"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f5598d7eb644d175e432862c88b5242"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::authTokens" ref="a7f5598d7eb644d175e432862c88b5242" args="() const " -->
const <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a02807c5c070546362d1fa7a53ab04dfe">AuthTokens</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a7f5598d7eb644d175e432862c88b5242">authTokens</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the authentication tokens (read-only). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a93677e9f19ec6c0924065502b1ba4ab3"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::authTokens" ref="a93677e9f19ec6c0924065502b1ba4ab3" args="()" -->
<a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a02807c5c070546362d1fa7a53ab04dfe">AuthTokens</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a93677e9f19ec6c0924065502b1ba4ab3">authTokens</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the authentication tokens. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a12d1b9e87b5ee544154a4b752bd63f"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::authIdentities" ref="a7a12d1b9e87b5ee544154a4b752bd63f" args="() const " -->
const <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a564653a9fce934f9e1f928a496a5097a">AuthIdentities</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a7a12d1b9e87b5ee544154a4b752bd63f">authIdentities</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the authentication identities (read-only). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab30ca7f71bd9b9f1fbe7e67f17364db8"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::authIdentities" ref="ab30ca7f71bd9b9f1fbe7e67f17364db8" args="()" -->
<a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a564653a9fce934f9e1f928a496a5097a">AuthIdentities</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#ab30ca7f71bd9b9f1fbe7e67f17364db8">authIdentities</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the authentication identities. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#aed8f030fcc5a616efc70405713a2b2a4">identity</a> (const std::string &provider) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finds an identity of a particular provider. <a href="#aed8f030fcc5a616efc70405713a2b2a4"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2"><a class="anchor" id="aeb91756f1a86e0737920f8a226fad543"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::persist" ref="aeb91756f1a86e0737920f8a226fad543" args="(Action &a)" -->
template<class Action > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#aeb91756f1a86e0737920f8a226fad543">persist</a> (Action &a)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wt::Dbo persist implementation. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class UserType><br/>
class Wt::Auth::Dbo::AuthInfo< UserType ></h3>
<p>A default implementation for authentication data in Wt::Dbo. </p>
<p>This class implements the requirements for use as a data type in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html" title="A default implementation for a authentication data in Wt::Dbo.">Wt::Auth::Dbo::UserDatabase</a>.</p>
<p>It is a template class, and needs as parameter the <a class="el" href="namespaceWt_1_1Dbo.html" title="Namespace for the Database Objects (Wt::Dbo).">Dbo</a> type which models a user (e.g. name, birth date, ...). Thus, this class only carries the authentication information for that user.</p>
<p>It contains collections to two other types:</p>
<ul>
<li><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a93677e9f19ec6c0924065502b1ba4ab3" title="Returns the authentication tokens.">authTokens()</a> references a collection of authentication tokens, see <a class="el" href="classWt_1_1Auth_1_1AuthService.html#a863f6b1c7c5586ca6075983d8c5070a5" title="Configures authentication token support.">AuthService::setAuthTokensEnabled()</a></li>
<li><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#ab30ca7f71bd9b9f1fbe7e67f17364db8" title="Returns the authentication identities.">authIdentities()</a> references a collection of identities, which represent all the authentication identities this user has (e.g. a login name, but also an OAuth identity, etc...)</li>
</ul>
<p>To use these classes, you need to map three classes to tables of your choice.</p>
<div class="fragment"><pre class="fragment"> <span class="keyword">class </span>User; <span class="comment">// your user Dbo type</span>
<span class="keyword">typedef</span> <a class="code" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html" title="A default implementation for authentication data in Wt::Dbo.">Wt::Auth::Dbo::AuthInfo<User></a> <a class="code" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#ab33a7895532323d3f28d207059b5097b" title="Constructor.">AuthInfo</a>;
<a class="code" href="classWt_1_1Dbo_1_1Dbo.html#aa8ad4b9425c131f82dc257ed7ec9643e" title="Returns the session.">session</a>->mapClass<User>(<span class="stringliteral">"user"</span>);
<a class="code" href="classWt_1_1Dbo_1_1Dbo.html#aa8ad4b9425c131f82dc257ed7ec9643e" title="Returns the session.">session</a>->mapClass<AuthInfo>(<span class="stringliteral">"auth_info"</span>);
<a class="code" href="classWt_1_1Dbo_1_1Dbo.html#aa8ad4b9425c131f82dc257ed7ec9643e" title="Returns the session.">session</a>->mapClass<<a class="code" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a100cd93e291e2ff801070aebd9d2941d" title="Type for an identity.">AuthInfo::AuthIdentityType</a>>(<span class="stringliteral">"auth_identity"</span>);
<a class="code" href="classWt_1_1Dbo_1_1Dbo.html#aa8ad4b9425c131f82dc257ed7ec9643e" title="Returns the session.">session</a>->mapClass<<a class="code" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a58fefb577610dae54b4597ee014e92c1" title="Type for an auth token.">AuthInfo::AuthTokenType</a>>(<span class="stringliteral">"auth_token"</span>);
</pre></div><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html" title="A default implementation for a authentication data in Wt::Dbo.">UserDatabase</a> </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac0b7f87aece2a4b2e8f2aab91ec7cfd9"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::email" ref="ac0b7f87aece2a4b2e8f2aab91ec7cfd9" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class UserType > </div>
<table class="memname">
<tr>
<td class="memname">const std::string& <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">Wt::Auth::Dbo::AuthInfo</a>< UserType >::email </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the email address. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a440b112adee40904355ed86891ca1d54" title="Sets the email address.">setEmail()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0c8d3a4ed86fdcf790026b0da816a477"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::emailToken" ref="a0c8d3a4ed86fdcf790026b0da816a477" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class UserType > </div>
<table class="memname">
<tr>
<td class="memname">const std::string& <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">Wt::Auth::Dbo::AuthInfo</a>< UserType >::emailToken </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the email token. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#aad3af62b385629fea391ebdc3aa55190" title="Sets the email token.">setEmailToken()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a8372cc6fb40b765e9c56d6e9692fca1b"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::emailTokenExpires" ref="a8372cc6fb40b765e9c56d6e9692fca1b" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class UserType > </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1WDateTime.html">Wt::WDateTime</a>& <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">Wt::Auth::Dbo::AuthInfo</a>< UserType >::emailTokenExpires </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the email token expiration date. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#aad3af62b385629fea391ebdc3aa55190" title="Sets the email token.">setEmailToken()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a45f5242d8b75fc4441cbc2af88c436c2"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::emailTokenRole" ref="a45f5242d8b75fc4441cbc2af88c436c2" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class UserType > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Auth_1_1User.html#a9156dfab4821e49aa7e109f3f1a2674b">User::EmailTokenRole</a> <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">Wt::Auth::Dbo::AuthInfo</a>< UserType >::emailTokenRole </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the email token role. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#aad3af62b385629fea391ebdc3aa55190" title="Sets the email token.">setEmailToken()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="afbbf25496cf67943a291f970a37c45b7"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::failedLoginAttempts" ref="afbbf25496cf67943a291f970a37c45b7" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class UserType > </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">Wt::Auth::Dbo::AuthInfo</a>< UserType >::failedLoginAttempts </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of failed login attempts. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#afbbf25496cf67943a291f970a37c45b7" title="Returns the number of failed login attempts.">failedLoginAttempts()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aed8f030fcc5a616efc70405713a2b2a4"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::identity" ref="aed8f030fcc5a616efc70405713a2b2a4" args="(const std::string &provider) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class UserType > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">Wt::Auth::Dbo::AuthInfo</a>< UserType >::identity </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>provider</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finds an identity of a particular provider. </p>
<p>Note, a user could in theory have multiple identities from a single provider. If there are multiple, only one of them is returned. </p>
</div>
</div>
<a class="anchor" id="ae4235a44c46de9abd899d294865d3a47"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::lastLoginAttempt" ref="ae4235a44c46de9abd899d294865d3a47" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class UserType > </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1WDateTime.html">Wt::WDateTime</a>& <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">Wt::Auth::Dbo::AuthInfo</a>< UserType >::lastLoginAttempt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the time of the last login attempt. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a89558444eebc260b392e25d892486335" title="Sets the time of the last login attempt.">setLastLoginAttempt()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a16dae17db68c95a7a57b68634e72348a"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::passwordHash" ref="a16dae17db68c95a7a57b68634e72348a" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class UserType > </div>
<table class="memname">
<tr>
<td class="memname">const std::string& <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">Wt::Auth::Dbo::AuthInfo</a>< UserType >::passwordHash </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the password hash. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a2191e53206f15013363feb05a3be73a6" title="Sets a password.">setPassword()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a59f66173f4045e35b07b0bff28d24184"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::passwordMethod" ref="a59f66173f4045e35b07b0bff28d24184" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class UserType > </div>
<table class="memname">
<tr>
<td class="memname">const std::string& <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">Wt::Auth::Dbo::AuthInfo</a>< UserType >::passwordMethod </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the password method. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a2191e53206f15013363feb05a3be73a6" title="Sets a password.">setPassword()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a2c2c2cccb2a8ddbf740a1b724fdec6a5"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::passwordSalt" ref="a2c2c2cccb2a8ddbf740a1b724fdec6a5" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class UserType > </div>
<table class="memname">
<tr>
<td class="memname">const std::string& <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">Wt::Auth::Dbo::AuthInfo</a>< UserType >::passwordSalt </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the password salt. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a2191e53206f15013363feb05a3be73a6" title="Sets a password.">setPassword()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a59f5bec40360c29e58cc9768a34c3b17"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::setUser" ref="a59f5bec40360c29e58cc9768a34c3b17" args="(Wt::Dbo::ptr< UserType > user)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class UserType > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">Wt::Auth::Dbo::AuthInfo</a>< UserType >::setUser </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1Dbo_1_1ptr.html">Wt::Dbo::ptr</a>< UserType > </td>
<td class="paramname"><em>user</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the user. </p>
<p>This sets the user that owns this authentication information. </p>
</div>
</div>
<a class="anchor" id="a748c289a52d3346593668137a93184b0"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::status" ref="a748c289a52d3346593668137a93184b0" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class UserType > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Auth_1_1User.html#ac8a61657a320eef6ae6e2c394bdd4437">User::Status</a> <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">Wt::Auth::Dbo::AuthInfo</a>< UserType >::status </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the status. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a5c02f3cf8aad52505c42872c82de7647" title="Sets the status.">setStatus()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ad3c9531a4fa3e3a34cef371f51fba8b5"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::unverifiedEmail" ref="ad3c9531a4fa3e3a34cef371f51fba8b5" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class UserType > </div>
<table class="memname">
<tr>
<td class="memname">const std::string& <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">Wt::Auth::Dbo::AuthInfo</a>< UserType >::unverifiedEmail </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the unverified email address. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#ac7d7ce46c45fcc62fb1a08dfe0b6b580" title="Sets the unverified email address.">setUnverifiedEmail()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a5b04c89018a84a74d5b6a70bcc6a8cca"></a><!-- doxytag: member="Wt::Auth::Dbo::AuthInfo::user" ref="a5b04c89018a84a74d5b6a70bcc6a8cca" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class UserType > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Dbo_1_1ptr.html">Wt::Dbo::ptr</a><UserType> <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html">Wt::Auth::Dbo::AuthInfo</a>< UserType >::user </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a reference to the user. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1Dbo_1_1AuthInfo.html#a59f5bec40360c29e58cc9768a34c3b17" title="Sets the user.">setUser()</a> </dd></dl>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
