{{ 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 pathviews.html
More file actions
698 lines (575 loc) · 47.2 KB
/
Copy pathviews.html
File metadata and controls
698 lines (575 loc) · 47.2 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
<!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>Custom Views — 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="Appendix" href="appendix.html"/>
<link rel="prev" title="ID Site" href="idsite.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"><a class="reference internal" href="request.html">Request Context</a><ul>
<li class="toctree-l2"><a class="reference internal" href="request.html#current-user-account">Current User Account</a><ul>
<li class="toctree-l3"><a class="reference internal" href="request.html#account-resolver">Account Resolver</a></li>
<li class="toctree-l3"><a class="reference internal" href="request.html#request-attributes">Request Attributes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="request.html#request-attribute-names">Request Attribute Names</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="request.html#http-servlet-request-api">HTTP Servlet Request API</a><ul>
<li class="toctree-l4"><a class="reference internal" href="request.html#httpservletrequest-getremoteuser">HttpServletRequest getRemoteUser()</a></li>
<li class="toctree-l4"><a class="reference internal" href="request.html#httpservletrequest-getuserprincipal">HttpServletRequest getUserPrincipal()</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="request.html#stormpath-application">Stormpath Application</a><ul>
<li class="toctree-l3"><a class="reference internal" href="request.html#application-resolver">Application Resolver</a></li>
<li class="toctree-l3"><a class="reference internal" href="request.html#id2">Request Attributes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="request.html#default-request-attribute-name">Default Request Attribute Name</a></li>
<li class="toctree-l4"><a class="reference internal" href="request.html#custom-request-attribute-names">Custom Request Attribute Names</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="request.html#stormpath-client">Stormpath Client</a><ul>
<li class="toctree-l3"><a class="reference internal" href="request.html#client-resolver">Client Resolver</a></li>
<li class="toctree-l3"><a class="reference internal" href="request.html#id3">Request Attributes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="request.html#id4">Default Request Attribute Name</a></li>
<li class="toctree-l4"><a class="reference internal" href="request.html#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 current"><a class="current reference internal" href="#">Custom Views</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#jsp-views">JSP Views</a></li>
<li class="toctree-l2"><a class="reference internal" href="#css">CSS</a></li>
<li class="toctree-l2"><a class="reference internal" href="#internationalization-i18n">Internationalization (i18n)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#change-a-default-view">Change a Default View</a></li>
<li class="toctree-l2"><a class="reference internal" href="#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>Custom Views</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="custom-views">
<span id="views"></span><h1>Custom Views<a class="headerlink" href="#custom-views" title="Permalink to this headline">¶</a></h1>
<p>The Stormpath Java Servlet Plugin provides out-of-the-box template files to render views at supported URIs, like <code class="docutils literal"><span class="pre">/login</span></code>, <code class="docutils literal"><span class="pre">/register</span></code>, etc. This page documents how you can easily customize or completely replace the views to have your own look and feel.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p>This page discusses templates for views that are local only to the application where the Stormpath Java Servlet Plugin is enabled.</p>
<p class="last">If you have multiple applications that need a unified registration, login (SSO - Single Sign On) and forgot-password experience, please see the <a class="reference internal" href="idsite.html#idsite"><span class="std std-ref">ID Site section</span></a> instead.</p>
</div>
<p>All of the default built-in views are all based on the same principle: they are a standard html templates styled with shared <a class="reference external" href="http://getbootstrap.com/">Bootstrap</a> CSS. Internationalization (i18n) is used to represent text on all default views so you can provide a nice translated view for each user based on their locale. CSS styles control the view look and feel.</p>
<div class="section" id="jsp-views">
<h2>JSP Views<a class="headerlink" href="#jsp-views" title="Permalink to this headline">¶</a></h2>
<p>The default views are JSPs rendered based on a common page template. The template itself is also a JSP, but represented as a tag library - no 3rd party template libraries are required. This tag library is included in the Stormpath Java Servlet Plugin and available to any JSP view in your project.</p>
<p>A JSP view that should be rendered based on this template should reference this template tag library at the top of the JSP:</p>
<div class="highlight-jsp"><div class="highlight"><pre><span></span><span class="k"><%@</span> <span class="n">taglib</span> <span class="n">prefix</span><span class="o">=</span><span class="s">"t"</span> <span class="n">uri</span><span class="o">=</span><span class="s">"http://stormpath.com/jsp/tags/templates"</span> <span class="k">%></span>
</pre></div>
</div>
<p>And the page might be defined as follows:</p>
<div class="highlight-jsp"><div class="highlight"><pre><span></span><span class="k"><%@</span> <span class="n">page</span> <span class="n">contentType</span><span class="o">=</span><span class="s">"text/html;charset=UTF-8"</span> <span class="n">pageEncoding</span><span class="o">=</span><span class="s">"UTF-8"</span> <span class="k">%></span>
<span class="k"><%@</span> <span class="n">taglib</span> <span class="n">prefix</span><span class="o">=</span><span class="s">"t"</span> <span class="n">uri</span><span class="o">=</span><span class="s">"http://stormpath.com/jsp/tags/templates"</span> <span class="k">%></span>
<span class="k"><%@</span> <span class="n">taglib</span> <span class="n">prefix</span><span class="o">=</span><span class="s">"sp"</span> <span class="n">uri</span><span class="o">=</span><span class="s">"http://stormpath.com/jsp/tags"</span> <span class="k">%></span>
<span class="k"><%-</span><span class="o">-</span> <span class="n">Any</span> <span class="n">other</span> <span class="n">taglibs</span><span class="o">,</span> <span class="n">like</span> <span class="n">the</span> <span class="n">core</span> <span class="sc">'c'</span> <span class="n">library</span><span class="o">,</span> <span class="n">etc</span><span class="o">:</span> <span class="o">--</span><span class="k">%></span>
<span class="nt"><t:page></span>
<span class="nt"><jsp:attribute</span> <span class="na">name=</span><span class="s">"title"</span><span class="nt">></span><span class="c"><!-- Optional title to go in the doc's <meta> section --></span><span class="nt"></jsp:attribute></span>
<span class="nt"><jsp:attribute</span> <span class="na">name=</span><span class="s">"bodyCssClass"</span><span class="nt">></span><span class="c"><!-- Optional CSS class to apply to the <body> element --></span><span class="nt"></jsp:attribute></span>
<span class="nt"><jsp:body></span>
<span class="c"><!-- Place your page content here: --></span>
<span class="nt"></jsp:body></span>
<span class="nt"></t:page></span>
</pre></div>
</div>
<p>Anything within the <code class="docutils literal"><span class="pre"><jsp:body></span> <span class="pre"></jsp:body></span></code> element will be ‘wrapped’ by the <a class="reference internal" href="#view-template"><span class="std std-ref">page template</span></a>.</p>
</div>
<div class="section" id="css">
<h2>CSS<a class="headerlink" href="#css" title="Permalink to this headline">¶</a></h2>
<p>Views are styled based on CSS files referenced in the view template. Because each view is decorated by the template, the view is styled based on the definitions in these CSS files:</p>
<div class="highlight-jsp"><div class="highlight"><pre><span></span><span class="nt"><link</span> <span class="na">href=</span><span class="s">"${pageContext.request.contextPath}/assets/css/stormpath.css"</span> <span class="na">rel=</span><span class="s">"stylesheet"</span><span class="nt">></span>
<span class="nt"><link</span> <span class="na">href=</span><span class="s">"${pageContext.request.contextPath}/assets/css/custom.stormpath.css"</span> <span class="na">rel=</span><span class="s">"stylesheet"</span><span class="nt">></span>
</pre></div>
</div>
<p>If you wish to easily override only a few styles, it’s easiest to re-create the <code class="docutils literal"><span class="pre">custom.stormpath.css</span></code> in your own project at the following <em>exact</em> .war path and file name:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>/assets/css/custom.stormpath.css
</pre></div>
</div>
<p>If this file is present in your .war, it will override the plugin default file. You can re-define any definitions you find in the base <code class="docutils literal"><span class="pre">stormpath.css</span></code> file and those will override the defaults in <code class="docutils literal"><span class="pre">stormpath.css</span></code>.</p>
<p>If you have a lot of CSS changes, you may wish to re-define the <code class="docutils literal"><span class="pre">stormpath.css</span></code> file entirely. Just create the following file in your project at the following <em>exact</em> .war path and file name:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>/assets/css/stormpath.css
</pre></div>
</div>
<p>If this file is present in your .war, it will override the plugin default file.</p>
<p>Finally, if this proves too cumbersome or you just want total control, you might want to define your own <a class="reference internal" href="#view-template">view template</a> and reference your own CSS file in the template and ignore any of the plugin default css files.</p>
</div>
<div class="section" id="internationalization-i18n">
<h2>Internationalization (i18n)<a class="headerlink" href="#internationalization-i18n" title="Permalink to this headline">¶</a></h2>
<p>All of the Stormpath Java Servlet Plugin default views are internationalized to support language translation based on the end-user’s locale.</p>
<p>In addition to the page template tag library, a regular tag library is included in the plugin and may be used to automatically render i18n messages based on the the <code class="docutils literal"><span class="pre">com.stormpath.sdk.servlet.i18n</span></code> message resource bundle. You can use the taglib in a jsp by referencing <code class="docutils literal"><span class="pre"><%@</span> <span class="pre">taglib</span> <span class="pre">prefix="sp"</span> <span class="pre">uri="http://stormpath.com/jsp/tags"</span> <span class="pre">%></span></code> at the top of your JSP file.</p>
<p>For example:</p>
<div class="highlight-jsp"><div class="highlight"><pre><span></span><span class="k"><%@</span> <span class="n">page</span> <span class="n">contentType</span><span class="o">=</span><span class="s">"text/html;charset=UTF-8"</span> <span class="n">pageEncoding</span><span class="o">=</span><span class="s">"UTF-8"</span> <span class="k">%></span>
<span class="k"><%@</span> <span class="n">taglib</span> <span class="n">prefix</span><span class="o">=</span><span class="s">"c"</span> <span class="n">uri</span><span class="o">=</span><span class="s">"http://java.sun.com/jsp/jstl/core"</span> <span class="k">%></span>
<span class="k"><%@</span> <span class="n">taglib</span> <span class="n">prefix</span><span class="o">=</span><span class="s">"t"</span> <span class="n">uri</span><span class="o">=</span><span class="s">"http://stormpath.com/jsp/tags/templates"</span> <span class="k">%></span>
<span class="k"><%@</span> <span class="n">taglib</span> <span class="n">prefix</span><span class="o">=</span><span class="s">"sp"</span> <span class="n">uri</span><span class="o">=</span><span class="s">"http://stormpath.com/jsp/tags"</span> <span class="k">%></span>
<span class="nt"><t:page></span>
<span class="nt"><jsp:attribute</span> <span class="na">name=</span><span class="s">"title"</span><span class="nt">><sp:message</span> <span class="na">key=</span><span class="s">"stormpath.web.login.title"</span><span class="nt">/></jsp:attribute></span>
<span class="nt"><jsp:attribute</span> <span class="na">name=</span><span class="s">"bodyCssClass"</span><span class="nt">></span>login<span class="nt"></jsp:attribute></span>
<span class="nt"><jsp:body></span>
<span class="nt"><h1><sp:message</span> <span class="na">key=</span><span class="s">"stormpath.web.login.title"</span><span class="nt">/></h1></span>
<span class="nt"></jsp:body></span>
<span class="nt"></t:page></span>
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre"><sp:message></span></code> tag works just like the standard template library’s <code class="docutils literal"><span class="pre"><fmt:message></span></code> tag, but <code class="docutils literal"><span class="pre"><sp:message></span></code> will automatically use the <code class="docutils literal"><span class="pre">com.stormpath.sdk.servlet.i18n</span></code> message bundle in addition to allowing for a flexible locale resolution strategy in your <code class="docutils literal"><span class="pre">stormpath.properties</span></code> configuration.</p>
<p>If you wish to see all of the predefined message keys available, as well as more information about i18n message value resolution, please see the <a class="reference internal" href="i18n.html#i18n"><span class="std std-ref">Internationalization (i18n)</span></a> page.</p>
</div>
<div class="section" id="change-a-default-view">
<span id="default-view-files-jsp"></span><h2>Change a Default View<a class="headerlink" href="#change-a-default-view" title="Permalink to this headline">¶</a></h2>
<p>If you want to change the structure of any of the included default JSP views, you must redefine them (copy and paste them) in your own project in the following <em>exact</em> .war file locations:</p>
<table border="1" class="docutils">
<colgroup>
<col width="15%" />
<col width="38%" />
<col width="46%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Default URI</th>
<th class="head">Description</th>
<th class="head">War File Location</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>/login</td>
<td>Login View</td>
<td>/WEB-INF/jsp/stormpath/login.jsp</td>
</tr>
<tr class="row-odd"><td>/forgot</td>
<td>Forgot Password Workflow Start</td>
<td>/WEB-INF/jsp/stormpath/forgot.jsp</td>
</tr>
<tr class="row-even"><td>/change</td>
<td>Forgot Password Set New Password</td>
<td>/WEB-INF/jsp/stormpath/change.jsp</td>
</tr>
<tr class="row-odd"><td>/register</td>
<td>New user / registration view</td>
<td>/WEB-INF/jsp/stormpath/register.jsp</td>
</tr>
<tr class="row-even"><td>/verify</td>
<td>New user please check email view</td>
<td>/WEB-INF/jsp/stormpath/verify.jsp</td>
</tr>
<tr class="row-odd"><td>/unauthorized</td>
<td>Unauthorized access view</td>
<td>/WEB-INF/jsp/stormpath/unauthorized.jsp</td>
</tr>
</tbody>
</table>
<p>If you re-define any of these files at the exact same respective path in your .war project, that file will be used to render the view instead of the plugin file.</p>
</div>
<div class="section" id="view-template">
<span id="id1"></span><h2>View Template<a class="headerlink" href="#view-template" title="Permalink to this headline">¶</a></h2>
<p>Unfortunately the convenient override mechanism where you simply just replace a plugin default file with your own does not work with JSP tag-based templates. This means that if you want to use your own page template for the plugin’s views, you will need to replace <em>all</em> of the plugin’s default view files. But the good news is that there are only 6 view files, and they can mostly be copied-and-pasted, so it shouldn’t take too long (5 to 10 minutes?).</p>
<p>If you do wish to use your own page template, here is how:</p>
<ol class="arabic" id="custom-template-tld">
<li><p class="first">Create a new <code class="docutils literal"><span class="pre">/META-INF/templates.tld</span></code> file in your .war project with the following contents:</p>
<div class="highlight-xml"><div class="highlight"><pre><span></span><span class="cp"><?xml version="1.0" encoding="UTF-8" ?></span>
<span class="nt"><taglib</span> <span class="na">xmlns=</span><span class="s">"http://java.sun.com/xml/ns/javaee"</span>
<span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span>
<span class="na">xsi:schemaLocation=</span><span class="s">"http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-jsptaglibrary_2_1.xsd"</span>
<span class="na">version=</span><span class="s">"2.1"</span><span class="nt">></span>
<span class="nt"><tlib-version></span>1.0<span class="nt"></tlib-version></span> <span class="c"><!-- whatever version your application is --></span>
<span class="nt"><short-name></span>myAppPageTemplate<span class="nt"></short-name></span> <span class="c"><!-- any name will do --></span>
<span class="nt"><uri></span>http://mycompany.com/myapp/jsp/tags/templates<span class="nt"></uri></span> <span class="c"><!-- Does not need to resolve to a real view --></span>
<span class="nt"><tag-file></span>
<span class="nt"><name></span>page<span class="nt"></name></span>
<span class="nt"><path></span>/META-INF/tags/page.tag<span class="nt"></path></span>
<span class="nt"></tag-file></span>
<span class="nt"></taglib></span>
</pre></div>
</div>
</li>
<li><p class="first">Create a new <code class="docutils literal"><span class="pre">/META-INF/tags/page.tag</span></code> file in your .war project with your view template markup. Although this has a <code class="docutils literal"><span class="pre">.tag</span></code> suffix, this is just a standard JSP file. Here is a basic template example you can use to start:</p>
<div class="highlight-jsp"><div class="highlight"><pre><span></span><span class="k"><%@</span><span class="n">tag</span> <span class="n">description</span><span class="o">=</span><span class="s">"My App page template"</span> <span class="n">pageEncoding</span><span class="o">=</span><span class="s">"UTF-8"</span><span class="k">%></span>
<span class="k"><%@</span><span class="n">taglib</span> <span class="n">uri</span><span class="o">=</span><span class="s">"http://java.sun.com/jsp/jstl/core"</span> <span class="n">prefix</span><span class="o">=</span><span class="s">"c"</span><span class="k">%></span>
<span class="k"><%-</span><span class="o">-</span> <span class="n">Any</span> <span class="n">other</span> <span class="n">taglibs</span> <span class="o">--</span><span class="k">%></span>
<span class="k"><%@</span><span class="n">attribute</span> <span class="n">name</span><span class="o">=</span><span class="s">"title"</span> <span class="n">required</span><span class="o">=</span><span class="s">"false"</span> <span class="k">%></span>
<span class="k"><%-</span><span class="o">-</span> <span class="n">Any</span> <span class="n">other</span> <span class="n">attributes</span> <span class="n">referenced</span> <span class="n">in</span> <span class="k">this</span> <span class="n">template</span> <span class="o">--</span><span class="k">%></span>
<span class="cp"><!DOCTYPE html></span>
<span class="nt"><html></span>
<span class="nt"><head></span>
<span class="nt"><meta</span> <span class="na">charset=</span><span class="s">"utf-8"</span><span class="nt">></span>
<span class="nt"><title><c:out</span> <span class="na">value=</span><span class="s">"${!empty title ? title : ''}"</span><span class="nt">/></title></span>
<span class="nt"><link</span> <span class="na">href=</span><span class="s">"${pageContext.request.contextPath}/assets/css/style.css"</span> <span class="na">rel=</span><span class="s">"stylesheet"</span><span class="nt">></span>
<span class="nt"></head></span>
<span class="nt"><body></span>
<span class="nt"><jsp:doBody/></span>
<span class="nt"></body></span>
<span class="nt"></html></span>
</pre></div>
</div>
<p>The important points to note:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre"><%@tag</span> <span class="pre">description="My</span> <span class="pre">App</span> <span class="pre">page</span> <span class="pre">template"</span> <span class="pre">pageEncoding="UTF-8"%></span></code> must be at the top of the file</li>
<li><code class="docutils literal"><span class="pre"><jsp:doBody/></span></code> must be somewhere in the template. This will be substituted at runtime with the actual page content.</li>
<li>A <code class="docutils literal"><span class="pre">title</span></code> page attribute is supported. This can be specified in views that use the template via <code class="docutils literal"><span class="pre"><jsp:attribute</span> <span class="pre">name="title">Value</span> <span class="pre">Here</jsp:attribute></span></code></li>
</ul>
</li>
<li><p class="first">Copy and paste <a class="reference internal" href="#default-view-files-jsp"><span class="std std-ref">each stormpath default view file</span></a> to your own project at the <em>exact</em> same path as the plugin files. That is, each file <em>must</em> be in your .war’s <code class="docutils literal"><span class="pre">/WEB-INF/jsp/stormpath/</span></code> directory and they <em>must</em> have the exact same name as the original files.</p>
</li>
<li><p class="first">In each view file, you’ll need to replace the following line:</p>
<div class="highlight-jsp"><div class="highlight"><pre><span></span><span class="k"><%@</span> <span class="n">taglib</span> <span class="n">prefix</span><span class="o">=</span><span class="s">"t"</span> <span class="n">uri</span><span class="o">=</span><span class="s">"http://stormpath.com/jsp/tags/templates"</span> <span class="k">%></span>
</pre></div>
</div>
<p>with your own tag library template uri:</p>
<div class="highlight-jsp"><div class="highlight"><pre><span></span><span class="k"><%@</span> <span class="n">taglib</span> <span class="n">prefix</span><span class="o">=</span><span class="s">"t"</span> <span class="n">uri</span><span class="o">=</span><span class="s">"http://mycompany.com/myapp/jsp/tags/templates"</span> <span class="k">%></span>
</pre></div>
</div>
<p>(or whatever URI you chose when you created your <code class="docutils literal"><span class="pre">/META-INF/templates.tld</span></code> <a class="reference internal" href="#custom-template-tld"><span class="std std-ref">tag library descriptor file</span></a>).</p>
</li>
</ol>
<p>After completing these steps, all plugin views will reflect your custom template.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="appendix.html" class="btn btn-neutral float-right" title="Appendix" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="idsite.html" class="btn btn-neutral" title="ID Site" 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.