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
|
<!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::FormBaseModel 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_1FormBaseModel.html">FormBaseModel</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> </div>
<div class="headertitle">
<div class="title">Wt::Auth::FormBaseModel Class 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::FormBaseModel" --><!-- doxytag: inherits="Wt::WFormModel" -->
<p>A base model class for authentication-related forms.
<a href="classWt_1_1Auth_1_1FormBaseModel.html#details">More...</a></p>
<p><code>#include <Wt/Auth/FormBaseModel></code></p>
<div class="dynheader">
Inheritance diagram for Wt::Auth::FormBaseModel:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1Auth_1_1FormBaseModel__inherit__graph.png" border="0" usemap="#Wt_1_1Auth_1_1FormBaseModel_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1Auth_1_1FormBaseModel_inherit__map" id="Wt_1_1Auth_1_1FormBaseModel_inherit__map">
<area shape="rect" href="classWt_1_1Auth_1_1AuthModel.html" title="Model for implementing an authentication view." alt="" coords="5,229,149,256"/><area shape="rect" href="classWt_1_1Auth_1_1RegistrationModel.html" title="Model for implementing a registration view." alt="" coords="173,229,357,256"/><area shape="rect" href="classWt_1_1WFormModel.html" title="A basic model class for forms." alt="" coords="109,80,232,107"/><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="123,5,219,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1Auth_1_1FormBaseModel-members.html">List of all members.</a></p>
<table class="memberdecls">
<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="a89068212998f4647c8d11010560c4685"></a><!-- doxytag: member="Wt::Auth::FormBaseModel::FormBaseModel" ref="a89068212998f4647c8d11010560c4685" args="(const AuthService &baseAuth, AbstractUserDatabase &users, WObject *parent=0)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1FormBaseModel.html#a89068212998f4647c8d11010560c4685">FormBaseModel</a> (const <a class="el" href="classWt_1_1Auth_1_1AuthService.html">AuthService</a> &baseAuth, <a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html">AbstractUserDatabase</a> &users, <a class="el" href="classWt_1_1WObject.html">WObject</a> *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1Auth_1_1AuthService.html">AuthService</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1FormBaseModel.html#a7107aebeeb2bcc86cbe23134d3c59580">baseAuth</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the authentication base service. <a href="#a7107aebeeb2bcc86cbe23134d3c59580"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28037bb9c5b0ef277b3832b4f823ae11"></a><!-- doxytag: member="Wt::Auth::FormBaseModel::users" ref="a28037bb9c5b0ef277b3832b4f823ae11" args="()" -->
<a class="el" href="classWt_1_1Auth_1_1AbstractUserDatabase.html">AbstractUserDatabase</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1FormBaseModel.html#a28037bb9c5b0ef277b3832b4f823ae11">users</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the user database. <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_1FormBaseModel.html#a970b5cff2c2fe0ce9eefbb32c7cf0aed">addPasswordAuth</a> (const <a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService.html">AbstractPasswordService</a> *auth)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a password authentication service. <a href="#a970b5cff2c2fe0ce9eefbb32c7cf0aed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService.html">AbstractPasswordService</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1FormBaseModel.html#a1ee6e0ea98e432538ee25e0f87991c67">passwordAuth</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the password authentication service. <a href="#a1ee6e0ea98e432538ee25e0f87991c67"></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_1FormBaseModel.html#ab69e01f34fc48375ec6fe9412b2b8ed0">addOAuth</a> (const <a class="el" href="classWt_1_1Auth_1_1OAuthService.html">OAuthService</a> *auth)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an OAuth authentication service provider. <a href="#ab69e01f34fc48375ec6fe9412b2b8ed0"></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_1FormBaseModel.html#a2e79d700403b9127af19ca15772b3bb0">addOAuth</a> (const std::vector< const <a class="el" href="classWt_1_1Auth_1_1OAuthService.html">OAuthService</a> * > &auth)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a list of OAuth authentication service providers. <a href="#a2e79d700403b9127af19ca15772b3bb0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::vector< const <a class="el" href="classWt_1_1Auth_1_1OAuthService.html">OAuthService</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1FormBaseModel.html#ab3dae22d97b18941a8f67e8fcd315ead">oAuth</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the list of OAuth authentication service providers. <a href="#ab3dae22d97b18941a8f67e8fcd315ead"></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_1FormBaseModel.html#a8bd5862221e0fa8f84ceba4b8a440a09">label</a> (<a class="el" href="classWt_1_1WFormModel.html#a33c90b8c637bc83bbc57717175a5aa52">Field</a> field) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a field label. <a href="#a8bd5862221e0fa8f84ceba4b8a440a09"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af534625d4e3c8b4e428efa3e013be003"></a><!-- doxytag: member="Wt::Auth::FormBaseModel::LoginNameField" ref="af534625d4e3c8b4e428efa3e013be003" args="" -->
static const <a class="el" href="classWt_1_1WFormModel.html#a33c90b8c637bc83bbc57717175a5aa52">Field</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1FormBaseModel.html#af534625d4e3c8b4e428efa3e013be003">LoginNameField</a> = "user-name"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classWt_1_1Auth_1_1Login.html" title="A class that manages the current login state.">Login</a> name field. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A base model class for authentication-related forms. </p>
<p>This class manages the the auth services and the user database which an authentication model will use to implement a form.. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab69e01f34fc48375ec6fe9412b2b8ed0"></a><!-- doxytag: member="Wt::Auth::FormBaseModel::addOAuth" ref="ab69e01f34fc48375ec6fe9412b2b8ed0" args="(const OAuthService *auth)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::FormBaseModel::addOAuth </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1OAuthService.html">OAuthService</a> * </td>
<td class="paramname"><em>auth</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds an OAuth authentication service provider. </p>
<p>This enables OAuth-based registration. More than one OAuth authentication service can be configured: one for each supported third-party OAuth identity provider.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1FormBaseModel.html#a970b5cff2c2fe0ce9eefbb32c7cf0aed" title="Adds a password authentication service.">addPasswordAuth()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a2e79d700403b9127af19ca15772b3bb0"></a><!-- doxytag: member="Wt::Auth::FormBaseModel::addOAuth" ref="a2e79d700403b9127af19ca15772b3bb0" args="(const std::vector< const OAuthService * > &auth)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::FormBaseModel::addOAuth </td>
<td>(</td>
<td class="paramtype">const std::vector< const <a class="el" href="classWt_1_1Auth_1_1OAuthService.html">OAuthService</a> * > & </td>
<td class="paramname"><em>auth</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a list of OAuth authentication service providers. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1FormBaseModel.html#ab69e01f34fc48375ec6fe9412b2b8ed0" title="Adds an OAuth authentication service provider.">addOAuth()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a970b5cff2c2fe0ce9eefbb32c7cf0aed"></a><!-- doxytag: member="Wt::Auth::FormBaseModel::addPasswordAuth" ref="a970b5cff2c2fe0ce9eefbb32c7cf0aed" args="(const AbstractPasswordService *auth)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::FormBaseModel::addPasswordAuth </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService.html">AbstractPasswordService</a> * </td>
<td class="paramname"><em>auth</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a password authentication service. </p>
<p>This enables password-based registration, including choosing a proper password.</p>
<p>Only one password authentication service can be configured.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1FormBaseModel.html#ab69e01f34fc48375ec6fe9412b2b8ed0" title="Adds an OAuth authentication service provider.">addOAuth()</a> </dd>
<dd>
AbstractPasswordService::validatePassword() </dd></dl>
</div>
</div>
<a class="anchor" id="a7107aebeeb2bcc86cbe23134d3c59580"></a><!-- doxytag: member="Wt::Auth::FormBaseModel::baseAuth" ref="a7107aebeeb2bcc86cbe23134d3c59580" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1Auth_1_1AuthService.html">AuthService</a>* Wt::Auth::FormBaseModel::baseAuth </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the authentication base service. </p>
<p>This returns the service passed through the constructor. </p>
</div>
</div>
<a class="anchor" id="a8bd5862221e0fa8f84ceba4b8a440a09"></a><!-- doxytag: member="Wt::Auth::FormBaseModel::label" ref="a8bd5862221e0fa8f84ceba4b8a440a09" args="(Field field) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> Wt::Auth::FormBaseModel::label </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WFormModel.html#a33c90b8c637bc83bbc57717175a5aa52">Field</a> </td>
<td class="paramname"><em>field</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a field label. </p>
<p>The default implementation returns the WString::tr(field) </p>
<p>Reimplemented from <a class="el" href="classWt_1_1WFormModel.html#a09ff735f56210e510b64d90df1c13db5">Wt::WFormModel</a>.</p>
</div>
</div>
<a class="anchor" id="ab3dae22d97b18941a8f67e8fcd315ead"></a><!-- doxytag: member="Wt::Auth::FormBaseModel::oAuth" ref="ab3dae22d97b18941a8f67e8fcd315ead" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector<const <a class="el" href="classWt_1_1Auth_1_1OAuthService.html">OAuthService</a> *> Wt::Auth::FormBaseModel::oAuth </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the list of OAuth authentication service providers. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1FormBaseModel.html#ab69e01f34fc48375ec6fe9412b2b8ed0" title="Adds an OAuth authentication service provider.">addOAuth()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1ee6e0ea98e432538ee25e0f87991c67"></a><!-- doxytag: member="Wt::Auth::FormBaseModel::passwordAuth" ref="a1ee6e0ea98e432538ee25e0f87991c67" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService.html">AbstractPasswordService</a>* Wt::Auth::FormBaseModel::passwordAuth </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the password authentication service. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1FormBaseModel.html#a970b5cff2c2fe0ce9eefbb32c7cf0aed" title="Adds a password authentication service.">addPasswordAuth()</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 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>
|
