1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
|
<!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::AbstractUserDatabase Class 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.1</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"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html">AbstractUserDatabase</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::Auth::AbstractUserDatabase Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::Auth::AbstractUserDatabase" -->
<p>Abstract interface for an authentication user database.
<a href="classWt_1_1Auth_1_1AbstractUserDatabase.html#details">More...</a></p>
<p><code>#include <Wt/Auth/AbstractUserDatabase></code></p>
<div class="dynheader">
Inheritance diagram for Wt::Auth::AbstractUserDatabase:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1Auth_1_1AbstractUserDatabase__inherit__graph.png" border="0" usemap="#Wt_1_1Auth_1_1AbstractUserDatabase_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1Auth_1_1AbstractUserDatabase_inherit__map" id="Wt_1_1Auth_1_1AbstractUserDatabase_inherit__map">
<area shape="rect" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html" title="A default implementation for a authentication data in Wt::Dbo." alt="" coords="5,80,275,107"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1Auth_1_1AbstractUserDatabase-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase_1_1Transaction.html">Transaction</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An abstract transaction. <a href="classWt_1_1Auth_1_1AbstractUserDatabase_1_1Transaction.html#details">More...</a><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="aca60e45ff98e40dbbb457dfceaf1561b"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::~AbstractUserDatabase" ref="aca60e45ff98e40dbbb457dfceaf1561b" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#aca60e45ff98e40dbbb457dfceaf1561b">~AbstractUserDatabase</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase_1_1Transaction.html">Transaction</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#afdc5c2f3dccb1a0208633949c067c3f2">startTransaction</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new database transaction. <a href="#afdc5c2f3dccb1a0208633949c067c3f2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#afe820eed084f426a89cc7276d5db3e0f">findWithId</a> (const std::string &id) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finds a user with a given id. <a href="#afe820eed084f426a89cc7276d5db3e0f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#ad86157a5d896af38825d9575fa8f8eae">findWithIdentity</a> (const std::string &provider, const <a class="el" href="classWt_1_1WString.html">WString</a> &identity) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finds a user with a given identity. <a href="#ad86157a5d896af38825d9575fa8f8eae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#ab97a74c1009a6c72e3f1b897246eb982">addIdentity</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user, const std::string &provider, const <a class="el" href="classWt_1_1WString.html">WString</a> &id)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets an identifier for the user. <a href="#ab97a74c1009a6c72e3f1b897246eb982"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1WString.html">WString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a299a308436b353c2f91162244333c173">identity</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user, const std::string &provider) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a user identity. <a href="#a299a308436b353c2f91162244333c173"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a14e8b7552a2fe578665970860c48fa27">registerNew</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Registers a new user. <a href="#a14e8b7552a2fe578665970860c48fa27"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <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_1AbstractUserDatabase.html#a64fba754661708d4c25219e46c5fe1b6">status</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the status for a user. <a href="#a64fba754661708d4c25219e46c5fe1b6"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Password authentication</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a489310f977a7c22c7b29ec89fba297cc">setPassword</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user, const <a class="el" href="classWt_1_1Auth_1_1PasswordHash.html">PasswordHash</a> &password)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a new user password. <a href="#a489310f977a7c22c7b29ec89fba297cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1Auth_1_1PasswordHash.html">PasswordHash</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#abdea1a684e09897d33e2d6ed4ce27ff8">password</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a user password. <a href="#abdea1a684e09897d33e2d6ed4ce27ff8"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Email addresses (for verification and lost passwords)</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a9f24e4a83a20e24dd8ac64558db51559">setEmail</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user, const std::string &address)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a user's email address. <a href="#a9f24e4a83a20e24dd8ac64558db51559"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a15fa807c21115be032626a4a4b661015">email</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a user's email address. <a href="#a15fa807c21115be032626a4a4b661015"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#aa3709b846d8949b6a411c8494496aa55">setUnverifiedEmail</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user, const std::string &address)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a user's unverified email address. <a href="#aa3709b846d8949b6a411c8494496aa55"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a041239ea5a0ef0a0907c045abf29f687">unverifiedEmail</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a user's unverified email address. <a href="#a041239ea5a0ef0a0907c045abf29f687"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a29e3c7e2e82500882453d193d4c89f78">findWithEmail</a> (const std::string &address) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finds a user with a given email address. <a href="#a29e3c7e2e82500882453d193d4c89f78"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a3f12058159d7e2ea45ebc2e72b568942">setEmailToken</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user, const <a class="el" href="classWt_1_1Auth_1_1Token.html">Token</a> &token, <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 a new email token for a user. <a href="#a3f12058159d7e2ea45ebc2e72b568942"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1Auth_1_1Token.html">Token</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#af97442ab53528b3609a9e102bf4ec149">emailToken</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an email token. <a href="#af97442ab53528b3609a9e102bf4ec149"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <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_1AbstractUserDatabase.html#ad92251a0fe300577a4227f3ffbe01349">emailTokenRole</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the role of the current email token. <a href="#ad92251a0fe300577a4227f3ffbe01349"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a5c1c2c63f45f6b9dc81e99020d0faaab">findWithEmailToken</a> (const std::string &hash) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finds a user with a given email token. <a href="#a5c1c2c63f45f6b9dc81e99020d0faaab"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Auth tokens (remember-me support)</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#aa9e6675aad111e35b2725ced17208211">addAuthToken</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user, const <a class="el" href="classWt_1_1Auth_1_1Token.html">Token</a> &token)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an authentication token to a user. <a href="#aa9e6675aad111e35b2725ced17208211"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#acfe2c37b3ecaf468cb9663a2cd83a980">removeAuthToken</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user, const std::string &hash)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deletes an authentication token. <a href="#acfe2c37b3ecaf468cb9663a2cd83a980"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#ac464256e227b6141d7ad5a7c2612d1fb">findWithAuthToken</a> (const std::string &hash) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finds a user with an authentication token. <a href="#ac464256e227b6141d7ad5a7c2612d1fb"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Authenticaton attempt throttling</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a4e146059644458af7fa650f17416471a">setFailedLoginAttempts</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user, int count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the number of consecutive authentication failures. <a href="#a4e146059644458af7fa650f17416471a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#ae659dd936613346de1edad3bc91f700c">failedLoginAttempts</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of consecutive authentication failures. <a href="#ae659dd936613346de1edad3bc91f700c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a4f8b8b76e3202b9b86e40649958617e2">setLastLoginAttempt</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user, const <a class="el" href="classWt_1_1WDateTime.html">WDateTime</a> &t)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the time of the last login attempt. <a href="#a4f8b8b76e3202b9b86e40649958617e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1WDateTime.html">WDateTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#ae49650f598ed0474c03f58b20cf05e07">lastLoginAttempt</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the time of the last login. <a href="#ae49650f598ed0474c03f58b20cf05e07"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract interface for an authentication user database. </p>
<p>This class defines the interface for managing user data related to authentication. You need to implement this interface to allow the authentication service classes (<a class="el" href="classWt_1_1Auth_1_1AuthService.html" title="Basic authentication service.">AuthService</a>, <a class="el" href="classWt_1_1Auth_1_1PasswordService.html" title="Password authentication service.">PasswordService</a>, and <a class="el" href="classWt_1_1Auth_1_1OAuthService.html" title="An OAuth authorization (and authentication) service provider.">OAuthService</a>) to locate and update user credentials. Except for functions which do work on a single user, it is more convenient to use the <a class="el" href="classWt_1_1Auth_1_1User.html" title="A user.">User</a> API. Obviously, you may have more data associated with a user, including roles for access control, other personal information, address information. This information cannot be accessed through the <a class="el" href="classWt_1_1Auth_1_1User.html" title="A user.">Auth::User</a> class, but you should make it available through your own <a class="el" href="classWt_1_1Auth_1_1User.html" title="A user.">User</a> class, which is then als the basis of this user database implementation.</p>
<p>The only assumption made by the authentication system is that an id uniquely defines the user. This is usually an internal identifier, for example an auto-incrementing primary key.</p>
<p>With a user, one or more other identities may be associated. These could be a login name (for password-based authentication), or id's used by third party providers (such as OAuth or LDAP).</p>
<p>The database implements a simple data store and does not contain any logic. The database can store data for different aspects of authentication, but most data fields are only relevant for optional functionality, and thus themeselves optional. The default implementation of these methods will log errors.</p>
<p>The authentication views and model classes assume a private instance of the database for each different session, and will try to wrap database access within a transaction. <a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase_1_1Transaction.html" title="An abstract transaction.">Transaction</a> support can thus be optionally provided by a database implementation.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1User.html" title="A user.">User</a> </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa9e6675aad111e35b2725ced17208211"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::addAuthToken" ref="aa9e6675aad111e35b2725ced17208211" args="(const User &user, const Token &token)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::AbstractUserDatabase::addAuthToken </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1Token.html">Token</a> & </td>
<td class="paramname"><em>token</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds an authentication token to a user. </p>
<p>Unless you want a user to only have remember-me support from a single computer at a time, you should support multiple authentication tokens per user. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a4ee55ce44a6d4a6cacf1f40681d7fbbe">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="ab97a74c1009a6c72e3f1b897246eb982"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::addIdentity" ref="ab97a74c1009a6c72e3f1b897246eb982" args="(const User &user, const std::string &provider, const WString &id)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Wt::Auth::AbstractUserDatabase::addIdentity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>provider</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets an identifier for the user. </p>
<p>This associates an identifier with the user.</p>
<p>You are free to support only one identity per user, e.g. if you only use password-based authentication. But you may also want to support more than one if you allow the user to login using multiple methods (e.g. name/password, OAuth from one or more providers, LDAP, ...). </p>
<p>Implemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a92990ca73bd79b9558394d96e5b53abf">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="a15fa807c21115be032626a4a4b661015"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::email" ref="a15fa807c21115be032626a4a4b661015" args="(const User &user) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::Auth::AbstractUserDatabase::email </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a user's email address. </p>
<p>This may be an unverified or verified email address, depending on whether email address verification is enabled in the model classes.</p>
<p>This is an optional method, and currently not used by any of the included models or views. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a5fba94f7ad74b08bde2d76e1782923e6">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="af97442ab53528b3609a9e102bf4ec149"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::emailToken" ref="af97442ab53528b3609a9e102bf4ec149" args="(const User &user) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Auth_1_1Token.html">Token</a> Wt::Auth::AbstractUserDatabase::emailToken </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns an email token. </p>
<p>This is only used when email verification is enabled and for lost password functionality. It should return the email token previously set with <a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a3f12058159d7e2ea45ebc2e72b568942" title="Sets a new email token for a user.">setEmailToken()</a> </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#af3d9d785708806480276f7586c89390a">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="ad92251a0fe300577a4227f3ffbe01349"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::emailTokenRole" ref="ad92251a0fe300577a4227f3ffbe01349" args="(const User &user) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Auth_1_1User.html#a9156dfab4821e49aa7e109f3f1a2674b">User::EmailTokenRole</a> Wt::Auth::AbstractUserDatabase::emailTokenRole </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the role of the current email token. </p>
<p>This is only used when email verification is enabled or for lost password functionality. It should return the role previously set with setEailToken(). </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a7a918433f0ac66db865c786a38a0822f">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="ae659dd936613346de1edad3bc91f700c"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::failedLoginAttempts" ref="ae659dd936613346de1edad3bc91f700c" args="(const User &user) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Wt::Auth::AbstractUserDatabase::failedLoginAttempts </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of consecutive authentication failures. </p>
<p><em><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a4e146059644458af7fa650f17416471a" title="Sets the number of consecutive authentication failures.">setFailedLoginAttempts()</a></em> </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a82c913d5040e6d1c3bf4dc0f42e052f2">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="ac464256e227b6141d7ad5a7c2612d1fb"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::findWithAuthToken" ref="ac464256e227b6141d7ad5a7c2612d1fb" args="(const std::string &hash) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Auth_1_1User.html">User</a> Wt::Auth::AbstractUserDatabase::findWithAuthToken </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>hash</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finds a user with an authentication token. </p>
<p>Returns a user with an authentication token.</p>
<p>This should find the user associated with a particular token hash, or return an invalid user if no user with that token hash exists. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a91ef2bdcd34ede0ab671dc578a3f735e">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="a29e3c7e2e82500882453d193d4c89f78"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::findWithEmail" ref="a29e3c7e2e82500882453d193d4c89f78" args="(const std::string &address) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Auth_1_1User.html">User</a> Wt::Auth::AbstractUserDatabase::findWithEmail </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>address</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finds a user with a given email address. </p>
<p>This is used to verify that a email addresses are unique, and to implement lost password functionality. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a12419c6b03ae0308f4061277f7835613">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="a5c1c2c63f45f6b9dc81e99020d0faaab"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::findWithEmailToken" ref="a5c1c2c63f45f6b9dc81e99020d0faaab" args="(const std::string &hash) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Auth_1_1User.html">User</a> Wt::Auth::AbstractUserDatabase::findWithEmailToken </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>hash</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finds a user with a given email token. </p>
<p>This is only used when email verification is enabled or for lost password functionality. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a58f314d03f6a7593e2ae084a86a5e542">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="afe820eed084f426a89cc7276d5db3e0f"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::findWithId" ref="afe820eed084f426a89cc7276d5db3e0f" args="(const std::string &id) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> Wt::Auth::AbstractUserDatabase::findWithId </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finds a user with a given id. </p>
<p>The id uniquely identifies a user.</p>
<p>This should find the user with the given <code>id</code>, or return an invalid user if no user with that id exists. </p>
<p>Implemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a1399d167a43b3c63f1f7ebe79abeba4e">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="ad86157a5d896af38825d9575fa8f8eae"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::findWithIdentity" ref="ad86157a5d896af38825d9575fa8f8eae" args="(const std::string &provider, const WString &identity) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> Wt::Auth::AbstractUserDatabase::findWithIdentity </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>provider</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>identity</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finds a user with a given identity. </p>
<p>The <code>identity</code> uniquely identifies the user by the <code>provider</code>.</p>
<p>This should find the user with the given <code>identity</code>, or return an invalid user if no user with that identity exists. </p>
<p>Implemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a424b0a6527e1316f9684e1956232c8ad">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="a299a308436b353c2f91162244333c173"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::identity" ref="a299a308436b353c2f91162244333c173" args="(const User &user, const std::string &provider) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classWt_1_1WString.html">WString</a> Wt::Auth::AbstractUserDatabase::identity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>provider</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a user identity. </p>
<p>Returns a user identity for the given provider, or an empty string if the user has no identitfy set for this provider.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#ab97a74c1009a6c72e3f1b897246eb982" title="Sets an identifier for the user.">addIdentity()</a> </dd></dl>
<p>Implemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a58b5b1ea88ed322f54dabd923bbb53dd">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="ae49650f598ed0474c03f58b20cf05e07"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::lastLoginAttempt" ref="ae49650f598ed0474c03f58b20cf05e07" args="(const User &user) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WDateTime.html">WDateTime</a> Wt::Auth::AbstractUserDatabase::lastLoginAttempt </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the time of the last login. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a4f8b8b76e3202b9b86e40649958617e2" title="Sets the time of the last login attempt.">setLastLoginAttempt()</a> </dd></dl>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#af66c0b5f4075e8f2ee3e5b9ca932f5b7">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="abdea1a684e09897d33e2d6ed4ce27ff8"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::password" ref="abdea1a684e09897d33e2d6ed4ce27ff8" args="(const User &user) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Auth_1_1PasswordHash.html">PasswordHash</a> Wt::Auth::AbstractUserDatabase::password </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a user password. </p>
<p>This returns the stored password for a user, or a default constructed password hash if the user does not yet have password credentials.</p>
<p>This is used only by <a class="el" href="classWt_1_1Auth_1_1PasswordService.html" title="Password authentication service.">PasswordService</a>. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a577c4170630f85ab0b2424bd0d0271ef">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="a14e8b7552a2fe578665970860c48fa27"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::registerNew" ref="a14e8b7552a2fe578665970860c48fa27" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Auth_1_1User.html">User</a> Wt::Auth::AbstractUserDatabase::registerNew </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Registers a new user. </p>
<p>This adds a new user.</p>
<p>This method is only used by view classes involved with registration (<a class="el" href="classWt_1_1Auth_1_1RegistrationWidget.html" title="A registration widget.">RegistrationWidget</a>). </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a74f53d62b49a0be5b46456a2373d3ba7">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="acfe2c37b3ecaf468cb9663a2cd83a980"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::removeAuthToken" ref="acfe2c37b3ecaf468cb9663a2cd83a980" args="(const User &user, const std::string &hash)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::AbstractUserDatabase::removeAuthToken </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>hash</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Deletes an authentication token. </p>
<p>Deletes an authentication token previously added with <a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#aa9e6675aad111e35b2725ced17208211" title="Adds an authentication token to a user.">addAuthToken()</a> </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a58700c257c1613772608c395668fb473">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="a9f24e4a83a20e24dd8ac64558db51559"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::setEmail" ref="a9f24e4a83a20e24dd8ac64558db51559" args="(const User &user, const std::string &address)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::Auth::AbstractUserDatabase::setEmail </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>address</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a user's email address. </p>
<p>This is used only when email verification is enabled, or as a result of a 3rd party <a class="el" href="classWt_1_1Auth_1_1Identity.html" title="A class that represents a user identity.">Identity</a> Provider based registration process, if the provider also provides email address information with the identiy.</p>
<p>Returns whether the user's email address could be set. This may fail when there is already a user registered that email address.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html#a29e3c7e2e82500882453d193d4c89f78" title="Finds a user with a given email address.">findWithEmail()</a> </dd></dl>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a07362974d7709189d7b9ae38cf726fb1">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="a3f12058159d7e2ea45ebc2e72b568942"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::setEmailToken" ref="a3f12058159d7e2ea45ebc2e72b568942" args="(const User &user, const Token &token, User::EmailTokenRole role)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::AbstractUserDatabase::setEmailToken </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1Token.html">Token</a> & </td>
<td class="paramname"><em>token</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classWt_1_1Auth_1_1User.html#a9156dfab4821e49aa7e109f3f1a2674b">User::EmailTokenRole</a> </td>
<td class="paramname"><em>role</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a new email token for a user. </p>
<p>This is only used when email verification is enabled or for lost password functionality. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a4dfd0cf66dce6b42f51063549c2402fd">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="a4e146059644458af7fa650f17416471a"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::setFailedLoginAttempts" ref="a4e146059644458af7fa650f17416471a" args="(const User &user, int count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::AbstractUserDatabase::setFailedLoginAttempts </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the number of consecutive authentication failures. </p>
<p>This sets the number of consecutive authentication failures since the last valid login.</p>
<p>This is used by the throttling logic to determine how much time a user needs to wait before he can do a new login attempt. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a8b4c7df8f1bb4a751140f4e58c47de2c">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="a4f8b8b76e3202b9b86e40649958617e2"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::setLastLoginAttempt" ref="a4f8b8b76e3202b9b86e40649958617e2" args="(const User &user, const WDateTime &t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::AbstractUserDatabase::setLastLoginAttempt </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WDateTime.html">WDateTime</a> & </td>
<td class="paramname"><em>t</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the time of the last login attempt. </p>
<p>This sets the time at which the user attempted to login. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a0eac750824c712427221df323f122b3c">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="a489310f977a7c22c7b29ec89fba297cc"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::setPassword" ref="a489310f977a7c22c7b29ec89fba297cc" args="(const User &user, const PasswordHash &password)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::AbstractUserDatabase::setPassword </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1PasswordHash.html">PasswordHash</a> & </td>
<td class="paramname"><em>password</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a new user password. </p>
<p>This updates the password for a user.</p>
<p>This is used only by <a class="el" href="classWt_1_1Auth_1_1PasswordService.html" title="Password authentication service.">PasswordService</a>. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a285ce48322c12e4e51e7fadbc3755574">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="aa3709b846d8949b6a411c8494496aa55"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::setUnverifiedEmail" ref="aa3709b846d8949b6a411c8494496aa55" args="(const User &user, const std::string &address)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::AbstractUserDatabase::setUnverifiedEmail </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>address</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a user's unverified email address. </p>
<p>This is only used when email verification is enabled. It holds the currently unverified email address, while a mail is being sent for the user to confirm this email address. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a4dd5ba163f90e1e91ae3d4a5b372812c">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="afdc5c2f3dccb1a0208633949c067c3f2"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::startTransaction" ref="afdc5c2f3dccb1a0208633949c067c3f2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase_1_1Transaction.html">AbstractUserDatabase::Transaction</a> * Wt::Auth::AbstractUserDatabase::startTransaction </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new database transaction. </p>
<p>If the underlying database does not support transactions, you can return <code>0</code>.</p>
<p>Ownership of the transaction is transferred, and the transaction must be deleted after it has been committed or rolled back.</p>
<p>The default implementation returns <code>0</code> (no transaction support). </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a45bb818735ce31769dad03ead2630ce4">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="a64fba754661708d4c25219e46c5fe1b6"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::status" ref="a64fba754661708d4c25219e46c5fe1b6" args="(const User &user) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Auth_1_1User.html#ac8a61657a320eef6ae6e2c394bdd4437">User::Status</a> Wt::Auth::AbstractUserDatabase::status </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the status for a user. </p>
<p>If there is support for suspending accounts, then this method may be implemented to return whether a user account is disabled.</p>
<p>The default implementation always returns <a class="el" href="classWt_1_1Auth_1_1User.html#ac8a61657a320eef6ae6e2c394bdd4437a4bdc87727a5f54db977b9e192f05e689" title="Normal status.">User::Normal</a>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>Login::loginState() </dd></dl>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#a9a0ca45665d71eaa6cfceba977099b2d">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</div>
</div>
<a class="anchor" id="a041239ea5a0ef0a0907c045abf29f687"></a><!-- doxytag: member="Wt::Auth::AbstractUserDatabase::unverifiedEmail" ref="a041239ea5a0ef0a0907c045abf29f687" args="(const User &user) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Wt::Auth::AbstractUserDatabase::unverifiedEmail </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a user's unverified email address. </p>
<p>This is an optional method, and currently not used by any of the included models or views. </p>
<p>Reimplemented in <a class="el" href="classWt_1_1Auth_1_1Dbo_1_1UserDatabase.html#ab9c9fed997b9ff17b00c5101eef95153">Wt::Auth::Dbo::UserDatabase< DboType ></a>.</p>
</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 Fri Mar 30 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>
|
