-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathdocs.html
More file actions
4657 lines (4181 loc) · 248 KB
/
docs.html
File metadata and controls
4657 lines (4181 loc) · 248 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
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 1.5.3">
<meta name="author" content="Nikolche Mihajlovski">
<title>Rapidoid Documentation</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<style>
/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
/* Remove comment around @import statement below when using as a custom stylesheet */
/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
audio,canvas,video{display:inline-block}
audio:not([controls]){display:none;height:0}
[hidden],template{display:none}
script{display:none!important}
html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
body{margin:0}
a{background:transparent}
a:focus{outline:thin dotted}
a:active,a:hover{outline:0}
h1{font-size:2em;margin:.67em 0}
abbr[title]{border-bottom:1px dotted}
b,strong{font-weight:bold}
dfn{font-style:italic}
hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
mark{background:#ff0;color:#000}
code,kbd,pre,samp{font-family:monospace;font-size:1em}
pre{white-space:pre-wrap}
q{quotes:"\201C" "\201D" "\2018" "\2019"}
small{font-size:80%}
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
sup{top:-.5em}
sub{bottom:-.25em}
img{border:0}
svg:not(:root){overflow:hidden}
figure{margin:0}
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
legend{border:0;padding:0}
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
button,input{line-height:normal}
button,select{text-transform:none}
button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
button[disabled],html input[disabled]{cursor:default}
input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
textarea{overflow:auto;vertical-align:top}
table{border-collapse:collapse;border-spacing:0}
*,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
html,body{font-size:100%}
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto}
a:hover{cursor:pointer}
img,object,embed{max-width:100%;height:auto}
object,embed{height:100%}
img{-ms-interpolation-mode:bicubic}
.left{float:left!important}
.right{float:right!important}
.text-left{text-align:left!important}
.text-right{text-align:right!important}
.text-center{text-align:center!important}
.text-justify{text-align:justify!important}
.hide{display:none}
body{-webkit-font-smoothing:antialiased}
img,object,svg{display:inline-block;vertical-align:middle}
textarea{height:auto;min-height:50px}
select{width:100%}
.center{margin-left:auto;margin-right:auto}
.spread{width:100%}
p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
a{color:#2156a5;text-decoration:underline;line-height:inherit}
a:hover,a:focus{color:#1d4b8f}
a img{border:none}
p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
p aside{font-size:.875em;line-height:1.35;font-style:italic}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
h1{font-size:2.125em}
h2{font-size:1.6875em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
h4,h5{font-size:1.125em}
h6{font-size:1em}
hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
em,i{font-style:italic;line-height:inherit}
strong,b{font-weight:bold;line-height:inherit}
small{font-size:60%;line-height:inherit}
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em}
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
ul.square{list-style-type:square}
ul.circle{list-style-type:circle}
ul.disc{list-style-type:disc}
ul.no-bullet{list-style:none}
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
dl dt{margin-bottom:.3125em;font-weight:bold}
dl dd{margin-bottom:1.25em}
abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
abbr{text-transform:none}
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
blockquote cite:before{content:"\2014 \0020"}
blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
@media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
h1{font-size:2.75em}
h2{font-size:2.3125em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
h4{font-size:1.4375em}}
table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
table thead,table tfoot{background:#f7f8f7;font-weight:bold}
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
body{tab-size:4}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
.clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
.clearfix:after,.float-group:after{clear:both}
*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
.keyseq{color:rgba(51,51,51,.8)}
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
.keyseq kbd:first-child{margin-left:0}
.keyseq kbd:last-child{margin-right:0}
.menuseq,.menu{color:rgba(0,0,0,.8)}
b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
b.button:before{content:"[";padding:0 3px 0 2px}
b.button:after{content:"]";padding:0 2px 0 3px}
p a>code:hover{color:rgba(0,0,0,.9)}
#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
#header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
#header:after,#content:after,#footnotes:after,#footer:after{clear:both}
#content{margin-top:1.25em}
#content:before{content:none}
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
#header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
#header .details span:first-child{margin-left:-.125em}
#header .details span.email a{color:rgba(0,0,0,.85)}
#header .details br{display:none}
#header .details br+span:before{content:"\00a0\2013\00a0"}
#header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
#header .details br+span#revremark:before{content:"\00a0|\00a0"}
#header #revnumber{text-transform:capitalize}
#header #revnumber:after{content:"\00a0"}
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
#toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
#toc>ul{margin-left:.125em}
#toc ul.sectlevel0>li>a{font-style:italic}
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
#toc li{line-height:1.3334;margin-top:.3334em}
#toc a{text-decoration:none}
#toc a:active{text-decoration:underline}
#toctitle{color:#7a2518;font-size:1.2em}
@media only screen and (min-width:768px){#toctitle{font-size:1.375em}
body.toc2{padding-left:15em;padding-right:0}
#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
body.toc2.toc-right{padding-left:0;padding-right:15em}
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
#toc.toc2{width:20em}
#toc.toc2 #toctitle{font-size:1.375em}
#toc.toc2>ul{font-size:.95em}
#toc.toc2 ul ul{padding-left:1.25em}
body.toc2.toc-right{padding-left:0;padding-right:20em}}
#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
#content #toc>:first-child{margin-top:0}
#content #toc>:last-child{margin-bottom:0}
#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
#footer-text{color:rgba(255,255,255,.8);line-height:1.44}
.sect1{padding-bottom:.625em}
@media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}
.sect1+.sect1{border-top:1px solid #efefed}
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
#content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
.admonitionblock>table td.icon{text-align:center;width:80px}
.admonitionblock>table td.icon img{max-width:none}
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
.exampleblock>.content>:first-child{margin-top:0}
.exampleblock>.content>:last-child{margin-bottom:0}
.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
.sidebarblock>:first-child{margin-top:0}
.sidebarblock>:last-child{margin-bottom:0}
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
@media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
.listingblock pre.highlightjs{padding:0}
.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
.listingblock pre.prettyprint{border-width:0}
.listingblock>.content{position:relative}
.listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
.listingblock:hover code[data-lang]:before{display:block}
.listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
.listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
table.pyhltable td.code{padding-left:.75em;padding-right:0}
pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
pre.pygments .lineno{display:inline-block;margin-right:.25em}
table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
.quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
.quoteblock blockquote{margin:0;padding:0;border:0}
.quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
.quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
.quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
.quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
.quoteblock .quoteblock blockquote:before{display:none}
.verseblock{margin:0 1em 1.25em 1em}
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
.verseblock pre strong{font-weight:400}
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
.quoteblock .attribution br,.verseblock .attribution br{display:none}
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
.quoteblock.abstract{margin:0 0 1.25em 0;display:block}
.quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
.quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
table.tableblock{max-width:100%;border-collapse:separate}
table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0}
table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0}
table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0}
table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0}
table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0}
table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0}
table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0}
table.frame-all{border-width:1px}
table.frame-sides{border-width:0 1px}
table.frame-topbot{border-width:1px 0}
th.halign-left,td.halign-left{text-align:left}
th.halign-right,td.halign-right{text-align:right}
th.halign-center,td.halign-center{text-align:center}
th.valign-top,td.valign-top{vertical-align:top}
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
th.valign-middle,td.valign-middle{vertical-align:middle}
table thead th,table tfoot th{font-weight:bold}
tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
p.tableblock>code:only-child{background:none;padding:0}
p.tableblock{font-size:1em}
td>div.verse{white-space:pre}
ol{margin-left:1.75em}
ul li ol{margin-left:1.5em}
dl dd{margin-left:1.125em}
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none}
ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em}
ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em}
ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px}
ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
ul.inline>li>*{display:block}
.unstyled dl dt{font-weight:400;font-style:normal}
ol.arabic{list-style-type:decimal}
ol.decimal{list-style-type:decimal-leading-zero}
ol.loweralpha{list-style-type:lower-alpha}
ol.upperalpha{list-style-type:upper-alpha}
ol.lowerroman{list-style-type:lower-roman}
ol.upperroman{list-style-type:upper-roman}
ol.lowergreek{list-style-type:lower-greek}
.hdlist>table,.colist>table{border:0;background:none}
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
.colist>table tr>td:first-of-type{padding:0 .75em;line-height:1}
.colist>table tr>td:last-of-type{padding:.25em 0}
.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
.imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
.imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
.imageblock>.title{margin-bottom:0}
.imageblock.thumb,.imageblock.th{border-width:6px}
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
.image.left{margin-right:.625em}
.image.right{margin-left:.625em}
a.image{text-decoration:none;display:inline-block}
a.image object{pointer-events:none}
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
sup.footnote a,sup.footnoteref a{text-decoration:none}
sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em}
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
#footnotes .footnote:last-of-type{margin-bottom:0}
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
.gist .file-data>table td.line-data{width:99%}
div.unbreakable{page-break-inside:avoid}
.big{font-size:larger}
.small{font-size:smaller}
.underline{text-decoration:underline}
.overline{text-decoration:overline}
.line-through{text-decoration:line-through}
.aqua{color:#00bfbf}
.aqua-background{background-color:#00fafa}
.black{color:#000}
.black-background{background-color:#000}
.blue{color:#0000bf}
.blue-background{background-color:#0000fa}
.fuchsia{color:#bf00bf}
.fuchsia-background{background-color:#fa00fa}
.gray{color:#606060}
.gray-background{background-color:#7d7d7d}
.green{color:#006000}
.green-background{background-color:#007d00}
.lime{color:#00bf00}
.lime-background{background-color:#00fa00}
.maroon{color:#600000}
.maroon-background{background-color:#7d0000}
.navy{color:#000060}
.navy-background{background-color:#00007d}
.olive{color:#606000}
.olive-background{background-color:#7d7d00}
.purple{color:#600060}
.purple-background{background-color:#7d007d}
.red{color:#bf0000}
.red-background{background-color:#fa0000}
.silver{color:#909090}
.silver-background{background-color:#bcbcbc}
.teal{color:#006060}
.teal-background{background-color:#007d7d}
.white{color:#bfbfbf}
.white-background{background-color:#fafafa}
.yellow{color:#bfbf00}
.yellow-background{background-color:#fafa00}
span.icon>.fa{cursor:default}
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
.admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
.admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
.admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
.admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
.admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
.conum[data-value] *{color:#fff!important}
.conum[data-value]+b{display:none}
.conum[data-value]:after{content:attr(data-value)}
pre .conum[data-value]{position:relative;top:-.125em}
b.conum *{color:inherit!important}
.conum:not([data-value]):empty{display:none}
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
p{margin-bottom:1.25rem}
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
.print-only{display:none!important}
@media print{@page{margin:1.25cm .75cm}
*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
a{color:inherit!important;text-decoration:underline!important}
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
abbr[title]:after{content:" (" attr(title) ")"}
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
thead{display:table-header-group}
svg{max-width:100%}
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
#toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
.sect1{padding-bottom:0!important}
.sect1+.sect1{border:0!important}
#header>h1:first-child{margin-top:1.25rem}
body.book #header{text-align:center}
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
body.book #header .details{border:0!important;display:block;padding:0!important}
body.book #header .details span:first-child{margin-left:0!important}
body.book #header .details br{display:block}
body.book #header .details br+span:before{content:none!important}
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
.listingblock code[data-lang]:before{display:block}
#footer{background:none!important;padding:0 .9375em}
#footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
.hide-on-print{display:none!important}
.print-only{display:block!important}
.hide-for-print{display:none!important}
.show-for-print{display:inherit!important}}
</style>
<style>
/* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */
/*pre.CodeRay {background-color:#f7f7f8;}*/
.CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em}
.CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)}
.CodeRay .line-numbers strong{color:rgba(0,0,0,.4)}
table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none}
table.CodeRay td{vertical-align: top;line-height:1.45}
table.CodeRay td.line-numbers{text-align:right}
table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)}
table.CodeRay td.code{padding:0 0 0 .5em}
table.CodeRay td.code>pre{padding:0}
.CodeRay .debug{color:#fff !important;background:#000080 !important}
.CodeRay .annotation{color:#007}
.CodeRay .attribute-name{color:#000080}
.CodeRay .attribute-value{color:#700}
.CodeRay .binary{color:#509}
.CodeRay .comment{color:#998;font-style:italic}
.CodeRay .char{color:#04d}
.CodeRay .char .content{color:#04d}
.CodeRay .char .delimiter{color:#039}
.CodeRay .class{color:#458;font-weight:bold}
.CodeRay .complex{color:#a08}
.CodeRay .constant,.CodeRay .predefined-constant{color:#008080}
.CodeRay .color{color:#099}
.CodeRay .class-variable{color:#369}
.CodeRay .decorator{color:#b0b}
.CodeRay .definition{color:#099}
.CodeRay .delimiter{color:#000}
.CodeRay .doc{color:#970}
.CodeRay .doctype{color:#34b}
.CodeRay .doc-string{color:#d42}
.CodeRay .escape{color:#666}
.CodeRay .entity{color:#800}
.CodeRay .error{color:#808}
.CodeRay .exception{color:inherit}
.CodeRay .filename{color:#099}
.CodeRay .function{color:#900;font-weight:bold}
.CodeRay .global-variable{color:#008080}
.CodeRay .hex{color:#058}
.CodeRay .integer,.CodeRay .float{color:#099}
.CodeRay .include{color:#555}
.CodeRay .inline{color:#000}
.CodeRay .inline .inline{background:#ccc}
.CodeRay .inline .inline .inline{background:#bbb}
.CodeRay .inline .inline-delimiter{color:#d14}
.CodeRay .inline-delimiter{color:#d14}
.CodeRay .important{color:#555;font-weight:bold}
.CodeRay .interpreted{color:#b2b}
.CodeRay .instance-variable{color:#008080}
.CodeRay .label{color:#970}
.CodeRay .local-variable{color:#963}
.CodeRay .octal{color:#40e}
.CodeRay .predefined{color:#369}
.CodeRay .preprocessor{color:#579}
.CodeRay .pseudo-class{color:#555}
.CodeRay .directive{font-weight:bold}
.CodeRay .type{font-weight:bold}
.CodeRay .predefined-type{color:inherit}
.CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold}
.CodeRay .key{color:#808}
.CodeRay .key .delimiter{color:#606}
.CodeRay .key .char{color:#80f}
.CodeRay .value{color:#088}
.CodeRay .regexp .delimiter{color:#808}
.CodeRay .regexp .content{color:#808}
.CodeRay .regexp .modifier{color:#808}
.CodeRay .regexp .char{color:#d14}
.CodeRay .regexp .function{color:#404;font-weight:bold}
.CodeRay .string{color:#d20}
.CodeRay .string .string .string{background:#ffd0d0}
.CodeRay .string .content{color:#d14}
.CodeRay .string .char{color:#d14}
.CodeRay .string .delimiter{color:#d14}
.CodeRay .shell{color:#d14}
.CodeRay .shell .delimiter{color:#d14}
.CodeRay .symbol{color:#990073}
.CodeRay .symbol .content{color:#a60}
.CodeRay .symbol .delimiter{color:#630}
.CodeRay .tag{color:#008080}
.CodeRay .tag-special{color:#d70}
.CodeRay .variable{color:#036}
.CodeRay .insert{background:#afa}
.CodeRay .delete{background:#faa}
.CodeRay .change{color:#aaf;background:#007}
.CodeRay .head{color:#f8f;background:#505}
.CodeRay .insert .insert{color:#080}
.CodeRay .delete .delete{color:#800}
.CodeRay .change .change{color:#66f}
.CodeRay .head .head{color:#f4f}
</style>
</head>
<body class="article toc2 toc-left">
<div id="header">
<h1>Rapidoid Documentation</h1>
<div class="details">
<span id="author" class="author">Nikolche Mihajlovski</span><br>
<span id="email" class="email"><a href="mailto:rapidoid@googlegroups.com">rapidoid@googlegroups.com</a></span><br>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_what_is_rapidoid">1. What is Rapidoid?</a></li>
<li><a href="#_web_framework_or_dockerized_web_platform">2. Web Framework or Dockerized Web Platform?</a></li>
<li><a href="#_quick_start">3. Quick start</a></li>
<li><a href="#_request_routing">4. Request routing</a>
<ul class="sectlevel2">
<li><a href="#_matching_route">4.1. Matching route</a></li>
<li><a href="#_generic_handlers">4.2. Generic handlers</a></li>
<li><a href="#_not_found">4.3. Not found</a></li>
</ul>
</li>
<li><a href="#_performance">5. Performance</a>
<ul class="sectlevel2">
<li><a href="#_managed_vs_unmanaged_request_handlers">5.1. Managed vs unmanaged request handlers</a></li>
<li><a href="#_asynchronous_handlers">5.2. Asynchronous handlers</a></li>
</ul>
</li>
<li><a href="#_profiles">6. Profiles</a>
<ul class="sectlevel2">
<li><a href="#_the_default_profile">6.1. The default profile</a></li>
<li><a href="#_conditionally_activated_profiles">6.2. Conditionally activated profiles</a></li>
<li><a href="#_configuring_active_profiles">6.3. Configuring active profiles</a></li>
<li><a href="#_built_in_profile_specific_configuration">6.4. Built-in profile-specific configuration</a></li>
</ul>
</li>
<li><a href="#_serving_static_files">7. Serving static files</a>
<ul class="sectlevel2">
<li><a href="#_built_in_static_resources">7.1. Built-in static resources</a></li>
<li><a href="#_automatically_serving_the_static_resources">7.2. Automatically serving the static resources</a></li>
</ul>
</li>
<li><a href="#_restful_services">8. RESTful services</a>
<ul class="sectlevel2">
<li><a href="#_minimal_dependency">8.1. Minimal dependency</a></li>
</ul>
</li>
<li><a href="#_session_management">9. Session management</a>
<ul class="sectlevel2">
<li><a href="#_server_side_session_a_k_a_em_session_em">9.1. Server-side session a.k.a. <em>session</em></a></li>
<li><a href="#_client_side_token_as_a_session_a_k_a_em_token_em">9.2. Client-side token as a session a.k.a. <em>token</em></a></li>
<li><a href="#_configuring_the_token">9.3. Configuring the token</a></li>
</ul>
</li>
<li><a href="#_dependency_injection">10. Dependency injection</a>
<ul class="sectlevel2">
<li><a href="#_annotations">10.1. Annotations</a></li>
<li><a href="#_singleton_scope_only">10.2. Singleton scope only</a></li>
<li><a href="#_auto_run_main_entry_points">10.3. Auto-run main entry points</a></li>
</ul>
</li>
<li><a href="#_security">11. Security</a>
<ul class="sectlevel2">
<li><a href="#_access_denied">11.1. Access denied</a></li>
<li><a href="#_configuring_required_roles">11.2. Configuring required roles</a></li>
</ul>
</li>
<li><a href="#_authentication">12. Authentication</a>
<ul class="sectlevel2">
<li><a href="#_bootstrapping_the_authentication_services">12.1. Bootstrapping the authentication services</a></li>
<li><a href="#_authentication_flow">12.2. Authentication flow</a></li>
<li><a href="#_the_admin_api">12.3. The Admin API</a></li>
<li><a href="#_custom_authentication_tokens">12.4. Custom authentication tokens</a></li>
</ul>
</li>
<li><a href="#_configuration">13. Configuration</a>
<ul class="sectlevel2">
<li><a href="#_the_built_in_configuration">13.1. The built-in configuration</a></li>
<li><a href="#_custom_configuration">13.2. Custom configuration</a></li>
<li><a href="#_profiles_2">13.3. Profiles</a></li>
<li><a href="#_external_configuration_files">13.4. External configuration files</a></li>
</ul>
</li>
<li><a href="#_multiple_servers_setup">14. Multiple servers setup</a>
<ul class="sectlevel2">
<li><a href="#_bootstrapping_multiple_servers">14.1. Bootstrapping multiple servers</a></li>
</ul>
</li>
<li><a href="#_jdbc">15. JDBC</a>
<ul class="sectlevel2">
<li><a href="#_api">15.1. API</a></li>
<li><a href="#_connection_pools">15.2. Connection pools</a></li>
<li><a href="#_providing_custom_datasource">15.3. Providing custom DataSource</a></li>
<li><a href="#_paging">15.4. Paging</a></li>
</ul>
</li>
<li><a href="#_jpa">16. JPA</a>
<ul class="sectlevel2">
<li><a href="#_api_2">16.1. API</a></li>
<li><a href="#_bootstrap">16.2. Bootstrap</a></li>
<li><a href="#_connection_pools_2">16.3. Connection pools</a></li>
</ul>
</li>
<li><a href="#_transactions">17. Transactions</a></li>
<li><a href="#_configuring_the_database">18. Configuring the database</a>
<ul class="sectlevel2">
<li><a href="#_embedded_hsql">18.1. Embedded HSQL</a></li>
<li><a href="#_mysql">18.2. MySQL</a></li>
<li><a href="#_postgresql">18.3. PostgreSQL</a></li>
</ul>
</li>
<li><a href="#_rapidoid_s_template_engine">19. Rapidoid’s template engine</a></li>
<li><a href="#_reverse_proxy_and_load_balancer">20. Reverse proxy and load balancer</a>
<ul class="sectlevel2">
<li><a href="#_configuring">20.1. Configuring</a></li>
</ul>
</li>
<li><a href="#_https_tls">21. HTTPS & TLS</a>
<ul class="sectlevel2">
<li><a href="#_self_signed_certificates">21.1. Self-signed certificates</a></li>
<li><a href="#_configuring_https_tls">21.2. Configuring HTTPS (TLS)</a></li>
</ul>
</li>
<li><a href="#_http_chunked_response">22. HTTP Chunked response</a>
<ul class="sectlevel2">
<li><a href="#_sending_chunked_http_response">22.1. Sending chunked HTTP response</a></li>
</ul>
</li>
<li><a href="#_customization">23. Customization</a>
<ul class="sectlevel2">
<li><a href="#_customizable_components">23.1. Customizable components</a></li>
</ul>
</li>
<li><a href="#_logging">24. Logging</a>
<ul class="sectlevel2">
<li><a href="#_configuring_2">24.1. Configuring</a></li>
</ul>
</li>
<li><a href="#_basic_command_line_arguments">25. Basic command-line arguments</a></li>
<li><a href="#_rapidoid_modules">26. Rapidoid Modules</a>
<ul class="sectlevel2">
<li><a href="#_rapidoid_gui_module">26.1. Rapidoid GUI module</a></li>
<li><a href="#_rapidoid_fluent_module">26.2. Rapidoid Fluent module</a></li>
<li><a href="#_rapidoid_essentials_module">26.3. Rapidoid Essentials module</a></li>
<li><a href="#_rapidoid_web_module">26.4. Rapidoid Web module</a></li>
</ul>
</li>
<li><a href="#_the_http_api">27. The HTTP API</a></li>
<li><a href="#_examples">28. Examples</a>
<ul class="sectlevel2">
<li><a href="#_automatic_construction_and_serialization_of_javabeans">28.1. Automatic Construction and Serialization of JavaBeans</a></li>
<li><a href="#_the_default_configuration">28.2. The default configuration</a></li>
<li><a href="#_edit_bean_properties">28.3. Edit bean properties</a></li>
<li><a href="#_exception_handlers">28.4. Exception handlers</a></li>
<li><a href="#_restful_services_with_lambda_handlers_jpa_jackson_and_bean_validation">28.5. RESTful services with Lambda handlers, JPA, Jackson and Bean Validation</a></li>
<li><a href="#_configuring_rapidoid">28.6. Configuring Rapidoid</a></li>
<li><a href="#_hello_web_pages">28.7. Hello, web pages!</a></li>
<li><a href="#_hello_restful_services">28.8. Hello RESTful services!</a></li>
<li><a href="#_building_html_pages_with_java">28.9. Building HTML pages with Java</a></li>
<li><a href="#_highlighting_text_by_regular_expression_match">28.10. Highlighting Text by Regular Expression Match</a></li>
<li><a href="#_server_configuration">28.11. Server Configuration</a></li>
<li><a href="#_asynchronous_request_processing">28.12. Asynchronous request processing</a></li>
<li><a href="#_more_control_over_the_http_server_setup">28.13. More control over the HTTP server setup</a></li>
<li><a href="#_generic_handlers_match_any_request">28.14. Generic handlers match any request</a></li>
<li><a href="#_returning_a_not_found_result">28.15. Returning a "Not Found" result</a></li>
<li><a href="#_http_redirect">28.16. HTTP redirect</a></li>
<li><a href="#_all_the_request_data_is_in_the_req_req_parameter">28.17. All the request data is in the (Req req) parameter</a></li>
<li><a href="#_rendering_a_http_response">28.18. Rendering a HTTP response</a></li>
<li><a href="#_manipulating_the_response_code">28.19. Manipulating the response code</a></li>
<li><a href="#_manipulating_the_response_content_type">28.20. Manipulating the response content type</a></li>
<li><a href="#_http_handlers_and_routing">28.21. HTTP handlers and routing</a></li>
<li><a href="#_server_side_session_a_k_a_session">28.22. Server-side session (a.k.a. Session)</a></li>
<li><a href="#_restful_service_one_liner">28.23. RESTful service one-liner</a></li>
<li><a href="#_instant_web_application">28.24. Instant web application</a></li>
<li><a href="#_stopping_the_server">28.25. Stopping the server</a></li>
<li><a href="#_client_side_token_as_a_session">28.26. Client-side Token as a session</a></li>
<li><a href="#_request_wrappers_interceptors">28.27. Request wrappers (interceptors)</a></li>
<li><a href="#_dependency_injection_of_singletons">28.28. Dependency injection of singletons</a></li>
<li><a href="#_restful_services_with_jpa_crud">28.29. RESTful services with JPA CRUD</a></li>
<li><a href="#_jpa_scaffolding">28.30. JPA Scaffolding</a></li>
<li><a href="#_bootstrap_based_gui_layout">28.31. Bootstrap-based GUI layout</a></li>
<li><a href="#_mvc_architecture_with_rapidoid_s_built_in_template_engine">28.32. MVC architecture with Rapidoid’s built-in template engine</a></li>
<li><a href="#_custom_entitymanager_provider">28.33. Custom EntityManager provider</a></li>
<li><a href="#_custom_entitymanagerfactory_provider">28.34. Custom EntityManagerFactory provider</a></li>
<li><a href="#_custom_template_loader">28.35. Custom template loader</a></li>
<li><a href="#_create_key_value_data_grid_from_a_map">28.36. Create key-value data grid from a Map</a></li>
<li><a href="#_high_level_annotation_based_pojo_controllers">28.37. High-level annotation-based POJO controllers</a></li>
<li><a href="#_application_profiles">28.38. Application Profiles</a></li>
<li><a href="#_raw_html_pages">28.39. Raw HTML pages</a></li>
<li><a href="#_automatic_json_serialization_of_data_structures">28.40. Automatic JSON Serialization of Data Structures</a></li>
<li><a href="#_named_url_parameters">28.41. Named URL Parameters</a></li>
<li><a href="#_url_pattern_matching">28.42. URL pattern matching</a></li>
<li><a href="#_programmatic_setup_of_reverse_proxy_and_load_balancer">28.43. Programmatic setup of reverse proxy and load balancer</a></li>
<li><a href="#_custom_load_balancer">28.44. Custom load balancer</a></li>
<li><a href="#_reverse_proxy_matching_by_uri_prefix">28.45. Reverse proxy matching by URI prefix</a></li>
<li><a href="#_role_based_security">28.46. Role-based security</a></li>
<li><a href="#_display_bean_properties">28.47. Display bean properties</a></li>
<li><a href="#_serving_static_files_from_the_default_locations">28.48. Serving static files from the default locations</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<style>
code, kbd, pre, samp {
font-size: 12px !important;
}
</style>
<div class="paragraph">
<p>This is the new documentation for <a href="http://www.rapidoid.org">Rapidoid</a> (v5.5).</p>
</div>
<div class="paragraph">
<p>For older versions of Rapidoid, please see <a href="http://www.rapidoid.org/docs-5.3.html">v5.3</a>, <a href="http://www.rapidoid.org/docs-5.4.html">v5.4</a> and <a href="http://www.rapidoid.org/documentation.html">the old docs</a>.</p>
</div>
<div class="paragraph">
<p>Things to improve in the docs:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>the important concepts (architecture, design etc.) should be explained in more details,</p>
</li>
<li>
<p>the examples should be organized by categories,</p>
</li>
<li>
<p>information about the HTTP routes and sample requests/responses should be included for each example.</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_what_is_rapidoid">1. What is Rapidoid?</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Rapidoid is an extremely fast HTTP server and modern Java web framework / application container, with a strong focus on high productivity and high performance.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="img/rapidoid.png" alt="rapidoid">
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_web_framework_or_dockerized_web_platform">2. Web Framework or Dockerized Web Platform?</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The most of this documentation covers the aspects of using Rapidoid as a web framework with Java.</p>
</div>
<div class="paragraph">
<p>But Rapidoid can also be used as a web platform. For more details, please see the documentation of the <a href="https://store.docker.com/images/rapidoid">Official Docker repository for Rapidoid</a>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_quick_start">3. Quick start</h2>
<div class="sectionbody">
<div class="paragraph">
<p>For a quick start please use the <code>rapidoid-quick</code> module. It consists of <code>rapidoid-web</code> + batteries included:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Hibernate</p>
</li>
<li>
<p>Hibernate Validator</p>
</li>
<li>
<p>MySQL Connector</p>
</li>
<li>
<p>Logback</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_request_routing">4. Request routing</h2>
<div class="sectionbody">
<div class="paragraph">
<p>A web application can be defined as a collection of HTTP
request handlers. The HTTP requests are routed to the appropriate
lambda, based on the combination of:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>the <strong>request verb</strong> (<code>GET</code>, <code>POST</code>, <code>PUT</code>, <code>DELETE</code>, <code>PATCH</code>, <code>OPTIONS</code>, <code>HEAD</code>, <code>TRACE</code>)</p>
</li>
<li>
<p>and the <strong>request path</strong> (e.g. <code>/books/123</code>, <code>/users</code>).</p>
</li>
</ul>
</div>
<div class="sect2">
<h3 id="_matching_route">4.1. Matching route</h3>
<div class="paragraph">
<p>Rapidoid tries to find a matching handler for the route of the pending request.
If no handler matches the route, the first generic handler (if any) will be executed.</p>
</div>
</div>
<div class="sect2">
<h3 id="_generic_handlers">4.2. Generic handlers</h3>
<div class="paragraph">
<p>The generic handlers are ordered in the order they were registered.
The generic handlers match any route, and they can be registered with <code>On.req()</code>.
If a generic handler returns <code>not found</code>, the next generic handler will be executed.</p>
</div>
</div>
<div class="sect2">
<h3 id="_not_found">4.3. Not found</h3>
<div class="paragraph">
<p>If no handler manages to process the request, a <code>not found</code> HTTP response is returned.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_performance">5. Performance</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The network communication of Rapidoid is fully asynchronous (e.g. epoll on Linux).
Several benchmarks have demonstrated stable high performance with 16K connections.</p>
</div>
<div class="paragraph">
<p>The number of <em>I/O threads</em> in Rapidoid equals the number of cores.
E.g. on a 8-core machine there would be 8 I/O threads.</p>
</div>
<div class="paragraph">
<p>The number of <em>job executor threads</em> can vary (e.g. 32, 128, 512, 1024 or more).</p>
</div>
<div class="sect2">
<h3 id="_managed_vs_unmanaged_request_handlers">5.1. Managed vs unmanaged request handlers</h3>
<div class="paragraph">
<p>The request processing can be done in a <em>managed</em> and <em>unmanaged</em> way:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><strong>managed</strong> (the default): each request will be handled inside a job executed on the executor service (using <code>Jobs.*</code>).
This is the most convenient and powerful option, as it includes some built-in functionality:</p>
<div class="ulist">
<ul>
<li>
<p>request wrappers/interceptors</p>
</li>
<li>
<p>access control</p>
</li>
<li>
<p>transaction management</p>
</li>
</ul>
</div>
</li>
<li>
<p><strong>unmanaged</strong> - configured by <code>route.managed(false)</code>: every request is handled on the I/O thread that received it.
This is the fastest option and most flexible option, as it gives the developer complete control over the request handling.</p>
</li>
</ul>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
The handlers that are executed in <em>unmanaged</em> way should execute quickly and in non-blocking way.
</td>
</tr>
</table>
</div>
</div>
<div class="sect2">
<h3 id="_asynchronous_handlers">5.2. Asynchronous handlers</h3>
<div class="paragraph">
<p>For asynchronous handlers, which continue to execute some logic outside the handler job, <code>Req#async()</code> and <code>Req#done()</code> should be used.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_profiles">6. Profiles</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Application profiles are useful to conditionally activate application beans or configuration.</p>
</div>
<div class="sect2">
<h3 id="_the_default_profile">6.1. The default profile</h3>
<div class="paragraph">
<p>If no profiles are specified, the <code>default</code> profile will automatically be activated.</p>
</div>
</div>
<div class="sect2">
<h3 id="_conditionally_activated_profiles">6.2. Conditionally activated profiles</h3>
<div class="paragraph">
<p>Depending on the configured or inferred environment mode (dev / test / production), one of the <code>dev</code>, <code>test</code> or <code>production</code> profiles will also be automatically activated (in addition to the default or configured profiles).</p>
</div>
</div>
<div class="sect2">
<h3 id="_configuring_active_profiles">6.3. Configuring active profiles</h3>
<div class="paragraph">
<p>There are several ways to activate the application profiles:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>command line argument:</p>
</li>
</ul>
</div>
<div class="paragraph">
<p><code>profiles=foo,bar</code></p>
</div>
<div class="ulist">
<ul>
<li>
<p>environment variable:</p>
</li>
</ul>
</div>
<div class="paragraph">
<p><code>PROFILES=foo,bar</code></p>
</div>
<div class="ulist">
<ul>
<li>
<p>programmatically:</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code>App.profiles("foo", "bar");</code></pre>
</div>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<div class="title">Tip</div>
</td>
<td class="content">
Activating a <code>prod</code> or <code>production</code> profile automatically marks the environment mode as <code>production</code>.
</td>
</tr>
</table>
</div>
</div>
<div class="sect2">
<h3 id="_built_in_profile_specific_configuration">6.4. Built-in profile-specific configuration</h3>
<div class="paragraph">
<p>Rapidoid has built-in default configuration for the profiles <code>default</code>, <code>dev</code> and <code>mysql</code>.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_serving_static_files">7. Serving static files</h2>
<div class="sectionbody">
<div class="paragraph">
<p>It’s very easy to serve static files with Rapidoid.
Just add them as resources inside the <code>static</code> folder on the classpath in your Java project.</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<div class="title">Tip</div>
</td>
<td class="content">
Most of the Java projects use Maven, so the static files should usually be placed in <code>src/main/resources/static</code>.
</td>
</tr>
</table>
</div>
<div class="sect2">
<h3 id="_built_in_static_resources">7.1. Built-in static resources</h3>
<div class="paragraph">
<p>Rapidoid includes some built-in static resources in a <code>default/static</code> folder on the classpath.</p>
</div>