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
|
<!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::OAuthProcess 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_1OAuthProcess.html">OAuthProcess</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> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::Auth::OAuthProcess Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::Auth::OAuthProcess" --><!-- doxytag: inherits="Wt::WObject" -->
<p>An OAuth authorization (and authentication) process.
<a href="classWt_1_1Auth_1_1OAuthProcess.html#details">More...</a></p>
<p><code>#include <Auth/OAuthService></code></p>
<div class="dynheader">
Inheritance diagram for Wt::Auth::OAuthProcess:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1Auth_1_1OAuthProcess__inherit__graph.png" border="0" usemap="#Wt_1_1Auth_1_1OAuthProcess_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1Auth_1_1OAuthProcess_inherit__map" id="Wt_1_1Auth_1_1OAuthProcess_inherit__map">
<area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="40,5,136,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1Auth_1_1OAuthProcess-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_1OAuthProcess_1_1TokenError.html">TokenError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Exception thrown while parsing a token response. <a href="classWt_1_1Auth_1_1OAuthProcess_1_1TokenError.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">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#a16b5b8b50f80aee9dcbc03044c82375c">scope</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the scope for which this process was created. <a href="#a16b5b8b50f80aee9dcbc03044c82375c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">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_1OAuthProcess.html#aa6520912520dc1b4516ea2d72837a094">service</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the OAuth service which spawned this process. <a href="#aa6520912520dc1b4516ea2d72837a094"></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_1OAuthProcess.html#a3be5a91214f39bf357996e9b3d4741c8">startAuthorize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts an authorization process. <a href="#a3be5a91214f39bf357996e9b3d4741c8"></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_1OAuthProcess.html#a3f6e1c6cf8015d5515d61875cc81fd6c">startAuthenticate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts an authorization and authentication process. <a href="#a3f6e1c6cf8015d5515d61875cc81fd6c"></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_1OAuthProcess.html#aa8102afbc7fa52027e15f4a952288923">getIdentity</a> (const <a class="el" href="classWt_1_1Auth_1_1OAuthAccessToken.html">OAuthAccessToken</a> &token)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtains an authenticated identity. <a href="#aa8102afbc7fa52027e15f4a952288923"></a><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_1OAuthProcess.html#a70490507d321323cc6b8662d8e32a3a7">error</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Error information, in case authentication or identification failed. <a href="#a70490507d321323cc6b8662d8e32a3a7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1Auth_1_1OAuthAccessToken.html">OAuthAccessToken</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#afac487675741149ccc7b6172d8856297">token</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the access token. <a href="#afac487675741149ccc7b6172d8856297"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Signal.html">Signal</a>< <a class="el" href="classWt_1_1Auth_1_1OAuthAccessToken.html">OAuthAccessToken</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#ad1f0c2b2915d4d2e75143b1d73170b86">authorized</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Authorization signal. <a href="#ad1f0c2b2915d4d2e75143b1d73170b86"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1Signal.html">Signal</a>< <a class="el" href="classWt_1_1Auth_1_1Identity.html">Identity</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#a22d65da9fa8a510363beff4b6e057d8b">authenticated</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Authentication signal. <a href="#a22d65da9fa8a510363beff4b6e057d8b"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#aa31f2e070502f9614a90ec3dfc5037fc">OAuthProcess</a> (const <a class="el" href="classWt_1_1Auth_1_1OAuthService.html">OAuthService</a> &service, const std::string &scope)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#aa31f2e070502f9614a90ec3dfc5037fc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classWt_1_1Auth_1_1OAuthAccessToken.html">OAuthAccessToken</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#ad951ad389cff9c3de719f416f40c9a75">parseTokenResponse</a> (const <a class="el" href="classWt_1_1Http_1_1Message.html">Http::Message</a> &response)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses the response for a token request. <a href="#ad951ad389cff9c3de719f416f40c9a75"></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_1OAuthProcess.html#ae1a2ab7a8f9e120c2b5bf8e8a3aa1a21">setError</a> (const <a class="el" href="classWt_1_1WString.html">WString</a> &e)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the error. <a href="#ae1a2ab7a8f9e120c2b5bf8e8a3aa1a21"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An OAuth authorization (and authentication) process. </p>
<p>The process implements the state machine that is needed to complete an OAuth authorization cycle.</p>
<p>Optionally, it also provides authentication, by using the service-specific logic which uses the access token to return identity information.</p>
<p>A process is created for a particular scope, which represents what kind of information one wants to access, and which is used to inform the user of the kind of operations he needs to authorize for your application to make with his protected data.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1OAuthService.html#a24c71776988c7562c507714acb295e06" title="Creates a new authorizaiton process.">OAuthService::createProcess()</a> </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa31f2e070502f9614a90ec3dfc5037fc"></a><!-- doxytag: member="Wt::Auth::OAuthProcess::OAuthProcess" ref="aa31f2e070502f9614a90ec3dfc5037fc" args="(const OAuthService &service, const std::string &scope)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Wt::Auth::OAuthProcess::OAuthProcess </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1OAuthService.html">OAuthService</a> & </td>
<td class="paramname"><em>service</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>scope</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1OAuthService.html#a24c71776988c7562c507714acb295e06" title="Creates a new authorizaiton process.">OAuthService::createProcess()</a> </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a22d65da9fa8a510363beff4b6e057d8b"></a><!-- doxytag: member="Wt::Auth::OAuthProcess::authenticated" ref="a22d65da9fa8a510363beff4b6e057d8b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Signal.html">Signal</a><<a class="el" href="classWt_1_1Auth_1_1Identity.html">Identity</a>>& Wt::Auth::OAuthProcess::authenticated </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Authentication signal. </p>
<p>This signal indicates the end of an authentication process started with <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#a3f6e1c6cf8015d5515d61875cc81fd6c" title="Starts an authorization and authentication process.">startAuthenticate()</a> or <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#aa8102afbc7fa52027e15f4a952288923" title="Obtains an authenticated identity.">getIdentity()</a>. If the authentication process was successful, then the parameter is a valid and authentic identity. If the authentication process failed then the identity parameter is invalid, and you can get more information using <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#a70490507d321323cc6b8662d8e32a3a7" title="Error information, in case authentication or identification failed.">error()</a>.</p>
<p>Authentication can fail because authorization failed (in case of <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#a3f6e1c6cf8015d5515d61875cc81fd6c" title="Starts an authorization and authentication process.">startAuthenticate()</a>), or because of a protocol error, or configuration problem.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#a3f6e1c6cf8015d5515d61875cc81fd6c" title="Starts an authorization and authentication process.">startAuthenticate()</a>, <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#aa8102afbc7fa52027e15f4a952288923" title="Obtains an authenticated identity.">getIdentity()</a>, <a class="el" href="classWt_1_1Auth_1_1Identity.html#ad9741bdd1c5175d496fe71e8f036f335" title="Returns whether the identity is valid.">Identity::isValid()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ad1f0c2b2915d4d2e75143b1d73170b86"></a><!-- doxytag: member="Wt::Auth::OAuthProcess::authorized" ref="ad1f0c2b2915d4d2e75143b1d73170b86" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Signal.html">Signal</a><<a class="el" href="classWt_1_1Auth_1_1OAuthAccessToken.html">OAuthAccessToken</a>>& Wt::Auth::OAuthProcess::authorized </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Authorization signal. </p>
<p>This signal indicates the end of an authorization process started with <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#a3be5a91214f39bf357996e9b3d4741c8" title="Starts an authorization process.">startAuthorize()</a>. If the authorization process was successful, then the parameter carries a valid access token that was obtained. If the authorization process failed then the access token parameter is invalid, and you can get more information using <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#a70490507d321323cc6b8662d8e32a3a7" title="Error information, in case authentication or identification failed.">error()</a>.</p>
<p>Authorization can fail because of a protocol error, aconfiguration problem, or because the user denied the authorization.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#a3be5a91214f39bf357996e9b3d4741c8" title="Starts an authorization process.">startAuthorize()</a>, <a class="el" href="classWt_1_1Auth_1_1OAuthAccessToken.html#a2b078fd272b05cb91cd9954b172a41c7" title="Returns whether the token is valid.">OAuthAccessToken::isValid()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a70490507d321323cc6b8662d8e32a3a7"></a><!-- doxytag: member="Wt::Auth::OAuthProcess::error" ref="a70490507d321323cc6b8662d8e32a3a7" args="() 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::OAuthProcess::error </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Error information, in case authentication or identification failed. </p>
<p>The error message contains details when the <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#ad1f0c2b2915d4d2e75143b1d73170b86" title="Authorization signal.">authorized()</a> or <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#a22d65da9fa8a510363beff4b6e057d8b" title="Authentication signal.">authenticated()</a> signals indicate respectively an invalid token or invalid identity. </p>
</div>
</div>
<a class="anchor" id="aa8102afbc7fa52027e15f4a952288923"></a><!-- doxytag: member="Wt::Auth::OAuthProcess::getIdentity" ref="aa8102afbc7fa52027e15f4a952288923" args="(const OAuthAccessToken &token)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::OAuthProcess::getIdentity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1OAuthAccessToken.html">OAuthAccessToken</a> & </td>
<td class="paramname"><em>token</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Obtains an authenticated identity. </p>
<p>The authentication process uses an access token to issue one or more protected requests for obtaining identity information. This is not part of the OAuth protocol, since OAuth does not standardize the use of the access token to obtain this information.</p>
<p>The authentication process ends with the <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#a22d65da9fa8a510363beff4b6e057d8b" title="Authentication signal.">authenticated()</a> signal which signals the obtained identity. </p>
</div>
</div>
<a class="anchor" id="ad951ad389cff9c3de719f416f40c9a75"></a><!-- doxytag: member="Wt::Auth::OAuthProcess::parseTokenResponse" ref="ad951ad389cff9c3de719f416f40c9a75" args="(const Http::Message &response)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1Auth_1_1OAuthAccessToken.html">OAuthAccessToken</a> Wt::Auth::OAuthProcess::parseTokenResponse </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Http_1_1Message.html">Http::Message</a> & </td>
<td class="paramname"><em>response</em></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parses the response for a token request. </p>
<p>Throws a <a class="el" href="classWt_1_1Auth_1_1OAuthProcess_1_1TokenError.html" title="Exception thrown while parsing a token response.">TokenError</a> when the response indicates an error, or when the response could not be properly parsed.</p>
<p>Some OAuth implementations may uses a non-standard encoding of the token. </p>
</div>
</div>
<a class="anchor" id="a16b5b8b50f80aee9dcbc03044c82375c"></a><!-- doxytag: member="Wt::Auth::OAuthProcess::scope" ref="a16b5b8b50f80aee9dcbc03044c82375c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Wt::Auth::OAuthProcess::scope </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the scope for which this process was created. </p>
<p>The scope represents how much protected information the web application wants to access, and in what way.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1OAuthService.html#a24c71776988c7562c507714acb295e06" title="Creates a new authorizaiton process.">OAuthService::createProcess()</a>, <a class="el" href="classWt_1_1Auth_1_1OAuthService.html#a040351f2a2b956c059ea9974e6829d13" title="Returns the scope needed for authentication.">OAuthService::authenticationScope()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa6520912520dc1b4516ea2d72837a094"></a><!-- doxytag: member="Wt::Auth::OAuthProcess::service" ref="aa6520912520dc1b4516ea2d72837a094" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1Auth_1_1OAuthService.html">OAuthService</a>& Wt::Auth::OAuthProcess::service </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the OAuth service which spawned this process. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1OAuthService.html#a24c71776988c7562c507714acb295e06" title="Creates a new authorizaiton process.">OAuthService::createProcess()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ae1a2ab7a8f9e120c2b5bf8e8a3aa1a21"></a><!-- doxytag: member="Wt::Auth::OAuthProcess::setError" ref="ae1a2ab7a8f9e120c2b5bf8e8a3aa1a21" args="(const WString &e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::OAuthProcess::setError </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>e</em></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the error. </p>
<p>This should be used in <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#aa8102afbc7fa52027e15f4a952288923" title="Obtains an authenticated identity.">getIdentity()</a> implementations to set the error, before emitting <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#a22d65da9fa8a510363beff4b6e057d8b" title="Authentication signal.">authenticated()</a> with an invalid <a class="el" href="classWt_1_1Auth_1_1Identity.html" title="A class that represents a user identity.">Identity</a>. </p>
</div>
</div>
<a class="anchor" id="a3f6e1c6cf8015d5515d61875cc81fd6c"></a><!-- doxytag: member="Wt::Auth::OAuthProcess::startAuthenticate" ref="a3f6e1c6cf8015d5515d61875cc81fd6c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::OAuthProcess::startAuthenticate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Starts an authorization and authentication process. </p>
<p>This is <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#a3be5a91214f39bf357996e9b3d4741c8" title="Starts an authorization process.">startAuthorize()</a> followed by <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#aa8102afbc7fa52027e15f4a952288923" title="Obtains an authenticated identity.">getIdentity()</a>.</p>
<p>This requires that the process is created with an authorization scope that includes sufficient rights for authentication (at least <a class="el" href="classWt_1_1Auth_1_1OAuthService.html#a040351f2a2b956c059ea9974e6829d13" title="Returns the scope needed for authentication.">OAuthService::authenticationScope()</a>)</p>
<p>The authentication process ends with the <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#a22d65da9fa8a510363beff4b6e057d8b" title="Authentication signal.">authenticated()</a> signal which signals the obtained identity.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>To be able to use a popup (instead of a page redirect), you should connect this method directly to an, since popup windows are blocked in most web browsers unless they are the direct consequence of an event. </dd></dl>
</div>
</div>
<a class="anchor" id="a3be5a91214f39bf357996e9b3d4741c8"></a><!-- doxytag: member="Wt::Auth::OAuthProcess::startAuthorize" ref="a3be5a91214f39bf357996e9b3d4741c8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Auth::OAuthProcess::startAuthorize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Starts an authorization process. </p>
<p>This starts an authorization process to request an accesstoken to access protected information within the process scope.</p>
<p>The authorization process ends with the <a class="el" href="classWt_1_1Auth_1_1OAuthProcess.html#ad1f0c2b2915d4d2e75143b1d73170b86" title="Authorization signal.">authorized()</a> signal which signals the obtained token.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>To be able to use a popup (instead of a page redirect), you should connect this method directly to an, since popup windows are blocked in most web browsers unless they are the direct consequence of an event. </dd></dl>
</div>
</div>
<a class="anchor" id="afac487675741149ccc7b6172d8856297"></a><!-- doxytag: member="Wt::Auth::OAuthProcess::token" ref="afac487675741149ccc7b6172d8856297" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1Auth_1_1OAuthAccessToken.html">OAuthAccessToken</a>& Wt::Auth::OAuthProcess::token </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the access token. </p>
<p>This returns the access token that was obtained in the last authorization cycle. </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>
|
