{{ message }}
This repository was archived by the owner on Jun 28, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 28
Expand file tree
/
Copy pathrequest.html
More file actions
743 lines (622 loc) · 54.3 KB
/
Copy pathrequest.html
File metadata and controls
743 lines (622 loc) · 54.3 KB
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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Request Context — Stormpath Java Servlet Plugin 1.5.4 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
<link rel="author" title="About these documents"
href="about.html"/>
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="Stormpath Java Servlet Plugin 1.5.4 documentation" href="index.html"/>
<link rel="next" title="Access Control" href="access-control.html"/>
<link rel="prev" title="HTTP Request Authentication" href="request-authentication.html"/>
<script src="_static/js/modernizr.min.js"></script>
<script src="https://cdn.optimizely.com/js/225847041.js"></script>
<script>
!function(f,b,e,v,n,t,s){if(f.fbq)return;n=f.fbq=function(){n.callMethod?
n.callMethod.apply(n,arguments):n.queue.push(arguments)};if(!f._fbq)f._fbq=n;
n.push=n;n.loaded=!0;n.version='2.0';n.queue=[];t=b.createElement(e);t.async=!0;
t.src=v;s=b.getElementsByTagName(e)[0];s.parentNode.insertBefore(t,s)}(window,
document,'script','https://connect.facebook.net/en_US/fbevents.js');
fbq('init', '986262161469311');
fbq('track', 'PageView');
</script>
<noscript><img height="1" width="1" style="display:none"
src="https://www.facebook.com/tr?id=986262161469311&ev=PageView&noscript=1"
/></noscript>
</head>
<body class="wy-body-for-nav" role="document">
<noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-NQZZFW"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-NQZZFW');</script>
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> Stormpath Java Servlet Plugin
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
<li class="toctree-l2"><a class="reference internal" href="about.html#what-is-stormpath">What is Stormpath?</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#what-is-the-project">What is the Stormpath Java Servlet Plugin?</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#who-should-use-stormpath">Who should use Stormpath?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#get-an-api-key">Get an API Key</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#add-the-project">Add the Stormpath Java Servlet Plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#try-it">Try it!</a><ul>
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#any-problems">Any Problems?</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#next-steps">Next Steps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="config.html">Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="config.html#no-config">No Config?</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html#web-xml">web.xml</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html#stormpath-properties">stormpath.properties</a><ul>
<li class="toctree-l3"><a class="reference internal" href="config.html#property-locations">Property Locations</a><ul>
<li class="toctree-l4"><a class="reference internal" href="config.html#plugin-web-stormpath-properties">1. Plugin web.stormpath.properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="config.html#classpath-stormpath-properties">2. classpath:stormpath.properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="config.html#web-inf-stormpath-properties">3. /WEB-INF/stormpath.properties</a></li>
<li class="toctree-l4"><a class="reference internal" href="config.html#servlet-context-parameters">4. Servlet Context Parameters</a></li>
<li class="toctree-l4"><a class="reference internal" href="config.html#environment-variables">5. Environment Variables</a></li>
<li class="toctree-l4"><a class="reference internal" href="config.html#jvm-system-properties">6. JVM System Properties</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="config.html#security-considerations-passwords-and-secret-values">Security Considerations: Passwords and secret values</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="config.html#stormpath-client">Stormpath Client</a><ul>
<li class="toctree-l3"><a class="reference internal" href="config.html#api-key">API Key</a></li>
<li class="toctree-l3"><a class="reference internal" href="config.html#http-proxy">HTTP Proxy</a></li>
<li class="toctree-l3"><a class="reference internal" href="config.html#authentication-scheme">Authentication Scheme</a></li>
<li class="toctree-l3"><a class="reference internal" href="config.html#usage">Usage</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="config.html#stormpath-application">Stormpath Application</a><ul>
<li class="toctree-l3"><a class="reference internal" href="config.html#id2">Usage</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="config.html#filters">Filters</a><ul>
<li class="toctree-l3"><a class="reference internal" href="config.html#default-filters">Default Filters</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="config.html#uris">URIs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="config.html#uri-evaluation-priority">URI Evaluation Priority</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="registration.html">Registration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="registration.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="registration.html#configuration">Configuration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="registration.html#enabled">Enabled</a></li>
<li class="toctree-l3"><a class="reference internal" href="registration.html#uri">URI</a></li>
<li class="toctree-l3"><a class="reference internal" href="registration.html#next-uri">Next URI</a><ul>
<li class="toctree-l4"><a class="reference internal" href="registration.html#next-query-parameter">Next Query Parameter</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="registration.html#autologin">AutoLogin</a></li>
<li class="toctree-l3"><a class="reference internal" href="registration.html#form-fields">Form Fields</a><ul>
<li class="toctree-l4"><a class="reference internal" href="registration.html#form-field-definitions">Form Field Definitions</a></li>
<li class="toctree-l4"><a class="reference internal" href="registration.html#standard-form-fields">Standard Form Fields</a></li>
<li class="toctree-l4"><a class="reference internal" href="registration.html#custom-form-fields">Custom Form Fields</a></li>
<li class="toctree-l4"><a class="reference internal" href="registration.html#optional-form-fields">Optional Form Fields</a></li>
<li class="toctree-l4"><a class="reference internal" href="registration.html#disabling-form-fields">Disabling Form Fields</a></li>
<li class="toctree-l4"><a class="reference internal" href="registration.html#form-field-order">Form Field Order</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="registration.html#password-strength">Password Strength</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="registration.html#email-verification">Email Verification</a><ul>
<li class="toctree-l3"><a class="reference internal" href="registration.html#try-it">Try it!</a></li>
<li class="toctree-l3"><a class="reference internal" href="registration.html#verify-link-base-url">Verify Link Base URL</a></li>
<li class="toctree-l3"><a class="reference internal" href="registration.html#verify-next-uri">Verify Next URI</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="registration.html#internationalization-i18n">Internationalization (i18n)</a></li>
<li class="toctree-l2"><a class="reference internal" href="registration.html#pre-register-handler">Pre Register Handler</a></li>
<li class="toctree-l2"><a class="reference internal" href="registration.html#post-register-handler">Post Register Handler</a></li>
<li class="toctree-l2"><a class="reference internal" href="registration.html#events">Events</a><ul>
<li class="toctree-l3"><a class="reference internal" href="registration.html#registered-account">Registered Account</a></li>
<li class="toctree-l3"><a class="reference internal" href="registration.html#verified-account">Verified Account</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="login.html">Login</a><ul>
<li class="toctree-l2"><a class="reference internal" href="login.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="login.html#security-notice">Security Notice</a></li>
<li class="toctree-l2"><a class="reference internal" href="login.html#uri">URI</a><ul>
<li class="toctree-l3"><a class="reference internal" href="login.html#next-query-parameter">Next Query Parameter</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="login.html#next-uri">Next URI</a></li>
<li class="toctree-l2"><a class="reference internal" href="login.html#internationalization-i18n">Internationalization (i18n)</a></li>
<li class="toctree-l2"><a class="reference internal" href="login.html#pre-login-handler">Pre Login Handler</a></li>
<li class="toctree-l2"><a class="reference internal" href="login.html#post-login-handler">Post Login Handler</a></li>
<li class="toctree-l2"><a class="reference internal" href="login.html#events">Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="login.html#authentication-state">Authentication State</a><ul>
<li class="toctree-l3"><a class="reference internal" href="login.html#saving-authentication-state">Saving Authentication State</a></li>
<li class="toctree-l3"><a class="reference internal" href="login.html#cookie-storage">Cookie Storage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="login.html#cookie-config">Cookie Config</a></li>
<li class="toctree-l4"><a class="reference internal" href="login.html#jwt-creation">JWT Creation</a></li>
<li class="toctree-l4"><a class="reference internal" href="login.html#disabling-cookie-storage">Disabling Cookie Storage</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="login.html#custom-savers">Custom Savers</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="social.html">Social Login</a><ul>
<li class="toctree-l2"><a class="reference internal" href="social.html#facebook-login">Facebook Login</a><ul>
<li class="toctree-l3"><a class="reference internal" href="social.html#create-a-facebook-app">Create a Facebook App</a></li>
<li class="toctree-l3"><a class="reference internal" href="social.html#specify-allowed-urls">Specify Allowed URLs</a></li>
<li class="toctree-l3"><a class="reference internal" href="social.html#create-a-facebook-directory">Create a Facebook Directory</a></li>
<li class="toctree-l3"><a class="reference internal" href="social.html#test-it-out">Test it Out</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="social.html#google-login">Google Login</a><ul>
<li class="toctree-l3"><a class="reference internal" href="social.html#create-a-google-project">Create a Google Project</a></li>
<li class="toctree-l3"><a class="reference internal" href="social.html#enable-google-login">Enable Google Login</a></li>
<li class="toctree-l3"><a class="reference internal" href="social.html#create-oauth-credentials">Create OAuth Credentials</a></li>
<li class="toctree-l3"><a class="reference internal" href="social.html#create-a-google-directory">Create a Google Directory</a></li>
<li class="toctree-l3"><a class="reference internal" href="social.html#id1">Test it Out</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="social.html#linkedin-login">LinkedIn Login</a><ul>
<li class="toctree-l3"><a class="reference internal" href="social.html#create-a-linkedin-application">Create a LinkedIn Application</a></li>
<li class="toctree-l3"><a class="reference internal" href="social.html#enable-linkedin-permissions">Enable LinkedIn Permissions</a></li>
<li class="toctree-l3"><a class="reference internal" href="social.html#create-a-linkedin-directory">Create a LinkedIn Directory</a></li>
<li class="toctree-l3"><a class="reference internal" href="social.html#id2">Test it Out</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="social.html#json-api">JSON API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="forgot-password.html">Forgot Password</a><ul>
<li class="toctree-l2"><a class="reference internal" href="forgot-password.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="forgot-password.html#configure-the-workflow">Configure the Workflow</a></li>
<li class="toctree-l2"><a class="reference internal" href="forgot-password.html#try-it">Try it!</a></li>
<li class="toctree-l2"><a class="reference internal" href="forgot-password.html#forgot-uri">Forgot URI</a></li>
<li class="toctree-l2"><a class="reference internal" href="forgot-password.html#forgot-next-uri">Forgot Next URI</a></li>
<li class="toctree-l2"><a class="reference internal" href="forgot-password.html#change-password-uri">Change Password URI</a></li>
<li class="toctree-l2"><a class="reference internal" href="forgot-password.html#change-password-next-uri">Change Password Next URI</a></li>
<li class="toctree-l2"><a class="reference internal" href="forgot-password.html#i18n">i18n</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="logout.html">Logout</a><ul>
<li class="toctree-l2"><a class="reference internal" href="logout.html#uri">URI</a><ul>
<li class="toctree-l3"><a class="reference internal" href="logout.html#next-query-parameter">Next Query Parameter</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="logout.html#next-uri">Next URI</a></li>
<li class="toctree-l2"><a class="reference internal" href="logout.html#events">Events</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="request-authentication.html">HTTP Request Authentication</a><ul>
<li class="toctree-l2"><a class="reference internal" href="request-authentication.html#http-basic-authentication">HTTP Basic Authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="request-authentication.html#token-authentication">Token Authentication</a><ul>
<li class="toctree-l3"><a class="reference internal" href="request-authentication.html#get-a-token">Get a Token</a><ul>
<li class="toctree-l4"><a class="reference internal" href="request-authentication.html#curl">cURL</a></li>
<li class="toctree-l4"><a class="reference internal" href="request-authentication.html#html-form-and-ajax">HTML Form and AJAX</a></li>
<li class="toctree-l4"><a class="reference internal" href="request-authentication.html#origin-or-referer-required">Origin or Referer Required</a></li>
<li class="toctree-l4"><a class="reference internal" href="request-authentication.html#https-required">HTTPS Required</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="request-authentication.html#api-key-authentication">API Key Authentication</a><ul>
<li class="toctree-l3"><a class="reference internal" href="request-authentication.html#determining-api-key-authentication">Determining API Key Authentication</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Request Context</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#current-user-account">Current User Account</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#account-resolver">Account Resolver</a></li>
<li class="toctree-l3"><a class="reference internal" href="#request-attributes">Request Attributes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#request-attribute-names">Request Attribute Names</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#http-servlet-request-api">HTTP Servlet Request API</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#httpservletrequest-getremoteuser">HttpServletRequest getRemoteUser()</a></li>
<li class="toctree-l4"><a class="reference internal" href="#httpservletrequest-getuserprincipal">HttpServletRequest getUserPrincipal()</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#stormpath-application">Stormpath Application</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#application-resolver">Application Resolver</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id2">Request Attributes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#default-request-attribute-name">Default Request Attribute Name</a></li>
<li class="toctree-l4"><a class="reference internal" href="#custom-request-attribute-names">Custom Request Attribute Names</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#stormpath-client">Stormpath Client</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#client-resolver">Client Resolver</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id3">Request Attributes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id4">Default Request Attribute Name</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id5">Custom Request Attribute Names</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="access-control.html">Access Control</a><ul>
<li class="toctree-l2"><a class="reference internal" href="access-control.html#authentication">Authentication</a><ul>
<li class="toctree-l3"><a class="reference internal" href="access-control.html#unauthenticatedhandler">UnauthenticatedHandler</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="access-control.html#exclusions">Exclusions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="i18n.html">Internationalization (i18n)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="i18n.html#languages">Languages</a></li>
<li class="toctree-l2"><a class="reference internal" href="i18n.html#request-locale">Request Locale</a></li>
<li class="toctree-l2"><a class="reference internal" href="i18n.html#jsp-tag-library">JSP Tag Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="i18n.html#i18n-properties">i18n.properties</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="events.html">Events</a><ul>
<li class="toctree-l2"><a class="reference internal" href="events.html#requesteventlistener">RequestEventListener</a></li>
<li class="toctree-l2"><a class="reference internal" href="events.html#id2">Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="events.html#listener-best-practices">Listener Best Practices</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="caching.html">Caching</a><ul>
<li class="toctree-l2"><a class="reference internal" href="caching.html#in-process-cache">In-Process Cache</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching.html#disable-caching">Disable Caching</a><ul>
<li class="toctree-l3"><a class="reference internal" href="caching.html#default-ttl">Default TTL</a></li>
<li class="toctree-l3"><a class="reference internal" href="caching.html#default-tti">Default TTI</a></li>
<li class="toctree-l3"><a class="reference internal" href="caching.html#cache-regions">Cache Regions</a></li>
<li class="toctree-l3"><a class="reference internal" href="caching.html#client-cache-regions">Client Cache Regions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="caching.html#shared-cache">Shared Cache</a><ul>
<li class="toctree-l3"><a class="reference internal" href="caching.html#nonce-cache-region">Nonce Cache Region</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="idsite.html">ID Site</a><ul>
<li class="toctree-l2"><a class="reference internal" href="idsite.html#how-does-it-work">How Does It Work?</a></li>
<li class="toctree-l2"><a class="reference internal" href="idsite.html#enable-id-site">Enable ID Site</a></li>
<li class="toctree-l2"><a class="reference internal" href="idsite.html#configure-your-application">Configure Your Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="idsite.html#try-it">Try It!</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="views.html">Custom Views</a><ul>
<li class="toctree-l2"><a class="reference internal" href="views.html#jsp-views">JSP Views</a></li>
<li class="toctree-l2"><a class="reference internal" href="views.html#css">CSS</a></li>
<li class="toctree-l2"><a class="reference internal" href="views.html#internationalization-i18n">Internationalization (i18n)</a></li>
<li class="toctree-l2"><a class="reference internal" href="views.html#change-a-default-view">Change a Default View</a></li>
<li class="toctree-l2"><a class="reference internal" href="views.html#view-template">View Template</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="appendix.html">Appendix</a><ul>
<li class="toctree-l2"><a class="reference internal" href="appendix/web-stormpath-properties.html">web.stormpath.properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="appendix/i18n-properties.html">i18n.properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="appendix/stormpath-css.html">stormpath.css</a></li>
<li class="toctree-l2"><a class="reference internal" href="appendix/change-password.html">/WEB-INF/jsp/stormpath/change-password.jsp</a></li>
<li class="toctree-l2"><a class="reference internal" href="appendix/forgot-password.html">/WEB-INF/jsp/stormpath/forgot-password.jsp</a></li>
<li class="toctree-l2"><a class="reference internal" href="appendix/login.html">/WEB-INF/jsp/stormpath/login.jsp</a></li>
<li class="toctree-l2"><a class="reference internal" href="appendix/register.html">/WEB-INF/jsp/stormpath/register.jsp</a></li>
<li class="toctree-l2"><a class="reference internal" href="appendix/verify.html">/WEB-INF/jsp/stormpath/verify.jsp</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Stormpath Java Servlet Plugin</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Request Context</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<blockquote>
<div></div></blockquote>
<div class="section" id="request-context">
<span id="request"></span><h1>Request Context<a class="headerlink" href="#request-context" title="Permalink to this headline">¶</a></h1>
<p>The Stormpath Java Servlet Plugin ensures important Stormpath objects are available to your application code during a request:</p>
<ul class="simple">
<li>The Stormpath SDK <code class="docutils literal"><span class="pre">Client</span></code> instance, in case you want to communicate with Stormpath for any behavior that the Stormpath Java Servlet Plugin does not automate.</li>
<li>The Stormpath <code class="docutils literal"><span class="pre">Application</span></code> instance that corresponds to your web application.</li>
<li>A Stormpath <code class="docutils literal"><span class="pre">Account</span></code> instance that represents the current authenticated user account making the request.</li>
</ul>
<p>The <code class="docutils literal"><span class="pre">Client</span></code> and <code class="docutils literal"><span class="pre">Application</span></code> will always be available. The current user <code class="docutils literal"><span class="pre">Account</span></code> is only available if the user making the request is authenticated.</p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#current-user-account" id="id6">Current User Account</a><ul>
<li><a class="reference internal" href="#account-resolver" id="id7">Account Resolver</a></li>
<li><a class="reference internal" href="#request-attributes" id="id8">Request Attributes</a></li>
<li><a class="reference internal" href="#http-servlet-request-api" id="id9">HTTP Servlet Request API</a></li>
</ul>
</li>
<li><a class="reference internal" href="#stormpath-application" id="id10">Stormpath Application</a><ul>
<li><a class="reference internal" href="#application-resolver" id="id11">Application Resolver</a></li>
<li><a class="reference internal" href="#id2" id="id12">Request Attributes</a></li>
</ul>
</li>
<li><a class="reference internal" href="#stormpath-client" id="id13">Stormpath Client</a><ul>
<li><a class="reference internal" href="#client-resolver" id="id14">Client Resolver</a></li>
<li><a class="reference internal" href="#id3" id="id15">Request Attributes</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="current-user-account">
<h2><a class="toc-backref" href="#id6">Current User Account</a><a class="headerlink" href="#current-user-account" title="Permalink to this headline">¶</a></h2>
<p>After a user <a class="reference internal" href="registration.html#registration"><span class="std std-ref">registers</span></a> or <a class="reference internal" href="login.html#login"><span class="std std-ref">logs in</span></a>, you can get the user <code class="docutils literal"><span class="pre">Account</span></code> making the request using an <code class="docutils literal"><span class="pre">AccountResolver</span></code>, request attributes, or the <code class="docutils literal"><span class="pre">HttpServletRequest</span></code> API directly.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">A request <code class="docutils literal"><span class="pre">Account</span></code> will only be available if a known user has previously authenticated and is making the request. If the request is made by an unknown user (a ‘guest’) that has not yet authenticated, the request will not have an associated <code class="docutils literal"><span class="pre">Account</span></code>.</p>
</div>
<div class="contents local topic" id="id1">
<ul class="simple">
<li><a class="reference internal" href="#account-resolver" id="id16">Account Resolver</a></li>
<li><a class="reference internal" href="#request-attributes" id="id17">Request Attributes</a></li>
<li><a class="reference internal" href="#http-servlet-request-api" id="id18">HTTP Servlet Request API</a></li>
</ul>
</div>
<div class="section" id="account-resolver">
<h3><a class="toc-backref" href="#id16">Account Resolver</a><a class="headerlink" href="#account-resolver" title="Permalink to this headline">¶</a></h3>
<p>A type-safe way to get an <code class="docutils literal"><span class="pre">Account</span></code> associated with the current request is to use the <code class="docutils literal"><span class="pre">AccountResolver</span></code>:</p>
<div class="highlight-java"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">com.stormpath.sdk.account.Account</span><span class="o">;</span>
<span class="c1">//...</span>
<span class="k">if</span> <span class="o">(</span><span class="n">AccountResolver</span><span class="o">.</span><span class="na">INSTANCE</span><span class="o">.</span><span class="na">hasAccount</span><span class="o">(</span><span class="n">request</span><span class="o">))</span> <span class="o">{</span>
<span class="c1">//a known user has authenticated previously - get the user identity:</span>
<span class="n">Account</span> <span class="n">account</span> <span class="o">=</span> <span class="n">AccountResolver</span><span class="o">.</span><span class="na">INSTANCE</span><span class="o">.</span><span class="na">getRequiredAccount</span><span class="o">(</span><span class="n">request</span><span class="o">);</span>
<span class="c1">//do something with the account</span>
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
<span class="c1">//the current user is unknown - either unauthenticated or a guest.</span>
<span class="o">}</span>
</pre></div>
</div>
<div class="admonition caution">
<p class="first admonition-title">Caution</p>
<p>Notice that the <code class="docutils literal"><span class="pre">AccountResolver.getRequiredAccount</span></code> method is only invoked if it is known that there is indeed an Account instance available. If an account is not available when calling <code class="docutils literal"><span class="pre">getRequiredAccount</span></code> an exception will be thrown.</p>
<p class="last">This <em>check-then-use</em> pattern helps eliminate NullPointerExceptions and conditional branching bugs when working with user identities - often desirable in sensitive logic.</p>
</div>
</div>
<div class="section" id="request-attributes">
<h3><a class="toc-backref" href="#id17">Request Attributes</a><a class="headerlink" href="#request-attributes" title="Permalink to this headline">¶</a></h3>
<p>While request attribute lookups are not type-safe (<code class="docutils literal"><span class="pre">String</span></code> keys and <code class="docutils literal"><span class="pre">Object</span></code> return types), they can be convenient or preferred in some situations.</p>
<div class="section" id="request-attribute-names">
<h4>Request Attribute Names<a class="headerlink" href="#request-attribute-names" title="Permalink to this headline">¶</a></h4>
<p>If an <code class="docutils literal"><span class="pre">Account</span></code> is associated with the current request, it will be available via the request attribute name equal to the <code class="docutils literal"><span class="pre">Account</span></code> interface’s fully qualified class name. For example:</p>
<div class="highlight-java"><div class="highlight"><pre><span></span><span class="n">Account</span> <span class="n">account</span> <span class="o">=</span> <span class="o">(</span><span class="n">Account</span><span class="o">)</span> <span class="n">request</span><span class="o">.</span><span class="na">getAttribute</span><span class="o">(</span><span class="n">Account</span><span class="o">.</span><span class="na">getClass</span><span class="o">().</span><span class="na">getName</span><span class="o">());</span>
<span class="c1">//account will be null if the request is not yet associated with a known user account.</span>
</pre></div>
</div>
<p>It will also be available via the simpler unqualified name of <code class="docutils literal"><span class="pre">account</span></code>. For example, the following line provides the same exact result as the one above:</p>
<div class="highlight-java"><div class="highlight"><pre><span></span><span class="n">Account</span> <span class="n">account</span> <span class="o">=</span> <span class="o">(</span><span class="n">Account</span><span class="o">)</span> <span class="n">request</span><span class="o">.</span><span class="na">getAttribute</span><span class="o">(</span><span class="s">"account"</span><span class="o">);</span>
<span class="c1">//account will be null if the request is not associated with a known user account.</span>
</pre></div>
</div>
<p>Why two attribute names for the same object?</p>
<p>When writing view templates, it is often easier to reference a request attribute by a simple name rather than being required to import a Class or use the class’s fully qualified name. For example, consider a the following <a class="reference external" href="http://docs.oracle.com/javaee/1.4/tutorial/doc/JSPIntro7.html">JSP Expression Language</a> example:</p>
<div class="highlight-jsp"><div class="highlight"><pre><span></span>Hello, ${requestScope.account.givenName}! Nice to see you again!
</pre></div>
</div>
<p>Without the simpler attribute name, you would have to do something like this:</p>
<div class="highlight-jsp"><div class="highlight"><pre><span></span>Hello, ${requestScope['com.stormpath.sdk.account.Account'].givenName}! Nice to see you again!
</pre></div>
</div>
<p>which is less readable and not as convenient.</p>
</div>
</div>
<div class="section" id="http-servlet-request-api">
<h3><a class="toc-backref" href="#id18">HTTP Servlet Request API</a><a class="headerlink" href="#http-servlet-request-api" title="Permalink to this headline">¶</a></h3>
<p>If you’d prefer to use the native <code class="docutils literal"><span class="pre">HttpServletRequest</span></code> API to obtain any associated account information, you can! You can call either of the two following methods:</p>
<ul class="simple">
<li>HttpServletRequest <a class="reference external" href="http://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html#getRemoteUser()">getRemoteUser()</a></li>
<li>HttpServletRequest <a class="reference external" href="http://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html#getUserPrincipal()">getUserPrincipal()</a></li>
</ul>
<p>Even better, you can customize exactly what is returned from either of these methods.</p>
<div class="section" id="httpservletrequest-getremoteuser">
<h4>HttpServletRequest getRemoteUser()<a class="headerlink" href="#httpservletrequest-getremoteuser" title="Permalink to this headline">¶</a></h4>
<p>If there is an <code class="docutils literal"><span class="pre">Account</span></code> associated with the request, invoking <code class="docutils literal"><span class="pre">request.getRemoteUser()</span></code> will return the Account’s <code class="docutils literal"><span class="pre">username</span></code> by default. If there is no associated Account, <code class="docutils literal"><span class="pre">null</span></code> is returned.</p>
<p>But you can specify what the return value should be via the <code class="docutils literal"><span class="pre">stormpath.web.request.remoteUser.strategy</span></code> configuration property:</p>
<div class="highlight-properties"><div class="highlight"><pre><span></span><span class="na">stormpath.web.request.remoteUser.strategy</span> <span class="o">=</span> <span class="s">username</span>
</pre></div>
</div>
<p>The property value may be one of the following strings: <code class="docutils literal"><span class="pre">username</span></code>, <code class="docutils literal"><span class="pre">email</span></code>, <code class="docutils literal"><span class="pre">givenName</span></code>, <code class="docutils literal"><span class="pre">href</span></code>, or <code class="docutils literal"><span class="pre">bypass</span></code>:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">username</span></code>: <code class="docutils literal"><span class="pre">getRemoteUser()</span></code> will return the Account’s username, <code class="docutils literal"><span class="pre">account.getUsername()</span></code>.</li>
<li><code class="docutils literal"><span class="pre">email</span></code>: returns <code class="docutils literal"><span class="pre">account.getEmail()</span></code></li>
<li><code class="docutils literal"><span class="pre">givenName</span></code>: returns <code class="docutils literal"><span class="pre">account.getGivenName()</span></code></li>
<li><code class="docutils literal"><span class="pre">href</span></code>: returns <code class="docutils literal"><span class="pre">account.getHref()</span></code></li>
<li><code class="docutils literal"><span class="pre">bypass</span></code>: disables the behavior for this method and delegates to the Servlet Container implementation.</li>
</ul>
<p>Again, if there is no Account associated with the request, <code class="docutils literal"><span class="pre">getRemoteUser()</span></code> will return <code class="docutils literal"><span class="pre">null</span></code>.</p>
</div>
<div class="section" id="httpservletrequest-getuserprincipal">
<h4>HttpServletRequest getUserPrincipal()<a class="headerlink" href="#httpservletrequest-getuserprincipal" title="Permalink to this headline">¶</a></h4>
<p>If there is an <code class="docutils literal"><span class="pre">Account</span></code> associated with the request, invoking <code class="docutils literal"><span class="pre">request.getUserPrincipal()</span></code> will return a <code class="docutils literal"><span class="pre">java.security.Principal</span></code> instance that reflects the associated Account. If there is no associated <code class="docutils literal"><span class="pre">Account</span></code>, <code class="docutils literal"><span class="pre">null</span></code> is returned.</p>
<p>If there is an account, by default, an instance of <code class="docutils literal"><span class="pre">com.stormpath.sdk.servlet.http.AccountPrincipal</span></code> is returned. This allows you to get the Account object directly by invoking <code class="docutils literal"><span class="pre">accountPrincipal.getAccount()</span></code>.</p>
<p>But you can specify what type of <code class="docutils literal"><span class="pre">Principal</span></code> implementation is returned via the <code class="docutils literal"><span class="pre">stormpath.web.request.userPrincipal.strategy</span></code> configuration property:</p>
<div class="highlight-properties"><div class="highlight"><pre><span></span><span class="na">stormpath.web.request.userPrincipal.strategy</span> <span class="o">=</span> <span class="s">account</span>
</pre></div>
</div>
<p>The property value may be one of the following strings: <code class="docutils literal"><span class="pre">account</span></code>, <code class="docutils literal"><span class="pre">email</span></code>, <code class="docutils literal"><span class="pre">username</span></code>, <code class="docutils literal"><span class="pre">givenName</span></code>, <code class="docutils literal"><span class="pre">href</span></code>, <code class="docutils literal"><span class="pre">bypass</span></code>:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">account</span></code>: <code class="docutils literal"><span class="pre">getUserPrincipal()</span></code> returns a <code class="docutils literal"><span class="pre">com.stormpath.sdk.servlet.http.AccountPrincipal</span></code> that represents the entire <code class="docutils literal"><span class="pre">Account</span></code> object</li>
<li><code class="docutils literal"><span class="pre">email</span></code>: returns a <code class="docutils literal"><span class="pre">com.stormpath.sdk.servlet.http.EmailPrincipal</span></code> matching <code class="docutils literal"><span class="pre">account.getEmail()</span></code>.</li>
<li><code class="docutils literal"><span class="pre">username</span></code>: returns a <code class="docutils literal"><span class="pre">com.stormpath.sdk.servlet.http.UsernamePrincipal</span></code> matching <code class="docutils literal"><span class="pre">account.getUsername()</span></code>.</li>
<li><code class="docutils literal"><span class="pre">givenname</span></code>: returns a <code class="docutils literal"><span class="pre">com.stormpath.sdk.servlet.http.GivenNamePrincipal</span></code> matching <code class="docutils literal"><span class="pre">account.getGivenName()</span></code>.</li>
<li><code class="docutils literal"><span class="pre">href</span></code>: returns a <code class="docutils literal"><span class="pre">com.stormpath.sdk.servlet.http.HrefPrincipal</span></code> matching <code class="docutils literal"><span class="pre">account.getHref()</span></code>.</li>
<li><code class="docutils literal"><span class="pre">bypass</span></code>: disables the behavior for this method and delegates to the Servlet Container implementation.</li>
</ul>
<p>Again, if there is no Account associated with the request, <code class="docutils literal"><span class="pre">getUserPrincipal()</span></code> will return <code class="docutils literal"><span class="pre">null</span></code>.</p>
</div>
</div>
</div>
<div class="section" id="stormpath-application">
<span id="request-application"></span><h2><a class="toc-backref" href="#id10">Stormpath Application</a><a class="headerlink" href="#stormpath-application" title="Permalink to this headline">¶</a></h2>
<p>The Stormpath Java Servlet Plugin requires that your application correspond to a registered <code class="docutils literal"><span class="pre">Application</span></code> record within Stormpath. You can access this <code class="docutils literal"><span class="pre">Application</span></code> for your own needs (for example, searching your application’s user accounts, creating groups, etc.) using Spring autowiring, an <code class="docutils literal"><span class="pre">ApplicationResolver</span></code> or request attributes.</p>
<div class="section" id="application-resolver">
<h3><a class="toc-backref" href="#id11">Application Resolver</a><a class="headerlink" href="#application-resolver" title="Permalink to this headline">¶</a></h3>
<p>A type-safe way to lookup the <code class="docutils literal"><span class="pre">Application</span></code> instance is to use the <code class="docutils literal"><span class="pre">ApplicationResolver</span></code>:</p>
<div class="highlight-java"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">com.stormpath.sdk.servlet.application.ApplicationResolver</span><span class="o">;</span>
<span class="c1">//...</span>
<span class="n">Application</span> <span class="n">myApp</span> <span class="o">=</span> <span class="n">ApplicationResolver</span><span class="o">.</span><span class="na">INSTANCE</span><span class="o">.</span><span class="na">getApplication</span><span class="o">(</span><span class="n">request</span><span class="o">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id2">
<h3><a class="toc-backref" href="#id12">Request Attributes</a><a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
<p>While request attribute lookups are not type-safe (<code class="docutils literal"><span class="pre">String</span></code> keys and <code class="docutils literal"><span class="pre">Object</span></code> return types), they can be convenient or preferred in some situations.</p>
<div class="section" id="default-request-attribute-name">
<h4>Default Request Attribute Name<a class="headerlink" href="#default-request-attribute-name" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal"><span class="pre">Application</span></code> will always be available under the request attribute key equal to the <code class="docutils literal"><span class="pre">Application</span></code> interface’s fully qualified class name. For example:</p>
<div class="highlight-java"><div class="highlight"><pre><span></span><span class="n">Application</span> <span class="n">myApp</span> <span class="o">=</span> <span class="o">(</span><span class="n">Application</span><span class="o">)</span> <span class="n">request</span><span class="o">.</span><span class="na">getAttribute</span><span class="o">(</span><span class="n">Application</span><span class="o">.</span><span class="na">getClass</span><span class="o">().</span><span class="na">getName</span><span class="o">());</span>
</pre></div>
</div>
</div>
<div class="section" id="custom-request-attribute-names">
<h4>Custom Request Attribute Names<a class="headerlink" href="#custom-request-attribute-names" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal"><span class="pre">Application</span></code> is also available via simpler unqualified attribute names for convenience. For example, the default convenience attribute name key is just <code class="docutils literal"><span class="pre">application</span></code>. This allows the exact same Application lookup above to be done like this:</p>
<div class="highlight-java"><div class="highlight"><pre><span></span><span class="n">Application</span> <span class="n">myApp</span> <span class="o">=</span> <span class="o">(</span><span class="n">Application</span><span class="o">)</span> <span class="n">request</span><span class="o">.</span><span class="na">getAttribute</span><span class="o">(</span><span class="s">"application"</span><span class="o">);</span>
</pre></div>
</div>
<p>If you want to change this name, or add other names, you can change the <code class="docutils literal"><span class="pre">stormpath.web.request.application.attributeNames</span></code> configuration property and set a comma-delimited list of names. For example:</p>
<div class="highlight-properties"><div class="highlight"><pre><span></span><span class="na">stormpath.web.request.application.attributeNames</span> <span class="o">=</span> <span class="s">app, application, stormpathApplication, stormpathApp</span>
</pre></div>
</div>
<p>Why is this supported?</p>
<p>When writing view templates, it is often easier to reference a request attribute by a simple name rather than being required to import a Class or use the class’s fully qualified name. For example, consider a the following <a class="reference external" href="http://docs.oracle.com/javaee/1.4/tutorial/doc/JSPIntro7.html">JSP Expression Language</a> example:</p>
<div class="highlight-jsp"><div class="highlight"><pre><span></span>My application name is: ${requestScope.application.name}.
</pre></div>
</div>
<p>Without these simpler attribute names, you would have to do something like this:</p>
<div class="highlight-jsp"><div class="highlight"><pre><span></span>My application name is: ${requestScope['com.stormpath.sdk.application.Application'].name}.
</pre></div>
</div>
<p>which is less readable and not very convenient.</p>
</div>
</div>
</div>
<div class="section" id="stormpath-client">
<span id="request-sdk-client"></span><h2><a class="toc-backref" href="#id13">Stormpath Client</a><a class="headerlink" href="#stormpath-client" title="Permalink to this headline">¶</a></h2>
<p>The Stormpath Java Servlet Plugin uses a Stormpath <code class="docutils literal"><span class="pre">Client</span></code> for all communication to Stormpath. You can access this <code class="docutils literal"><span class="pre">Client</span></code> for your own needs using either the <code class="docutils literal"><span class="pre">ClientResolver</span></code> or request attributes.</p>
<div class="section" id="client-resolver">
<h3><a class="toc-backref" href="#id14">Client Resolver</a><a class="headerlink" href="#client-resolver" title="Permalink to this headline">¶</a></h3>
<p>If you want to look up the Client using only the HttpServletRequest, you can do so in a type-safe way using the <code class="docutils literal"><span class="pre">ClientResolver</span></code>:</p>
<div class="highlight-java"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">com.stormpath.sdk.servlet.client.ClientResolver</span><span class="o">;</span>
<span class="c1">//...</span>
<span class="n">Client</span> <span class="n">client</span> <span class="o">=</span> <span class="n">ClientResolver</span><span class="o">.</span><span class="na">INSTANCE</span><span class="o">.</span><span class="na">getClient</span><span class="o">(</span><span class="n">request</span><span class="o">);</span>
</pre></div>
</div>
</div>
<div class="section" id="id3">
<h3><a class="toc-backref" href="#id15">Request Attributes</a><a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<p>While request attribute lookups are not type-safe (<code class="docutils literal"><span class="pre">String</span></code> keys and <code class="docutils literal"><span class="pre">Object</span></code> return types), they can be convenient or preferred in some situations.</p>
<div class="section" id="id4">
<h4>Default Request Attribute Name<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal"><span class="pre">Client</span></code> will always be available under the request attribute key equal to the <code class="docutils literal"><span class="pre">Client</span></code> interface’s fully qualified class name. For example:</p>
<div class="highlight-java"><div class="highlight"><pre><span></span><span class="n">Client</span> <span class="n">client</span> <span class="o">=</span> <span class="o">(</span><span class="n">Client</span><span class="o">)</span> <span class="n">request</span><span class="o">.</span><span class="na">getAttribute</span><span class="o">(</span><span class="n">Client</span><span class="o">.</span><span class="na">getClass</span><span class="o">().</span><span class="na">getName</span><span class="o">());</span>
</pre></div>
</div>
</div>
<div class="section" id="id5">
<h4>Custom Request Attribute Names<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal"><span class="pre">Client</span></code> is also available via simpler unqualified attribute names for convenience. For example, the default convenience attribute name key is just <code class="docutils literal"><span class="pre">client</span></code>. This allows the exact same Client lookup above to be done like this:</p>
<div class="highlight-java"><div class="highlight"><pre><span></span><span class="n">Client</span> <span class="n">client</span> <span class="o">=</span> <span class="o">(</span><span class="n">Client</span><span class="o">)</span> <span class="n">request</span><span class="o">.</span><span class="na">getAttribute</span><span class="o">(</span><span class="s">"client"</span><span class="o">);</span>
</pre></div>
</div>
<p>If you want to change this name, or add other names, you can change the <code class="docutils literal"><span class="pre">stormpath.web.request.client.attributeNames</span></code> configuration property and set a comma-delimited list of names. For example:</p>
<div class="highlight-properties"><div class="highlight"><pre><span></span><span class="na">stormpath.web.request.client.attributeNames</span> <span class="o">=</span> <span class="s">client, stormpathClient, awesomeStormpathClient</span>
</pre></div>
</div>
<p>Why is this supported?</p>
<p>When writing view templates, it is often easier to reference a request attribute by a simple name rather than being required to import a Class or use the class’s fully qualified name. For example, consider a the following <a class="reference external" href="http://docs.oracle.com/javaee/1.4/tutorial/doc/JSPIntro7.html">JSP Expression Language</a> example:</p>
<div class="highlight-jsp"><div class="highlight"><pre><span></span>My Stormpath tenant name is: ${requestScope.client.currentTenant.name}.
</pre></div>
</div>
<p>Without these simpler attribute names, you would have to do something like this:</p>
<div class="highlight-jsp"><div class="highlight"><pre><span></span>My Stormpath tenant name is: ${requestScope['com.stormpath.sdk.client.Client'].currentTenant.name}.
</pre></div>
</div>
<p>which is less readable and not very convenient.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="access-control.html" class="btn btn-neutral float-right" title="Access Control" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="request-authentication.html" class="btn btn-neutral" title="HTTP Request Authentication" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, Stormpath, Inc.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.5.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
You can’t perform that action at this time.