14-spring-boot-extending.html 104KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="UTF-8">
  5. <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <meta name="generator" content="Asciidoctor 1.5.5">
  8. <title>Spring Boot - Creating a Custom Spring Boot Starter</title>
  9. <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">
  10. <style>
  11. /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
  12. /* Remove comment around @import statement below when using as a custom stylesheet */
  13. /*@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";*/
  14. article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
  15. audio,canvas,video{display:inline-block}
  16. audio:not([controls]){display:none;height:0}
  17. [hidden],template{display:none}
  18. script{display:none!important}
  19. html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
  20. a{background:transparent}
  21. a:focus{outline:thin dotted}
  22. a:active,a:hover{outline:0}
  23. h1{font-size:2em;margin:.67em 0}
  24. abbr[title]{border-bottom:1px dotted}
  25. b,strong{font-weight:bold}
  26. dfn{font-style:italic}
  27. hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
  28. mark{background:#ff0;color:#000}
  29. code,kbd,pre,samp{font-family:monospace;font-size:1em}
  30. pre{white-space:pre-wrap}
  31. q{quotes:"\201C" "\201D" "\2018" "\2019"}
  32. small{font-size:80%}
  33. sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
  34. sup{top:-.5em}
  35. sub{bottom:-.25em}
  36. img{border:0}
  37. svg:not(:root){overflow:hidden}
  38. figure{margin:0}
  39. fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
  40. legend{border:0;padding:0}
  41. button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
  42. button,input{line-height:normal}
  43. button,select{text-transform:none}
  44. button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
  45. button[disabled],html input[disabled]{cursor:default}
  46. input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
  47. input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
  48. input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
  49. button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
  50. textarea{overflow:auto;vertical-align:top}
  51. table{border-collapse:collapse;border-spacing:0}
  52. *,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
  53. html,body{font-size:100%}
  54. 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;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
  55. a:hover{cursor:pointer}
  56. img,object,embed{max-width:100%;height:auto}
  57. object,embed{height:100%}
  58. img{-ms-interpolation-mode:bicubic}
  59. .left{float:left!important}
  60. .right{float:right!important}
  61. .text-left{text-align:left!important}
  62. .text-right{text-align:right!important}
  63. .text-center{text-align:center!important}
  64. .text-justify{text-align:justify!important}
  65. .hide{display:none}
  66. img,object,svg{display:inline-block;vertical-align:middle}
  67. textarea{height:auto;min-height:50px}
  68. select{width:100%}
  69. .center{margin-left:auto;margin-right:auto}
  70. .spread{width:100%}
  71. p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
  72. .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}
  73. 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}
  74. a{color:#2156a5;text-decoration:underline;line-height:inherit}
  75. a:hover,a:focus{color:#1d4b8f}
  76. a img{border:none}
  77. p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
  78. p aside{font-size:.875em;line-height:1.35;font-style:italic}
  79. 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}
  80. 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}
  81. h1{font-size:2.125em}
  82. h2{font-size:1.6875em}
  83. h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
  84. h4,h5{font-size:1.125em}
  85. h6{font-size:1em}
  86. hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
  87. em,i{font-style:italic;line-height:inherit}
  88. strong,b{font-weight:bold;line-height:inherit}
  89. small{font-size:60%;line-height:inherit}
  90. code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
  91. ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
  92. ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em}
  93. ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
  94. ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
  95. ul.square{list-style-type:square}
  96. ul.circle{list-style-type:circle}
  97. ul.disc{list-style-type:disc}
  98. ul.no-bullet{list-style:none}
  99. ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
  100. dl dt{margin-bottom:.3125em;font-weight:bold}
  101. dl dd{margin-bottom:1.25em}
  102. abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
  103. abbr{text-transform:none}
  104. blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
  105. blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
  106. blockquote cite:before{content:"\2014 \0020"}
  107. blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
  108. blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
  109. @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
  110. h1{font-size:2.75em}
  111. h2{font-size:2.3125em}
  112. h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
  113. h4{font-size:1.4375em}}
  114. table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
  115. table thead,table tfoot{background:#f7f8f7;font-weight:bold}
  116. 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}
  117. table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
  118. table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
  119. 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}
  120. h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
  121. h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
  122. .clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
  123. .clearfix:after,.float-group:after{clear:both}
  124. *: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;word-wrap:break-word}
  125. *:not(pre)>code.nobreak{word-wrap:normal}
  126. *:not(pre)>code.nowrap{white-space:nowrap}
  127. 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}
  128. em em{font-style:normal}
  129. strong strong{font-weight:400}
  130. .keyseq{color:rgba(51,51,51,.8)}
  131. 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}
  132. .keyseq kbd:first-child{margin-left:0}
  133. .keyseq kbd:last-child{margin-right:0}
  134. .menuseq,.menu{color:rgba(0,0,0,.8)}
  135. b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
  136. b.button:before{content:"[";padding:0 3px 0 2px}
  137. b.button:after{content:"]";padding:0 2px 0 3px}
  138. p a>code:hover{color:rgba(0,0,0,.9)}
  139. #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}
  140. #header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
  141. #header:after,#content:after,#footnotes:after,#footer:after{clear:both}
  142. #content{margin-top:1.25em}
  143. #content:before{content:none}
  144. #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
  145. #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
  146. #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
  147. #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}
  148. #header .details span:first-child{margin-left:-.125em}
  149. #header .details span.email a{color:rgba(0,0,0,.85)}
  150. #header .details br{display:none}
  151. #header .details br+span:before{content:"\00a0\2013\00a0"}
  152. #header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
  153. #header .details br+span#revremark:before{content:"\00a0|\00a0"}
  154. #header #revnumber{text-transform:capitalize}
  155. #header #revnumber:after{content:"\00a0"}
  156. #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}
  157. #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
  158. #toc>ul{margin-left:.125em}
  159. #toc ul.sectlevel0>li>a{font-style:italic}
  160. #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
  161. #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
  162. #toc li{line-height:1.3334;margin-top:.3334em}
  163. #toc a{text-decoration:none}
  164. #toc a:active{text-decoration:underline}
  165. #toctitle{color:#7a2518;font-size:1.2em}
  166. @media only screen and (min-width:768px){#toctitle{font-size:1.375em}
  167. body.toc2{padding-left:15em;padding-right:0}
  168. #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}
  169. #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
  170. #toc.toc2>ul{font-size:.9em;margin-bottom:0}
  171. #toc.toc2 ul ul{margin-left:0;padding-left:1em}
  172. #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
  173. body.toc2.toc-right{padding-left:0;padding-right:15em}
  174. body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
  175. @media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
  176. #toc.toc2{width:20em}
  177. #toc.toc2 #toctitle{font-size:1.375em}
  178. #toc.toc2>ul{font-size:.95em}
  179. #toc.toc2 ul ul{padding-left:1.25em}
  180. body.toc2.toc-right{padding-left:0;padding-right:20em}}
  181. #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}
  182. #content #toc>:first-child{margin-top:0}
  183. #content #toc>:last-child{margin-bottom:0}
  184. #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
  185. #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
  186. .sect1{padding-bottom:.625em}
  187. @media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}
  188. .sect1+.sect1{border-top:1px solid #efefed}
  189. #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}
  190. #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}
  191. #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}
  192. #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}
  193. #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}
  194. .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
  195. .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}
  196. table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
  197. .paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
  198. table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
  199. .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
  200. .admonitionblock>table td.icon{text-align:center;width:80px}
  201. .admonitionblock>table td.icon img{max-width:none}
  202. .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
  203. .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
  204. .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
  205. .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}
  206. .exampleblock>.content>:first-child{margin-top:0}
  207. .exampleblock>.content>:last-child{margin-bottom:0}
  208. .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}
  209. .sidebarblock>:first-child{margin-top:0}
  210. .sidebarblock>:last-child{margin-bottom:0}
  211. .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
  212. .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}
  213. .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
  214. .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}
  215. .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}
  216. .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
  217. @media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
  218. @media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
  219. .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
  220. .listingblock pre.highlightjs{padding:0}
  221. .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
  222. .listingblock pre.prettyprint{border-width:0}
  223. .listingblock>.content{position:relative}
  224. .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}
  225. .listingblock:hover code[data-lang]:before{display:block}
  226. .listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
  227. .listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
  228. table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
  229. table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
  230. table.pyhltable td.code{padding-left:.75em;padding-right:0}
  231. pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
  232. pre.pygments .lineno{display:inline-block;margin-right:.25em}
  233. table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
  234. .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
  235. .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
  236. .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}
  237. .quoteblock blockquote{margin:0;padding:0;border:0}
  238. .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)}
  239. .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
  240. .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
  241. .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
  242. .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
  243. .quoteblock .quoteblock blockquote:before{display:none}
  244. .verseblock{margin:0 1em 1.25em 1em}
  245. .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}
  246. .verseblock pre strong{font-weight:400}
  247. .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
  248. .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
  249. .quoteblock .attribution br,.verseblock .attribution br{display:none}
  250. .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
  251. .quoteblock.abstract{margin:0 0 1.25em 0;display:block}
  252. .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
  253. .quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
  254. table.tableblock{max-width:100%;border-collapse:separate}
  255. 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}
  256. table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
  257. table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0}
  258. table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0}
  259. table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0}
  260. table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0}
  261. table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0}
  262. 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}
  263. table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0}
  264. table.frame-all{border-width:1px}
  265. table.frame-sides{border-width:0 1px}
  266. table.frame-topbot{border-width:1px 0}
  267. th.halign-left,td.halign-left{text-align:left}
  268. th.halign-right,td.halign-right{text-align:right}
  269. th.halign-center,td.halign-center{text-align:center}
  270. th.valign-top,td.valign-top{vertical-align:top}
  271. th.valign-bottom,td.valign-bottom{vertical-align:bottom}
  272. th.valign-middle,td.valign-middle{vertical-align:middle}
  273. table thead th,table tfoot th{font-weight:bold}
  274. tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
  275. tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
  276. p.tableblock>code:only-child{background:none;padding:0}
  277. p.tableblock{font-size:1em}
  278. td>div.verse{white-space:pre}
  279. ol{margin-left:1.75em}
  280. ul li ol{margin-left:1.5em}
  281. dl dd{margin-left:1.125em}
  282. dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
  283. ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
  284. ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none}
  285. ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em}
  286. 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}
  287. ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px}
  288. ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
  289. ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
  290. ul.inline>li>*{display:block}
  291. .unstyled dl dt{font-weight:400;font-style:normal}
  292. ol.arabic{list-style-type:decimal}
  293. ol.decimal{list-style-type:decimal-leading-zero}
  294. ol.loweralpha{list-style-type:lower-alpha}
  295. ol.upperalpha{list-style-type:upper-alpha}
  296. ol.lowerroman{list-style-type:lower-roman}
  297. ol.upperroman{list-style-type:upper-roman}
  298. ol.lowergreek{list-style-type:lower-greek}
  299. .hdlist>table,.colist>table{border:0;background:none}
  300. .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
  301. td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
  302. td.hdlist1{font-weight:bold;padding-bottom:1.25em}
  303. .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
  304. .colist>table tr>td:first-of-type{padding:0 .75em;line-height:1}
  305. .colist>table tr>td:last-of-type{padding:.25em 0}
  306. .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}
  307. .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
  308. .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
  309. .imageblock>.title{margin-bottom:0}
  310. .imageblock.thumb,.imageblock.th{border-width:6px}
  311. .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
  312. .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
  313. .image.left{margin-right:.625em}
  314. .image.right{margin-left:.625em}
  315. a.image{text-decoration:none;display:inline-block}
  316. a.image object{pointer-events:none}
  317. sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
  318. sup.footnote a,sup.footnoteref a{text-decoration:none}
  319. sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
  320. #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
  321. #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
  322. #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}
  323. #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
  324. #footnotes .footnote:last-of-type{margin-bottom:0}
  325. #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
  326. .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
  327. .gist .file-data>table td.line-data{width:99%}
  328. div.unbreakable{page-break-inside:avoid}
  329. .big{font-size:larger}
  330. .small{font-size:smaller}
  331. .underline{text-decoration:underline}
  332. .overline{text-decoration:overline}
  333. .line-through{text-decoration:line-through}
  334. .aqua{color:#00bfbf}
  335. .aqua-background{background-color:#00fafa}
  336. .black{color:#000}
  337. .black-background{background-color:#000}
  338. .blue{color:#0000bf}
  339. .blue-background{background-color:#0000fa}
  340. .fuchsia{color:#bf00bf}
  341. .fuchsia-background{background-color:#fa00fa}
  342. .gray{color:#606060}
  343. .gray-background{background-color:#7d7d7d}
  344. .green{color:#006000}
  345. .green-background{background-color:#007d00}
  346. .lime{color:#00bf00}
  347. .lime-background{background-color:#00fa00}
  348. .maroon{color:#600000}
  349. .maroon-background{background-color:#7d0000}
  350. .navy{color:#000060}
  351. .navy-background{background-color:#00007d}
  352. .olive{color:#606000}
  353. .olive-background{background-color:#7d7d00}
  354. .purple{color:#600060}
  355. .purple-background{background-color:#7d007d}
  356. .red{color:#bf0000}
  357. .red-background{background-color:#fa0000}
  358. .silver{color:#909090}
  359. .silver-background{background-color:#bcbcbc}
  360. .teal{color:#006060}
  361. .teal-background{background-color:#007d7d}
  362. .white{color:#bfbfbf}
  363. .white-background{background-color:#fafafa}
  364. .yellow{color:#bfbf00}
  365. .yellow-background{background-color:#fafa00}
  366. span.icon>.fa{cursor:default}
  367. .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
  368. .admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
  369. .admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
  370. .admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
  371. .admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
  372. .admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
  373. .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}
  374. .conum[data-value] *{color:#fff!important}
  375. .conum[data-value]+b{display:none}
  376. .conum[data-value]:after{content:attr(data-value)}
  377. pre .conum[data-value]{position:relative;top:-.125em}
  378. b.conum *{color:inherit!important}
  379. .conum:not([data-value]):empty{display:none}
  380. dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
  381. h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
  382. p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
  383. p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
  384. p{margin-bottom:1.25rem}
  385. .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
  386. .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
  387. .print-only{display:none!important}
  388. @media print{@page{margin:1.25cm .75cm}
  389. *{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
  390. a{color:inherit!important;text-decoration:underline!important}
  391. a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
  392. a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
  393. abbr[title]:after{content:" (" attr(title) ")"}
  394. pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
  395. thead{display:table-header-group}
  396. svg{max-width:100%}
  397. p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
  398. h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
  399. #toc,.sidebarblock,.exampleblock>.content{background:none!important}
  400. #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
  401. .sect1{padding-bottom:0!important}
  402. .sect1+.sect1{border:0!important}
  403. #header>h1:first-child{margin-top:1.25rem}
  404. body.book #header{text-align:center}
  405. body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
  406. body.book #header .details{border:0!important;display:block;padding:0!important}
  407. body.book #header .details span:first-child{margin-left:0!important}
  408. body.book #header .details br{display:block}
  409. body.book #header .details br+span:before{content:none!important}
  410. body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
  411. body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
  412. .listingblock code[data-lang]:before{display:block}
  413. #footer{background:none!important;padding:0 .9375em}
  414. #footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
  415. .hide-on-print{display:none!important}
  416. .print-only{display:block!important}
  417. .hide-for-print{display:none!important}
  418. .show-for-print{display:inherit!important}}
  419. </style>
  420. <style>
  421. /* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */
  422. /*pre.CodeRay {background-color:#f7f7f8;}*/
  423. .CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em}
  424. .CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)}
  425. .CodeRay .line-numbers strong{color:rgba(0,0,0,.4)}
  426. table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none}
  427. table.CodeRay td{vertical-align: top;line-height:1.45}
  428. table.CodeRay td.line-numbers{text-align:right}
  429. table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)}
  430. table.CodeRay td.code{padding:0 0 0 .5em}
  431. table.CodeRay td.code>pre{padding:0}
  432. .CodeRay .debug{color:#fff !important;background:#000080 !important}
  433. .CodeRay .annotation{color:#007}
  434. .CodeRay .attribute-name{color:#000080}
  435. .CodeRay .attribute-value{color:#700}
  436. .CodeRay .binary{color:#509}
  437. .CodeRay .comment{color:#998;font-style:italic}
  438. .CodeRay .char{color:#04d}
  439. .CodeRay .char .content{color:#04d}
  440. .CodeRay .char .delimiter{color:#039}
  441. .CodeRay .class{color:#458;font-weight:bold}
  442. .CodeRay .complex{color:#a08}
  443. .CodeRay .constant,.CodeRay .predefined-constant{color:#008080}
  444. .CodeRay .color{color:#099}
  445. .CodeRay .class-variable{color:#369}
  446. .CodeRay .decorator{color:#b0b}
  447. .CodeRay .definition{color:#099}
  448. .CodeRay .delimiter{color:#000}
  449. .CodeRay .doc{color:#970}
  450. .CodeRay .doctype{color:#34b}
  451. .CodeRay .doc-string{color:#d42}
  452. .CodeRay .escape{color:#666}
  453. .CodeRay .entity{color:#800}
  454. .CodeRay .error{color:#808}
  455. .CodeRay .exception{color:inherit}
  456. .CodeRay .filename{color:#099}
  457. .CodeRay .function{color:#900;font-weight:bold}
  458. .CodeRay .global-variable{color:#008080}
  459. .CodeRay .hex{color:#058}
  460. .CodeRay .integer,.CodeRay .float{color:#099}
  461. .CodeRay .include{color:#555}
  462. .CodeRay .inline{color:#000}
  463. .CodeRay .inline .inline{background:#ccc}
  464. .CodeRay .inline .inline .inline{background:#bbb}
  465. .CodeRay .inline .inline-delimiter{color:#d14}
  466. .CodeRay .inline-delimiter{color:#d14}
  467. .CodeRay .important{color:#555;font-weight:bold}
  468. .CodeRay .interpreted{color:#b2b}
  469. .CodeRay .instance-variable{color:#008080}
  470. .CodeRay .label{color:#970}
  471. .CodeRay .local-variable{color:#963}
  472. .CodeRay .octal{color:#40e}
  473. .CodeRay .predefined{color:#369}
  474. .CodeRay .preprocessor{color:#579}
  475. .CodeRay .pseudo-class{color:#555}
  476. .CodeRay .directive{font-weight:bold}
  477. .CodeRay .type{font-weight:bold}
  478. .CodeRay .predefined-type{color:inherit}
  479. .CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold}
  480. .CodeRay .key{color:#808}
  481. .CodeRay .key .delimiter{color:#606}
  482. .CodeRay .key .char{color:#80f}
  483. .CodeRay .value{color:#088}
  484. .CodeRay .regexp .delimiter{color:#808}
  485. .CodeRay .regexp .content{color:#808}
  486. .CodeRay .regexp .modifier{color:#808}
  487. .CodeRay .regexp .char{color:#d14}
  488. .CodeRay .regexp .function{color:#404;font-weight:bold}
  489. .CodeRay .string{color:#d20}
  490. .CodeRay .string .string .string{background:#ffd0d0}
  491. .CodeRay .string .content{color:#d14}
  492. .CodeRay .string .char{color:#d14}
  493. .CodeRay .string .delimiter{color:#d14}
  494. .CodeRay .shell{color:#d14}
  495. .CodeRay .shell .delimiter{color:#d14}
  496. .CodeRay .symbol{color:#990073}
  497. .CodeRay .symbol .content{color:#a60}
  498. .CodeRay .symbol .delimiter{color:#630}
  499. .CodeRay .tag{color:#008080}
  500. .CodeRay .tag-special{color:#d70}
  501. .CodeRay .variable{color:#036}
  502. .CodeRay .insert{background:#afa}
  503. .CodeRay .delete{background:#faa}
  504. .CodeRay .change{color:#aaf;background:#007}
  505. .CodeRay .head{color:#f8f;background:#505}
  506. .CodeRay .insert .insert{color:#080}
  507. .CodeRay .delete .delete{color:#800}
  508. .CodeRay .change .change{color:#66f}
  509. .CodeRay .head .head{color:#f4f}
  510. </style>
  511. <link rel="stylesheet"
  512. href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"
  513. integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u"
  514. crossorigin="anonymous">
  515. <link rel="stylesheet"
  516. href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap-theme.min.css"
  517. integrity="sha384-rHyoN1iRsVXV4nD0JutlnGaslCJuC7uwjduW9SVrLvRYooPp2bWYgmgJQIXwl/Sp"
  518. crossorigin="anonymous">
  519. <style>
  520. .c2cb{
  521. position: absolute; left: 0; top: 0;
  522. cursor: pointer
  523. }
  524. .c2cb:focus {
  525. outline: none;
  526. }
  527. body {
  528. font-size: 18px;
  529. }
  530. p {
  531. font-size: 18px;
  532. }
  533. td.content {
  534. font-size:2.0625rem;
  535. }
  536. div.title {
  537. font-size:2.0625rem;
  538. }
  539. </style>
  540. <script src="js/jquery-3.2.1.min.js"></script>
  541. <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js"></script>
  542. <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
  543. <script>
  544. $(function() {
  545. var button = $("<div style='padding: 10px;'><button data-toggle='tooltip' placement='right' data-trigger='click' title='Copied!' class='c2cb glyphicon glyphicon-copy'></button></div>");
  546. $(".listingblock > .content pre").prepend(button);
  547. $('[data-toggle="tooltip"]').tooltip();
  548. $('[data-toggle="tooltip"]').mouseout(function() {
  549. $(this).tooltip('hide');
  550. $(this).trigger('blur');
  551. });
  552. var clipboard = new Clipboard('.c2cb', {
  553. target: function(c2cb) {
  554. return $(c2cb).parent().siblings("code")[0];
  555. }
  556. });
  557. clipboard.on('success', function(e) {
  558. e.clearSelection();
  559. });
  560. });
  561. </script>
  562. </head>
  563. <body class="article toc2 toc-left">
  564. <div id="header">
  565. <h1><a id="spring-boot-security"></a>Spring Boot - Creating a Custom Spring Boot Starter</h1>
  566. <div id="toc" class="toc2">
  567. <div id="toctitle">Labs</div>
  568. <ul class="sectlevel1">
  569. <li><a href="#_spring_boot_starter">Spring Boot Starter</a></li>
  570. <li><a href="#_project_structure">Project Structure</a></li>
  571. <li><a href="#_directory_web_client_spring_boot_starter">Directory Web Client Spring Boot Starter</a></li>
  572. <li><a href="#_directory_web_client_spring_boot_autoconfigure">Directory Web Client Spring Boot Autoconfigure</a></li>
  573. <li><a href="#_demo_starter">Demo Starter</a>
  574. <ul class="sectlevel2">
  575. <li><a href="#_testing_the_strong_directorywebclient_strong_bean">Testing the <strong>DirectoryWebClient</strong> bean</a></li>
  576. <li><a href="#_testing_the_strong_enabledirectorywebclientutils_strong_annotation">Testing the <strong>@EnableDirectoryWebClientUtils</strong> annotation.</a></li>
  577. </ul>
  578. </li>
  579. <li><a href="#_challenges">Challenges</a></li>
  580. <li><a href="#_homework">HOMEWORK</a></li>
  581. </ul>
  582. </div>
  583. </div>
  584. <div id="content">
  585. <div id="preamble">
  586. <div class="sectionbody">
  587. <div class="paragraph">
  588. <p>You will create a custom <strong>Spring Boot Starter</strong> using the <strong>auto-configuration</strong> features.</p>
  589. </div>
  590. <div class="paragraph">
  591. <p><strong>Time:</strong> 30 minutes.</p>
  592. </div>
  593. <!-- toc disabled -->
  594. </div>
  595. </div>
  596. <div class="sect1">
  597. <h2 id="_spring_boot_starter">Spring Boot Starter</h2>
  598. <div class="sectionbody">
  599. <div class="paragraph">
  600. <p>We are going create custom <strong>Spring Boot Starter</strong>. This starter will be a reusable client for the <strong>directory-web-security</strong> project. It will have the following features:</p>
  601. </div>
  602. <div class="ulist">
  603. <ul>
  604. <li>
  605. <p><strong>DirectoryWebClient</strong> bean that will have access to the persons in the directory. You will add a new person or list all the persons.</p>
  606. </li>
  607. <li>
  608. <p><strong>@EnableDirectoryWebClientUtils</strong> annotation that will bring a <strong>DirectoryWebClientUtils</strong> that will expose password encode using either <strong>BCRYPT</strong> (default) or <strong>PBKDF2</strong> algorthims.</p>
  609. </li>
  610. </ul>
  611. </div>
  612. </div>
  613. </div>
  614. <div class="sect1">
  615. <h2 id="_project_structure">Project Structure</h2>
  616. <div class="sectionbody">
  617. <div class="olist arabic">
  618. <ol class="arabic">
  619. <li>
  620. <p>Create a directory structure where we are going to place 3 apps:</p>
  621. <div class="ulist">
  622. <ul>
  623. <li>
  624. <p>demo-starter</p>
  625. </li>
  626. <li>
  627. <p>directory-web-client-spring-boot-autoconfigure</p>
  628. </li>
  629. <li>
  630. <p>directory-web-client-spring-boot-starter</p>
  631. <div class="listingblock">
  632. <div class="content">
  633. <pre class="CodeRay highlight"><code data-lang="bash">mkdir -p workspace/demo-starter workspace/directory-web-client-spring-boot-autoconfigure workspace/directory-web-client-spring-boot-starter</code></pre>
  634. </div>
  635. </div>
  636. </li>
  637. </ul>
  638. </div>
  639. </li>
  640. <li>
  641. <p>In the <strong>workspace</strong> directory add the following <strong>pom.xml</strong>. This will hold all the module information and the general dependencies.</p>
  642. <div class="listingblock">
  643. <div class="content">
  644. <pre class="CodeRay highlight"><code data-lang="xml"><span class="preprocessor">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
  645. <span class="tag">&lt;project</span> <span class="attribute-name">xmlns</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://maven.apache.org/POM/4.0.0</span><span class="delimiter">&quot;</span></span> <span class="attribute-name">xmlns:xsi</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://www.w3.org/2001/XMLSchema-instance</span><span class="delimiter">&quot;</span></span>
  646. <span class="attribute-name">xsi:schemaLocation</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
  647. <span class="tag">&lt;modelVersion&gt;</span>4.0.0<span class="tag">&lt;/modelVersion&gt;</span>
  648. <span class="tag">&lt;groupId&gt;</span>io.pivotal.workshop<span class="tag">&lt;/groupId&gt;</span>
  649. <span class="tag">&lt;artifactId&gt;</span>directory-web-client<span class="tag">&lt;/artifactId&gt;</span>
  650. <span class="tag">&lt;version&gt;</span>0.0.1-SNAPSHOT<span class="tag">&lt;/version&gt;</span>
  651. <span class="tag">&lt;packaging&gt;</span>pom<span class="tag">&lt;/packaging&gt;</span>
  652. <span class="tag">&lt;name&gt;</span>directory-web-client<span class="tag">&lt;/name&gt;</span>
  653. <span class="tag">&lt;modules&gt;</span>
  654. <span class="tag">&lt;module&gt;</span>directory-web-client-spring-boot-autoconfigure<span class="tag">&lt;/module&gt;</span>
  655. <span class="tag">&lt;module&gt;</span>directory-web-client-spring-boot-starter<span class="tag">&lt;/module&gt;</span>
  656. <span class="tag">&lt;module&gt;</span>demo-starter<span class="tag">&lt;/module&gt;</span>
  657. <span class="tag">&lt;/modules&gt;</span>
  658. <span class="tag">&lt;dependencyManagement&gt;</span>
  659. <span class="tag">&lt;dependencies&gt;</span>
  660. <span class="tag">&lt;dependency&gt;</span>
  661. <span class="tag">&lt;groupId&gt;</span>org.springframework.boot<span class="tag">&lt;/groupId&gt;</span>
  662. <span class="tag">&lt;artifactId&gt;</span>spring-boot-dependencies<span class="tag">&lt;/artifactId&gt;</span>
  663. <span class="tag">&lt;version&gt;</span>2.0.0.M7<span class="tag">&lt;/version&gt;</span>
  664. <span class="tag">&lt;type&gt;</span>pom<span class="tag">&lt;/type&gt;</span>
  665. <span class="tag">&lt;scope&gt;</span>import<span class="tag">&lt;/scope&gt;</span>
  666. <span class="tag">&lt;/dependency&gt;</span>
  667. <span class="tag">&lt;/dependencies&gt;</span>
  668. <span class="tag">&lt;/dependencyManagement&gt;</span>
  669. <span class="tag">&lt;repositories&gt;</span>
  670. <span class="tag">&lt;repository&gt;</span>
  671. <span class="tag">&lt;id&gt;</span>spring-snapshots<span class="tag">&lt;/id&gt;</span>
  672. <span class="tag">&lt;name&gt;</span>Spring Snapshots<span class="tag">&lt;/name&gt;</span>
  673. <span class="tag">&lt;url&gt;</span>https://repo.spring.io/snapshot<span class="tag">&lt;/url&gt;</span>
  674. <span class="tag">&lt;snapshots&gt;</span>
  675. <span class="tag">&lt;enabled&gt;</span>true<span class="tag">&lt;/enabled&gt;</span>
  676. <span class="tag">&lt;/snapshots&gt;</span>
  677. <span class="tag">&lt;/repository&gt;</span>
  678. <span class="tag">&lt;repository&gt;</span>
  679. <span class="tag">&lt;id&gt;</span>spring-milestones<span class="tag">&lt;/id&gt;</span>
  680. <span class="tag">&lt;name&gt;</span>Spring Milestones<span class="tag">&lt;/name&gt;</span>
  681. <span class="tag">&lt;url&gt;</span>https://repo.spring.io/milestone<span class="tag">&lt;/url&gt;</span>
  682. <span class="tag">&lt;snapshots&gt;</span>
  683. <span class="tag">&lt;enabled&gt;</span>false<span class="tag">&lt;/enabled&gt;</span>
  684. <span class="tag">&lt;/snapshots&gt;</span>
  685. <span class="tag">&lt;/repository&gt;</span>
  686. <span class="tag">&lt;/repositories&gt;</span>
  687. <span class="tag">&lt;pluginRepositories&gt;</span>
  688. <span class="tag">&lt;pluginRepository&gt;</span>
  689. <span class="tag">&lt;id&gt;</span>spring-snapshots<span class="tag">&lt;/id&gt;</span>
  690. <span class="tag">&lt;name&gt;</span>Spring Snapshots<span class="tag">&lt;/name&gt;</span>
  691. <span class="tag">&lt;url&gt;</span>https://repo.spring.io/snapshot<span class="tag">&lt;/url&gt;</span>
  692. <span class="tag">&lt;snapshots&gt;</span>
  693. <span class="tag">&lt;enabled&gt;</span>true<span class="tag">&lt;/enabled&gt;</span>
  694. <span class="tag">&lt;/snapshots&gt;</span>
  695. <span class="tag">&lt;/pluginRepository&gt;</span>
  696. <span class="tag">&lt;pluginRepository&gt;</span>
  697. <span class="tag">&lt;id&gt;</span>spring-milestones<span class="tag">&lt;/id&gt;</span>
  698. <span class="tag">&lt;name&gt;</span>Spring Milestones<span class="tag">&lt;/name&gt;</span>
  699. <span class="tag">&lt;url&gt;</span>https://repo.spring.io/milestone<span class="tag">&lt;/url&gt;</span>
  700. <span class="tag">&lt;snapshots&gt;</span>
  701. <span class="tag">&lt;enabled&gt;</span>false<span class="tag">&lt;/enabled&gt;</span>
  702. <span class="tag">&lt;/snapshots&gt;</span>
  703. <span class="tag">&lt;/pluginRepository&gt;</span>
  704. <span class="tag">&lt;/pluginRepositories&gt;</span>
  705. <span class="tag">&lt;/project&gt;</span></code></pre>
  706. </div>
  707. </div>
  708. <div class="paragraph">
  709. <p>As you can see it has the main dependency right now <strong>spring-boot-dependencies:2.0.0.M6</strong> and is a <strong>pom</strong> import. It defines our 3 modules.</p>
  710. </div>
  711. </li>
  712. </ol>
  713. </div>
  714. </div>
  715. </div>
  716. <div class="sect1">
  717. <h2 id="_directory_web_client_spring_boot_starter">Directory Web Client Spring Boot Starter</h2>
  718. <div class="sectionbody">
  719. <div class="paragraph">
  720. <p>It&#8217;s a good idea to create custom starter by leaving at the end the keywords <strong>*-spring-boot-starter</strong> and at the beginning the technology that you are going to build.</p>
  721. </div>
  722. <div class="olist arabic">
  723. <ol class="arabic">
  724. <li>
  725. <p>In the directory <strong>workspace/directory-web-client-spring-boot-starter</strong> add the following <strong>pom.xml</strong> file:</p>
  726. <div class="listingblock">
  727. <div class="content">
  728. <pre class="CodeRay highlight"><code data-lang="xml"><span class="preprocessor">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
  729. <span class="tag">&lt;project</span> <span class="attribute-name">xmlns</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://maven.apache.org/POM/4.0.0</span><span class="delimiter">&quot;</span></span> <span class="attribute-name">xmlns:xsi</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://www.w3.org/2001/XMLSchema-instance</span><span class="delimiter">&quot;</span></span>
  730. <span class="attribute-name">xsi:schemaLocation</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
  731. <span class="tag">&lt;modelVersion&gt;</span>4.0.0<span class="tag">&lt;/modelVersion&gt;</span>
  732. <span class="tag">&lt;groupId&gt;</span>io.pivotal.workshop<span class="tag">&lt;/groupId&gt;</span>
  733. <span class="tag">&lt;artifactId&gt;</span>directory-web-client-spring-boot-starter<span class="tag">&lt;/artifactId&gt;</span>
  734. <span class="tag">&lt;version&gt;</span>0.0.1-SNAPSHOT<span class="tag">&lt;/version&gt;</span>
  735. <span class="tag">&lt;packaging&gt;</span>jar<span class="tag">&lt;/packaging&gt;</span>
  736. <span class="tag">&lt;name&gt;</span>directory-web-client-spring-boot-starter<span class="tag">&lt;/name&gt;</span>
  737. <span class="tag">&lt;description&gt;</span>Demo project for Spring Boot<span class="tag">&lt;/description&gt;</span>
  738. <span class="tag">&lt;properties&gt;</span>
  739. <span class="tag">&lt;project.build.sourceEncoding&gt;</span>UTF-8<span class="tag">&lt;/project.build.sourceEncoding&gt;</span>
  740. <span class="tag">&lt;project.reporting.outputEncoding&gt;</span>UTF-8<span class="tag">&lt;/project.reporting.outputEncoding&gt;</span>
  741. <span class="tag">&lt;/properties&gt;</span>
  742. <span class="tag">&lt;parent&gt;</span> <span class="comment">&lt;!-- &lt;1&gt; --&gt;</span>
  743. <span class="tag">&lt;groupId&gt;</span>io.pivotal.workshop<span class="tag">&lt;/groupId&gt;</span>
  744. <span class="tag">&lt;artifactId&gt;</span>directory-web-client<span class="tag">&lt;/artifactId&gt;</span>
  745. <span class="tag">&lt;version&gt;</span>0.0.1-SNAPSHOT<span class="tag">&lt;/version&gt;</span>
  746. <span class="tag">&lt;relativePath&gt;</span>..<span class="tag">&lt;/relativePath&gt;</span>
  747. <span class="tag">&lt;/parent&gt;</span>
  748. <span class="tag">&lt;dependencies&gt;</span>
  749. <span class="tag">&lt;dependency&gt;</span>
  750. <span class="tag">&lt;groupId&gt;</span>io.pivotal.workshop<span class="tag">&lt;/groupId&gt;</span> <span class="comment">&lt;!-- &lt;2&gt; --&gt;</span>
  751. <span class="tag">&lt;artifactId&gt;</span>directory-web-client-spring-boot-autoconfigure<span class="tag">&lt;/artifactId&gt;</span>
  752. <span class="tag">&lt;version&gt;</span>0.0.1-SNAPSHOT<span class="tag">&lt;/version&gt;</span>
  753. <span class="tag">&lt;/dependency&gt;</span>
  754. <span class="tag">&lt;/dependencies&gt;</span>
  755. <span class="tag">&lt;/project&gt;</span></code></pre>
  756. </div>
  757. </div>
  758. <div class="colist arabic">
  759. <ol>
  760. <li>
  761. <p>See that we are using our parent pom.</p>
  762. </li>
  763. <li>
  764. <p>We are adding our <strong>auto-configuration</strong> app.</p>
  765. </li>
  766. </ol>
  767. </div>
  768. <div class="paragraph">
  769. <p>Thats it, the <strong>spring-boot-starter</strong> is just a <strong>pom.xml</strong> file that declares the <strong>auto-configuration</strong> dependency.</p>
  770. </div>
  771. </li>
  772. </ol>
  773. </div>
  774. </div>
  775. </div>
  776. <div class="sect1">
  777. <h2 id="_directory_web_client_spring_boot_autoconfigure">Directory Web Client Spring Boot Autoconfigure</h2>
  778. <div class="sectionbody">
  779. <div class="paragraph">
  780. <p>This project will have all the logic to be a reusable component in any project.</p>
  781. </div>
  782. <div class="olist arabic">
  783. <ol class="arabic">
  784. <li>
  785. <p>Open a browser and hit the url: <a href="http://start.spring.io" class="bare" target="_blank">http://start.spring.io</a></p>
  786. </li>
  787. <li>
  788. <p>Click the <strong><em>Switch to the full version</em></strong> link.</p>
  789. </li>
  790. <li>
  791. <p>Fill out the Directory Web Client Spring Boot Autoconfigure Project metadata with (See Figure 1.0):</p>
  792. <table class="tableblock frame-all grid-all spread">
  793. <caption class="title">Table 1. Directory Web Client Spring Boot Autoconfigure - metadata</caption>
  794. <colgroup>
  795. <col style="width: 16.6666%;">
  796. <col style="width: 83.3334%;">
  797. </colgroup>
  798. <thead>
  799. <tr>
  800. <th class="tableblock halign-left valign-top">Property</th>
  801. <th class="tableblock halign-left valign-top">Value</th>
  802. </tr>
  803. </thead>
  804. <tbody>
  805. <tr>
  806. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Group</strong>:</p></td>
  807. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>io.pivotal.workshop</em></p></td>
  808. </tr>
  809. <tr>
  810. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Artifact</strong>:</p></td>
  811. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>directory-web-client-spring-boot-autoconfigure</em></p></td>
  812. </tr>
  813. <tr>
  814. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Name</strong>:</p></td>
  815. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>directory-web-client-spring-boot-autoconfigure</em></p></td>
  816. </tr>
  817. <tr>
  818. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Package Name</strong>:</p></td>
  819. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>io.pivotal.workshop.directory</em></p></td>
  820. </tr>
  821. <tr>
  822. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Dependencies</strong>:</p></td>
  823. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>Web</em>, <em>HATEOAS</em>, <em>Security</em>, <em>Lombok</em>, <em>Configuration Processor</em></p></td>
  824. </tr>
  825. <tr>
  826. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Project Type</strong>:</p></td>
  827. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>Maven</em></p></td>
  828. </tr>
  829. <tr>
  830. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Spring Boot</strong>:</p></td>
  831. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>2.0.0.M7</em></p></td>
  832. </tr>
  833. </tbody>
  834. </table>
  835. <div class="paragraph">
  836. <div class="title">Figure 1.0: Spring Initializr - <a href="http://start.spring.io" class="bare" target="_blank">http://start.spring.io</a></div>
  837. <p><span class="image"><img src="images/14-spring-boot-extending-01.png" alt="SpringInitializr" title="Spring Initializr"></span></p>
  838. </div>
  839. </li>
  840. <li>
  841. <p>Type <strong>Web</strong>, <strong>HATEOAS</strong>, <strong>Security</strong>, <strong>Lombok</strong> and <strong>Configuration Processor</strong> in the <strong><em>Dependencies</em></strong> field and press Enter.</p>
  842. </li>
  843. <li>
  844. <p>Click the <strong><em>Generate Project</em></strong> button.</p>
  845. </li>
  846. <li>
  847. <p><strong>IMPORTANT</strong> Unzip the file in any directory you want and <strong>COPY the content</strong> in the <strong>workspace/directory-web-client-spring-boot-autoconfigure</strong> directory.</p>
  848. </li>
  849. <li>
  850. <p>Import your project in any IDE you want.</p>
  851. </li>
  852. <li>
  853. <p>Modify the <strong>pom.xml</strong> and make sure it looks like this:</p>
  854. <div class="listingblock">
  855. <div class="content">
  856. <pre class="CodeRay highlight"><code data-lang="xml"><span class="preprocessor">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
  857. <span class="tag">&lt;project</span> <span class="attribute-name">xmlns</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://maven.apache.org/POM/4.0.0</span><span class="delimiter">&quot;</span></span> <span class="attribute-name">xmlns:xsi</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://www.w3.org/2001/XMLSchema-instance</span><span class="delimiter">&quot;</span></span>
  858. <span class="attribute-name">xsi:schemaLocation</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
  859. <span class="tag">&lt;modelVersion&gt;</span>4.0.0<span class="tag">&lt;/modelVersion&gt;</span>
  860. <span class="tag">&lt;groupId&gt;</span>io.pivotal.workshop<span class="tag">&lt;/groupId&gt;</span>
  861. <span class="tag">&lt;artifactId&gt;</span>directory-web-client-spring-boot-autoconfigure<span class="tag">&lt;/artifactId&gt;</span>
  862. <span class="tag">&lt;version&gt;</span>0.0.1-SNAPSHOT<span class="tag">&lt;/version&gt;</span>
  863. <span class="tag">&lt;packaging&gt;</span>jar<span class="tag">&lt;/packaging&gt;</span>
  864. <span class="tag">&lt;name&gt;</span>directory-web-client-spring-boot-autoconfigure<span class="tag">&lt;/name&gt;</span>
  865. <span class="tag">&lt;description&gt;</span>Demo project for Spring Boot<span class="tag">&lt;/description&gt;</span>
  866. <span class="tag">&lt;properties&gt;</span>
  867. <span class="tag">&lt;project.build.sourceEncoding&gt;</span>UTF-8<span class="tag">&lt;/project.build.sourceEncoding&gt;</span>
  868. <span class="tag">&lt;project.reporting.outputEncoding&gt;</span>UTF-8<span class="tag">&lt;/project.reporting.outputEncoding&gt;</span>
  869. <span class="tag">&lt;java.version&gt;</span>1.8<span class="tag">&lt;/java.version&gt;</span>
  870. <span class="tag">&lt;/properties&gt;</span>
  871. <span class="tag">&lt;parent&gt;</span>
  872. <span class="tag">&lt;groupId&gt;</span>io.pivotal.workshop<span class="tag">&lt;/groupId&gt;</span>
  873. <span class="tag">&lt;artifactId&gt;</span>directory-web-client<span class="tag">&lt;/artifactId&gt;</span>
  874. <span class="tag">&lt;version&gt;</span>0.0.1-SNAPSHOT<span class="tag">&lt;/version&gt;</span>
  875. <span class="tag">&lt;relativePath&gt;</span>..<span class="tag">&lt;/relativePath&gt;</span>
  876. <span class="tag">&lt;/parent&gt;</span>
  877. <span class="tag">&lt;dependencies&gt;</span>
  878. <span class="tag">&lt;dependency&gt;</span>
  879. <span class="tag">&lt;groupId&gt;</span>org.projectlombok<span class="tag">&lt;/groupId&gt;</span>
  880. <span class="tag">&lt;artifactId&gt;</span>lombok<span class="tag">&lt;/artifactId&gt;</span>
  881. <span class="tag">&lt;/dependency&gt;</span>
  882. <span class="tag">&lt;dependency&gt;</span>
  883. <span class="tag">&lt;groupId&gt;</span>org.springframework.boot<span class="tag">&lt;/groupId&gt;</span>
  884. <span class="tag">&lt;artifactId&gt;</span>spring-boot-starter-security<span class="tag">&lt;/artifactId&gt;</span>
  885. <span class="tag">&lt;/dependency&gt;</span>
  886. <span class="tag">&lt;dependency&gt;</span>
  887. <span class="tag">&lt;groupId&gt;</span>org.springframework.hateoas<span class="tag">&lt;/groupId&gt;</span>
  888. <span class="tag">&lt;artifactId&gt;</span>spring-hateoas<span class="tag">&lt;/artifactId&gt;</span>
  889. <span class="tag">&lt;/dependency&gt;</span>
  890. <span class="tag">&lt;dependency&gt;</span>
  891. <span class="tag">&lt;groupId&gt;</span>org.springframework.boot<span class="tag">&lt;/groupId&gt;</span>
  892. <span class="tag">&lt;artifactId&gt;</span>spring-boot-starter-web<span class="tag">&lt;/artifactId&gt;</span>
  893. <span class="tag">&lt;/dependency&gt;</span>
  894. <span class="tag">&lt;dependency&gt;</span>
  895. <span class="tag">&lt;groupId&gt;</span>org.springframework.boot<span class="tag">&lt;/groupId&gt;</span>
  896. <span class="tag">&lt;artifactId&gt;</span>spring-boot-starter-test<span class="tag">&lt;/artifactId&gt;</span>
  897. <span class="tag">&lt;scope&gt;</span>test<span class="tag">&lt;/scope&gt;</span>
  898. <span class="tag">&lt;/dependency&gt;</span>
  899. <span class="tag">&lt;dependency&gt;</span>
  900. <span class="tag">&lt;groupId&gt;</span>org.springframework.security<span class="tag">&lt;/groupId&gt;</span>
  901. <span class="tag">&lt;artifactId&gt;</span>spring-security-test<span class="tag">&lt;/artifactId&gt;</span>
  902. <span class="tag">&lt;scope&gt;</span>test<span class="tag">&lt;/scope&gt;</span>
  903. <span class="tag">&lt;/dependency&gt;</span>
  904. <span class="tag">&lt;dependency&gt;</span>
  905. <span class="tag">&lt;groupId&gt;</span>org.springframework.boot<span class="tag">&lt;/groupId&gt;</span>
  906. <span class="tag">&lt;artifactId&gt;</span>spring-boot-configuration-processor<span class="tag">&lt;/artifactId&gt;</span>
  907. <span class="tag">&lt;optional&gt;</span>true<span class="tag">&lt;/optional&gt;</span>
  908. <span class="tag">&lt;/dependency&gt;</span>
  909. <span class="tag">&lt;/dependencies&gt;</span>
  910. <span class="tag">&lt;/project&gt;</span></code></pre>
  911. </div>
  912. </div>
  913. </li>
  914. <li>
  915. <p>Let&#8217;s start by telling <strong>Spring Boot</strong> where to go for the <strong>auto-configuration</strong>. Create in the <strong>src/main/resources</strong> directory, a new folder named: <strong>META-INF</strong> and inside this folder a file named: <strong>spring.factories</strong> with the following content:</p>
  916. <div class="listingblock">
  917. <div class="title">src/main/resources/META-INF/spring.factories</div>
  918. <div class="content">
  919. <pre class="CodeRay highlight"><code data-lang="properties">org.springframework.boot.autoconfigure.EnableAutoConfiguration=io.pivotal.workshop.directory.configuration.DirectoryWebClientAutoConfiguration</code></pre>
  920. </div>
  921. </div>
  922. <div class="paragraph">
  923. <p>Here we are declaring the class that will do the <strong>auto-configuration</strong>, in this case the <strong>io.pivotal.workshop.directory.configuration.DirectoryWebClientAutoConfiguration</strong> class.</p>
  924. </div>
  925. </li>
  926. <li>
  927. <p>Next let&#8217;s create the <strong>io.pivotal.workshop.directory.configuration.DirectoryWebClientAutoConfiguration</strong> class:</p>
  928. <div class="listingblock">
  929. <div class="title">src/main/java/io/pivotal/workshop/directory/configuration/DirectoryWebClientAutoConfiguration.java</div>
  930. <div class="content">
  931. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.configuration</span>;
  932. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.client.DirectoryWebClient</span>;
  933. <span class="keyword">import</span> <span class="include">org.slf4j.Logger</span>;
  934. <span class="keyword">import</span> <span class="include">org.slf4j.LoggerFactory</span>;
  935. <span class="keyword">import</span> <span class="include">org.springframework.boot.autoconfigure.condition.ConditionalOnClass</span>;
  936. <span class="keyword">import</span> <span class="include">org.springframework.boot.context.properties.EnableConfigurationProperties</span>;
  937. <span class="keyword">import</span> <span class="include">org.springframework.boot.web.client.RestTemplateBuilder</span>;
  938. <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Bean</span>;
  939. <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Configuration</span>;
  940. <span class="keyword">import</span> <span class="include">org.springframework.hateoas.Resource</span>;
  941. <span class="keyword">import</span> <span class="include">org.springframework.web.client.RestTemplate</span>;
  942. <span class="comment">//</span><b class="conum">(1)</b>
  943. <span class="annotation">@Configuration</span>
  944. <span class="annotation">@ConditionalOnClass</span>({Resource.class,RestTemplateBuilder.class})
  945. <span class="annotation">@EnableConfigurationProperties</span>(DirectoryWebClientProperties.class)
  946. <span class="directive">public</span> <span class="type">class</span> <span class="class">DirectoryWebClientAutoConfiguration</span> {
  947. <span class="directive">private</span> <span class="directive">final</span> <span class="predefined-type">Logger</span> log = LoggerFactory.getLogger(DirectoryWebClientAutoConfiguration.class);
  948. <span class="directive">private</span> DirectoryWebClientProperties webClientProperties;
  949. <span class="directive">private</span> RestTemplateBuilder restTemplateBuilder;
  950. <span class="comment">//</span><b class="conum">(2)</b>
  951. <span class="directive">public</span> DirectoryWebClientAutoConfiguration(DirectoryWebClientProperties webClientProperties, RestTemplateBuilder restTemplateBuilder) {
  952. <span class="local-variable">this</span>.webClientProperties = webClientProperties;
  953. <span class="local-variable">this</span>.restTemplateBuilder = restTemplateBuilder;
  954. }
  955. <span class="comment">//</span><b class="conum">(3)</b>
  956. <span class="annotation">@Bean</span>
  957. <span class="directive">public</span> DirectoryWebClient directoryClient(){
  958. log.info(<span class="string"><span class="delimiter">&quot;</span><span class="content">Creating a Directory Web Client...</span><span class="delimiter">&quot;</span></span>);
  959. <span class="keyword">return</span> <span class="keyword">new</span> DirectoryWebClient(restTemplate(),<span class="local-variable">this</span>.webClientProperties);
  960. }
  961. <span class="comment">//</span><b class="conum">(4)</b>
  962. <span class="annotation">@Bean</span>
  963. <span class="directive">public</span> RestTemplate restTemplate(){
  964. <span class="comment">// Make sure the directory-web-security has the httpBasic() security enabled and NOT the formLogin()</span>
  965. log.info(<span class="string"><span class="delimiter">&quot;</span><span class="content">Setting up admin credentials for Directory Web Client ...</span><span class="delimiter">&quot;</span></span>);
  966. <span class="keyword">return</span> <span class="local-variable">this</span>.restTemplateBuilder.basicAuthorization(webClientProperties.getUsername(),webClientProperties.getPassword()).build();
  967. }
  968. }</code></pre>
  969. </div>
  970. </div>
  971. <div class="colist arabic">
  972. <ol>
  973. <li>
  974. <p>This class is annotated with the <strong>@ConditionalOnClass</strong> that checks if in the classpath is the <strong>Resource</strong> and the <strong>RestTemplateBuilder</strong> classes, and if they do, then it will configure all the beans declared in this class.</p>
  975. </li>
  976. <li>
  977. <p>The constructor injects the <strong>DirectoryWebClientProperties</strong> and the <strong>RestTemplateBuilder</strong>. The <strong>DirectoryWebClientProperties</strong> will bring the username and password (the admin credentials for the <strong><em>directory-web-security</em></strong> app.), and the <strong>RestTemplateBuilder</strong> will create the <strong>RestTemplate</strong> instance, needed for do all the rest operations.</p>
  978. </li>
  979. <li>
  980. <p>The <strong>directoryClient</strong> is the one created to do all the rest operations over the <strong>directory-web-security</strong> app endpoints.</p>
  981. </li>
  982. <li>
  983. <p>This is the <strong>RestTeamplate</strong> that holds the <strong>administrator</strong> credentials so it can do all the <strong>Rest</strong> operations.</p>
  984. </li>
  985. </ol>
  986. </div>
  987. <div class="admonitionblock tip">
  988. <table>
  989. <tr>
  990. <td class="icon">
  991. <div class="title">Tip</div>
  992. </td>
  993. <td class="content">
  994. Is important to make sure the <strong><em>directory-web-security</em></strong> has the <strong><em>httpBasic()</em></strong> security enabled and <strong>NOT</strong> the <strong><em>formLogin()</em></strong>
  995. </td>
  996. </tr>
  997. </table>
  998. </div>
  999. </li>
  1000. <li>
  1001. <p>Create the <strong>io.pivotal.workshop.directory.configuration.DirectoryWebClientProperties</strong> class. This class will have the admin credentials and the uri of the <strong>directory-web-security</strong> app.:</p>
  1002. <div class="listingblock">
  1003. <div class="title">src/main/java/io/pivotal/workshop/directory/configuration/DirectoryWebClientProperties.java</div>
  1004. <div class="content">
  1005. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.configuration</span>;
  1006. <span class="keyword">import</span> <span class="include">lombok.Data</span>;
  1007. <span class="keyword">import</span> <span class="include">org.springframework.boot.context.properties.ConfigurationProperties</span>;
  1008. <span class="keyword">import</span> <span class="include">java.util.Arrays</span>;
  1009. <span class="keyword">import</span> <span class="include">java.util.List</span>;
  1010. <span class="annotation">@Data</span>
  1011. <span class="annotation">@ConfigurationProperties</span>(prefix = <span class="string"><span class="delimiter">&quot;</span><span class="content">directory.web.client</span><span class="delimiter">&quot;</span></span>)
  1012. <span class="directive">public</span> <span class="type">class</span> <span class="class">DirectoryWebClientProperties</span> {
  1013. <span class="predefined-type">String</span> username = <span class="string"><span class="delimiter">&quot;</span><span class="content">admin</span><span class="delimiter">&quot;</span></span>;
  1014. <span class="predefined-type">String</span> password = <span class="string"><span class="delimiter">&quot;</span><span class="content">admin</span><span class="delimiter">&quot;</span></span>;
  1015. <span class="predefined-type">String</span> uri = <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8585/api/persons</span><span class="delimiter">&quot;</span></span>;
  1016. }</code></pre>
  1017. </div>
  1018. </div>
  1019. <div class="paragraph">
  1020. <p>See that we are using the <strong>Lombok</strong> library (with the <strong>@Data</strong> annotation)so it can generate the setters and getters from the fields.</p>
  1021. </div>
  1022. </li>
  1023. <li>
  1024. <p>Next, let&#8217;s create the actual <strong>DirectoryWebClient</strong> class that will do all the <strong>Rest</strong> operations. Create the <strong>io.pivotal.workshop.directory.client.DirectoryWebClient</strong> class:</p>
  1025. <div class="listingblock">
  1026. <div class="title">src/main/java/io/pivotal/workshop/directory/client/DirectoryWebClient.java</div>
  1027. <div class="content">
  1028. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.client</span>;
  1029. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.configuration.DirectoryWebClientProperties</span>;
  1030. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.domain.Directory</span>;
  1031. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.domain.Person</span>;
  1032. <span class="keyword">import</span> <span class="include">org.springframework.core.ParameterizedTypeReference</span>;
  1033. <span class="keyword">import</span> <span class="include">org.springframework.hateoas.MediaTypes</span>;
  1034. <span class="keyword">import</span> <span class="include">org.springframework.hateoas.Resource</span>;
  1035. <span class="keyword">import</span> <span class="include">org.springframework.http.HttpStatus</span>;
  1036. <span class="keyword">import</span> <span class="include">org.springframework.http.RequestEntity</span>;
  1037. <span class="keyword">import</span> <span class="include">org.springframework.http.ResponseEntity</span>;
  1038. <span class="keyword">import</span> <span class="include">org.springframework.web.client.RestTemplate</span>;
  1039. <span class="keyword">import</span> <span class="include">java.util.Collection</span>;
  1040. <span class="keyword">import</span> <span class="include">java.util.Collections</span>;
  1041. <span class="keyword">import</span> <span class="include">static</span> <span class="include">java.net.URI.create</span>;
  1042. <span class="directive">public</span> <span class="type">class</span> <span class="class">DirectoryWebClient</span> {
  1043. <span class="directive">private</span> RestTemplate restTemplate;
  1044. <span class="directive">private</span> DirectoryWebClientProperties props;
  1045. <span class="directive">public</span> DirectoryWebClient(RestTemplate restTemplate, DirectoryWebClientProperties props){
  1046. <span class="local-variable">this</span>.restTemplate = restTemplate;
  1047. <span class="local-variable">this</span>.props = props;
  1048. }
  1049. <span class="directive">public</span> Person add(Person person){
  1050. ResponseEntity&lt;Resource&lt;Person&gt;&gt; response =
  1051. <span class="local-variable">this</span>.restTemplate.exchange(
  1052. RequestEntity.post(
  1053. create(<span class="local-variable">this</span>.props.getUri()))
  1054. .body(person)
  1055. ,<span class="keyword">new</span> ParameterizedTypeReference&lt;Resource&lt;Person&gt;&gt;() {});
  1056. <span class="keyword">return</span> response.getBody().getContent();
  1057. }
  1058. <span class="directive">public</span> <span class="predefined-type">Collection</span>&lt;Person&gt; getAll() {
  1059. ResponseEntity&lt;Resource&lt;Directory&gt;&gt; responseEntity =
  1060. <span class="local-variable">this</span>.restTemplate.exchange(RequestEntity.get(create(<span class="local-variable">this</span>.props.getUri()))
  1061. .accept(MediaTypes.HAL_JSON)
  1062. .build(),<span class="keyword">new</span> ParameterizedTypeReference&lt;Resource&lt;Directory&gt;&gt;() {});
  1063. <span class="keyword">if</span>(responseEntity.getStatusCode() == HttpStatus.OK) {
  1064. Directory company = responseEntity.getBody().getContent();
  1065. <span class="keyword">return</span> company.getEmbedded().getPersons();
  1066. }<span class="keyword">else</span>
  1067. <span class="keyword">return</span> <span class="predefined-type">Collections</span>.emptyList();
  1068. }
  1069. }</code></pre>
  1070. </div>
  1071. </div>
  1072. <div class="paragraph">
  1073. <p>See that it has (for now) two methods. To add a new person object to the directory and get all the persons in the directory. As you can see, is using a <strong>Directoy</strong> and <strong>Person</strong> domain classes.</p>
  1074. </div>
  1075. </li>
  1076. <li>
  1077. <p>Create the necessary domains, the <strong>io.pivotal.workshop.directory.domain.Directory</strong> and <strong>io.pivotal.workshop.directory.domain.Person</strong> classes, you can copy the <strong>Person</strong> class from the <strong>directory-web-security</strong> app, without the <strong>JPA</strong> annotations:</p>
  1078. <div class="listingblock">
  1079. <div class="title">src/main/java/io/pivotal/workshop/directory/domain/Directory.java</div>
  1080. <div class="content">
  1081. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.domain</span>;
  1082. <span class="keyword">import</span> <span class="include">com.fasterxml.jackson.annotation.JsonIgnoreProperties</span>;
  1083. <span class="keyword">import</span> <span class="include">com.fasterxml.jackson.annotation.JsonProperty</span>;
  1084. <span class="keyword">import</span> <span class="include">lombok.Data</span>;
  1085. <span class="keyword">import</span> <span class="include">java.util.List</span>;
  1086. <span class="annotation">@Data</span>
  1087. <span class="annotation">@JsonIgnoreProperties</span>(ignoreUnknown = <span class="predefined-constant">true</span>)
  1088. <span class="directive">public</span> <span class="type">class</span> <span class="class">Directory</span> {
  1089. <span class="annotation">@JsonProperty</span>(<span class="string"><span class="delimiter">&quot;</span><span class="content">_embedded</span><span class="delimiter">&quot;</span></span>)
  1090. <span class="directive">public</span> Embedded embedded;
  1091. <span class="annotation">@Data</span>
  1092. <span class="directive">public</span> <span class="type">class</span> <span class="class">Embedded</span> {
  1093. <span class="directive">public</span> <span class="predefined-type">List</span>&lt;Person&gt; persons;
  1094. }
  1095. }</code></pre>
  1096. </div>
  1097. </div>
  1098. <div class="listingblock">
  1099. <div class="title">src/main/java/io/pivotal/workshop/directory/domain/Person.java</div>
  1100. <div class="content">
  1101. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.domain</span>;
  1102. <span class="keyword">import</span> <span class="include">com.fasterxml.jackson.annotation.JsonIgnoreProperties</span>;
  1103. <span class="keyword">import</span> <span class="include">com.fasterxml.jackson.annotation.JsonProperty</span>;
  1104. <span class="keyword">import</span> <span class="include">lombok.AllArgsConstructor</span>;
  1105. <span class="keyword">import</span> <span class="include">lombok.Data</span>;
  1106. <span class="keyword">import</span> <span class="include">lombok.NoArgsConstructor</span>;
  1107. <span class="keyword">import</span> <span class="include">java.text.ParseException</span>;
  1108. <span class="keyword">import</span> <span class="include">java.text.SimpleDateFormat</span>;
  1109. <span class="keyword">import</span> <span class="include">java.util.Date</span>;
  1110. <span class="annotation">@JsonIgnoreProperties</span>(ignoreUnknown = <span class="predefined-constant">true</span>)
  1111. <span class="directive">public</span> <span class="type">class</span> <span class="class">Person</span> {
  1112. <span class="directive">private</span> <span class="predefined-type">SimpleDateFormat</span> date = <span class="keyword">new</span> <span class="predefined-type">SimpleDateFormat</span>(<span class="string"><span class="delimiter">&quot;</span><span class="content">yyyy-MM-dd</span><span class="delimiter">&quot;</span></span>);
  1113. <span class="directive">private</span> <span class="predefined-type">String</span> id;
  1114. <span class="directive">private</span> <span class="predefined-type">String</span> email;
  1115. <span class="directive">private</span> <span class="predefined-type">String</span> name;
  1116. <span class="directive">private</span> <span class="predefined-type">String</span> password;
  1117. <span class="directive">private</span> <span class="predefined-type">String</span> role = <span class="string"><span class="delimiter">&quot;</span><span class="content">USER</span><span class="delimiter">&quot;</span></span>;
  1118. <span class="directive">private</span> <span class="type">boolean</span> enabled = <span class="predefined-constant">true</span>;
  1119. <span class="directive">private</span> <span class="predefined-type">Date</span> birthday;
  1120. <span class="directive">private</span> <span class="predefined-type">Date</span> created;
  1121. <span class="directive">private</span> <span class="predefined-type">Date</span> modified;
  1122. <span class="directive">public</span> Person() {
  1123. <span class="local-variable">this</span>.created = <span class="keyword">new</span> <span class="predefined-type">Date</span>();
  1124. <span class="local-variable">this</span>.modified = <span class="keyword">new</span> <span class="predefined-type">Date</span>();
  1125. }
  1126. <span class="directive">public</span> Person(<span class="predefined-type">String</span> email, <span class="predefined-type">String</span> name, <span class="predefined-type">String</span> password, <span class="predefined-type">String</span> birthday) {
  1127. <span class="local-variable">this</span>();
  1128. <span class="local-variable">this</span>.email = email;
  1129. <span class="local-variable">this</span>.name = name;
  1130. <span class="local-variable">this</span>.password = password;
  1131. <span class="keyword">try</span> {
  1132. <span class="local-variable">this</span>.birthday = date.parse(birthday);
  1133. } <span class="keyword">catch</span> (<span class="exception">ParseException</span> e) {
  1134. <span class="local-variable">this</span>.birthday = <span class="predefined-constant">null</span>;
  1135. }
  1136. }
  1137. <span class="directive">public</span> Person(<span class="predefined-type">String</span> email, <span class="predefined-type">String</span> name, <span class="predefined-type">String</span> password, <span class="predefined-type">Date</span> birthday) {
  1138. <span class="local-variable">this</span>();
  1139. <span class="local-variable">this</span>.email = email;
  1140. <span class="local-variable">this</span>.name = name;
  1141. <span class="local-variable">this</span>.password = password;
  1142. <span class="local-variable">this</span>.birthday = birthday;
  1143. }
  1144. <span class="directive">public</span> Person(<span class="predefined-type">String</span> email, <span class="predefined-type">String</span> name, <span class="predefined-type">String</span> password, <span class="predefined-type">String</span> birthday, <span class="predefined-type">String</span> role, <span class="type">boolean</span> enabled) {
  1145. <span class="local-variable">this</span>(email, name, password, birthday);
  1146. <span class="local-variable">this</span>.role = role;
  1147. <span class="local-variable">this</span>.enabled = enabled;
  1148. }
  1149. <span class="directive">public</span> <span class="predefined-type">String</span> getId() {
  1150. <span class="keyword">return</span> id;
  1151. }
  1152. <span class="directive">public</span> <span class="type">void</span> setId(<span class="predefined-type">String</span> id) {
  1153. <span class="local-variable">this</span>.id = id;
  1154. }
  1155. <span class="directive">public</span> <span class="predefined-type">String</span> getEmail() {
  1156. <span class="keyword">return</span> email;
  1157. }
  1158. <span class="directive">public</span> <span class="type">void</span> setEmail(<span class="predefined-type">String</span> email) {
  1159. <span class="local-variable">this</span>.email = email;
  1160. }
  1161. <span class="directive">public</span> <span class="predefined-type">String</span> getName() {
  1162. <span class="keyword">return</span> name;
  1163. }
  1164. <span class="directive">public</span> <span class="type">void</span> setName(<span class="predefined-type">String</span> name) {
  1165. <span class="local-variable">this</span>.name = name;
  1166. }
  1167. <span class="directive">public</span> <span class="predefined-type">String</span> getPassword() {
  1168. <span class="keyword">return</span> password;
  1169. }
  1170. <span class="directive">public</span> <span class="type">void</span> setPassword(<span class="predefined-type">String</span> password) {
  1171. <span class="local-variable">this</span>.password = password;
  1172. }
  1173. <span class="directive">public</span> <span class="predefined-type">Date</span> getBirthday() {
  1174. <span class="keyword">return</span> birthday;
  1175. }
  1176. <span class="directive">public</span> <span class="type">void</span> setBirthday(<span class="predefined-type">Date</span> birthday) {
  1177. <span class="local-variable">this</span>.birthday = birthday;
  1178. }
  1179. <span class="directive">public</span> <span class="predefined-type">Date</span> getCreated() {
  1180. <span class="keyword">return</span> created;
  1181. }
  1182. <span class="directive">public</span> <span class="predefined-type">Date</span> getModified() {
  1183. <span class="keyword">return</span> modified;
  1184. }
  1185. <span class="directive">public</span> <span class="predefined-type">String</span> getRole() {
  1186. <span class="keyword">return</span> role;
  1187. }
  1188. <span class="directive">public</span> <span class="type">void</span> setRole(<span class="predefined-type">String</span> role) {
  1189. <span class="local-variable">this</span>.role = role;
  1190. }
  1191. <span class="directive">public</span> <span class="type">boolean</span> isEnabled() {
  1192. <span class="keyword">return</span> enabled;
  1193. }
  1194. <span class="directive">public</span> <span class="type">void</span> setEnabled(<span class="type">boolean</span> enabled) {
  1195. <span class="local-variable">this</span>.enabled = enabled;
  1196. }
  1197. <span class="annotation">@Override</span>
  1198. <span class="directive">public</span> <span class="predefined-type">String</span> toString() {
  1199. <span class="keyword">return</span> <span class="string"><span class="delimiter">&quot;</span><span class="content">Person{</span><span class="delimiter">&quot;</span></span> +
  1200. <span class="string"><span class="delimiter">&quot;</span><span class="content">id='</span><span class="delimiter">&quot;</span></span> + id + <span class="string"><span class="delimiter">'</span><span class="char">\'</span><span class="delimiter">'</span></span> +
  1201. <span class="string"><span class="delimiter">&quot;</span><span class="content">, email='</span><span class="delimiter">&quot;</span></span> + email + <span class="string"><span class="delimiter">'</span><span class="char">\'</span><span class="delimiter">'</span></span> +
  1202. <span class="string"><span class="delimiter">&quot;</span><span class="content">, name='</span><span class="delimiter">&quot;</span></span> + name + <span class="string"><span class="delimiter">'</span><span class="char">\'</span><span class="delimiter">'</span></span> +
  1203. <span class="string"><span class="delimiter">&quot;</span><span class="content">, password='</span><span class="delimiter">&quot;</span></span> + password + <span class="string"><span class="delimiter">'</span><span class="char">\'</span><span class="delimiter">'</span></span> +
  1204. <span class="string"><span class="delimiter">&quot;</span><span class="content">, role='</span><span class="delimiter">&quot;</span></span> + role + <span class="string"><span class="delimiter">'</span><span class="char">\'</span><span class="delimiter">'</span></span> +
  1205. <span class="string"><span class="delimiter">&quot;</span><span class="content">, enabled=</span><span class="delimiter">&quot;</span></span> + enabled +
  1206. <span class="string"><span class="delimiter">&quot;</span><span class="content">, birthday=</span><span class="delimiter">&quot;</span></span> + birthday +
  1207. <span class="string"><span class="delimiter">&quot;</span><span class="content">, date=</span><span class="delimiter">&quot;</span></span> + date +
  1208. <span class="string"><span class="delimiter">&quot;</span><span class="content">, created=</span><span class="delimiter">&quot;</span></span> + created +
  1209. <span class="string"><span class="delimiter">&quot;</span><span class="content">, modified=</span><span class="delimiter">&quot;</span></span> + modified +
  1210. <span class="string"><span class="delimiter">'</span><span class="content">}</span><span class="delimiter">'</span></span>;
  1211. }
  1212. }</code></pre>
  1213. </div>
  1214. </div>
  1215. </li>
  1216. <li>
  1217. <p>Lets add the next feature, the <strong>@EnableDirectoryWebClientUtils</strong> that will create a <strong>DirectoryWebClientUtils</strong> bean depending of what algorithm was declared. Add the custom annotation <strong>io.pivotal.workshop.directory.annotation.EnableDirectoryWebClientUtils</strong> class and its dependency, the <strong>io.pivotal.workshop.directory.annotation.Algorithm</strong> enum:</p>
  1218. <div class="listingblock">
  1219. <div class="title">src/main/java/io/pivotal/workshop/directory/annotation/EnableDirectoryWebClientUtils.java</div>
  1220. <div class="content">
  1221. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.annotation</span>;
  1222. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.utils.DirectoryWebClientUtilsConfiguration</span>;
  1223. <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Import</span>;
  1224. <span class="keyword">import</span> <span class="include">java.lang.annotation.ElementType</span>;
  1225. <span class="keyword">import</span> <span class="include">java.lang.annotation.Retention</span>;
  1226. <span class="keyword">import</span> <span class="include">java.lang.annotation.RetentionPolicy</span>;
  1227. <span class="keyword">import</span> <span class="include">java.lang.annotation.Target</span>;
  1228. <span class="annotation">@Retention</span>(<span class="predefined-type">RetentionPolicy</span>.RUNTIME)
  1229. <span class="annotation">@Target</span>(<span class="predefined-type">ElementType</span>.TYPE)
  1230. <span class="annotation">@Import</span>(DirectoryWebClientUtilsConfiguration.class)
  1231. <span class="directive">public</span> <span class="annotation">@interface</span> EnableDirectoryWebClientUtils {
  1232. Algorithm algorithm() <span class="keyword">default</span> Algorithm.BCRYPT;
  1233. }</code></pre>
  1234. </div>
  1235. </div>
  1236. <div class="listingblock">
  1237. <div class="title">src/main/java/io/pivotal/workshop/directory/annotation/Algorithm.java</div>
  1238. <div class="content">
  1239. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.annotation</span>;
  1240. <span class="directive">public</span> <span class="type">enum</span> Algorithm {
  1241. BCRYPT, PBKDF2
  1242. }</code></pre>
  1243. </div>
  1244. </div>
  1245. </li>
  1246. <li>
  1247. <p>Next let&#8217;s create the configuration needed to create the <strong>DirectoryWebClientUtils</strong> bean. Create the <strong>io.pivotal.workshop.directory.utils.DirectoryWebClientUtilsConfiguration</strong> class. This class will implement the <strong>ImportSelector</strong> interface that will be picked up by <strong>Spring Boot</strong> during the <strong>auto-configuration</strong>. It will identify if the <strong>@EnableDirectoryWebClientUtils</strong> was declared in a <strong>@Configuration</strong> class and it will create the necessary beans.</p>
  1248. <div class="listingblock">
  1249. <div class="title">src/main/java/io/pivotal/workshop/directory/utils/DirectoryWebClientUtilsConfiguration.java</div>
  1250. <div class="content">
  1251. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.utils</span>;
  1252. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.annotation.Algorithm</span>;
  1253. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.annotation.EnableDirectoryWebClientUtils</span>;
  1254. <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.ImportSelector</span>;
  1255. <span class="keyword">import</span> <span class="include">org.springframework.core.annotation.AnnotationAttributes</span>;
  1256. <span class="keyword">import</span> <span class="include">org.springframework.core.type.AnnotationMetadata</span>;
  1257. <span class="directive">public</span> <span class="type">class</span> <span class="class">DirectoryWebClientUtilsConfiguration</span> <span class="directive">implements</span> ImportSelector {
  1258. <span class="directive">public</span> <span class="predefined-type">String</span><span class="type">[]</span> selectImports(AnnotationMetadata annotationMetadata) {
  1259. AnnotationAttributes attributes =
  1260. AnnotationAttributes.fromMap(
  1261. annotationMetadata.getAnnotationAttributes(EnableDirectoryWebClientUtils.class.getName(), <span class="predefined-constant">false</span>));
  1262. Algorithm algorithm = attributes.getEnum(<span class="string"><span class="delimiter">&quot;</span><span class="content">algorithm</span><span class="delimiter">&quot;</span></span>);
  1263. <span class="keyword">switch</span>(algorithm){
  1264. <span class="keyword">case</span> PBKDF2:
  1265. <span class="keyword">return</span> <span class="keyword">new</span> <span class="predefined-type">String</span><span class="type">[]</span> {<span class="string"><span class="delimiter">&quot;</span><span class="content">io.pivotal.workshop.directory.utils.Pbkdf2Encoder</span><span class="delimiter">&quot;</span></span>};
  1266. <span class="keyword">case</span> BCRYPT:
  1267. <span class="keyword">default</span>:
  1268. <span class="keyword">return</span> <span class="keyword">new</span> <span class="predefined-type">String</span><span class="type">[]</span> {<span class="string"><span class="delimiter">&quot;</span><span class="content">io.pivotal.workshop.directory.utils.BcryptEncoder</span><span class="delimiter">&quot;</span></span>};
  1269. }
  1270. }
  1271. }</code></pre>
  1272. </div>
  1273. </div>
  1274. <div class="paragraph">
  1275. <p>The <strong>DirectoryWebClientUtilsConfiguration</strong> will decide which class to configure based on the <strong>Algorithm</strong> selected.</p>
  1276. </div>
  1277. </li>
  1278. <li>
  1279. <p>Lets create the <strong>io.pivotal.workshop.directory.utils.BCryptEncoder</strong> and <strong>io.pivotal.workshop.directory.utils.Pbkdf2Encoder</strong> configuration classes. These classes will declare the <strong>DirectoryWebClientUtils</strong> bean and it will have the <strong>Algorithm</strong> selected.</p>
  1280. <div class="listingblock">
  1281. <div class="title">src/main/java/io/pivotal/workshop/directory/utils/BCryptEncoder.java</div>
  1282. <div class="content">
  1283. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.utils</span>;
  1284. <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Bean</span>;
  1285. <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Configuration</span>;
  1286. <span class="keyword">import</span> <span class="include">org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder</span>;
  1287. <span class="annotation">@Configuration</span>
  1288. <span class="directive">public</span> <span class="type">class</span> <span class="class">BCryptEncoder</span> {
  1289. <span class="annotation">@Bean</span>
  1290. <span class="directive">public</span> DirectoryWebClientUtils utils(){
  1291. <span class="keyword">return</span> <span class="keyword">new</span> DirectoryWebClientUtils(<span class="keyword">new</span> BCryptPasswordEncoder(<span class="integer">16</span>));
  1292. }
  1293. }</code></pre>
  1294. </div>
  1295. </div>
  1296. <div class="listingblock">
  1297. <div class="title">src/main/java/io/pivotal/workshop/directory/utils/Pbkdf2Encoder.java</div>
  1298. <div class="content">
  1299. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.utils</span>;
  1300. <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Bean</span>;
  1301. <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Configuration</span>;
  1302. <span class="keyword">import</span> <span class="include">org.springframework.security.crypto.password.Pbkdf2PasswordEncoder</span>;
  1303. <span class="annotation">@Configuration</span>
  1304. <span class="directive">public</span> <span class="type">class</span> <span class="class">Pbkdf2Encoder</span> {
  1305. <span class="annotation">@Bean</span>
  1306. <span class="directive">public</span> DirectoryWebClientUtils utils(){
  1307. <span class="keyword">return</span> <span class="keyword">new</span> DirectoryWebClientUtils(<span class="keyword">new</span> Pbkdf2PasswordEncoder());
  1308. }
  1309. }</code></pre>
  1310. </div>
  1311. </div>
  1312. </li>
  1313. <li>
  1314. <p>Next, create the <strong>io.pivotal.workshop.directory.utils.DirectoryWebClientUtils</strong> class that will be the bean created based on the <strong>Algorithm</strong> selected:</p>
  1315. <div class="listingblock">
  1316. <div class="title">src/main/java/io/pivotal/workshop/directory/utils/DirectoryWebClientUtils.java</div>
  1317. <div class="content">
  1318. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.utils</span>;
  1319. <span class="keyword">import</span> <span class="include">lombok.Data</span>;
  1320. <span class="keyword">import</span> <span class="include">org.springframework.security.crypto.password.PasswordEncoder</span>;
  1321. <span class="annotation">@Data</span>
  1322. <span class="directive">public</span> <span class="type">class</span> <span class="class">DirectoryWebClientUtils</span> {
  1323. <span class="directive">private</span> PasswordEncoder encoder;
  1324. <span class="directive">public</span> DirectoryWebClientUtils(PasswordEncoder encoder){
  1325. <span class="local-variable">this</span>.encoder = encoder;
  1326. }
  1327. }</code></pre>
  1328. </div>
  1329. </div>
  1330. </li>
  1331. </ol>
  1332. </div>
  1333. </div>
  1334. </div>
  1335. <div class="sect1">
  1336. <h2 id="_demo_starter">Demo Starter</h2>
  1337. <div class="sectionbody">
  1338. <div class="paragraph">
  1339. <p>This project will test the custom spring-boot-starter.</p>
  1340. </div>
  1341. <div class="olist arabic">
  1342. <ol class="arabic">
  1343. <li>
  1344. <p>Open a browser and hit the url: <a href="http://start.spring.io" class="bare" target="_blank">http://start.spring.io</a></p>
  1345. </li>
  1346. <li>
  1347. <p>Click the <strong><em>Switch to the full version</em></strong> link.</p>
  1348. </li>
  1349. <li>
  1350. <p>Fill out the Demo Starter Project metadata with (See Figure 1.0):</p>
  1351. <table class="tableblock frame-all grid-all spread">
  1352. <caption class="title">Table 2. Demo Starter - metadata</caption>
  1353. <colgroup>
  1354. <col style="width: 16.6666%;">
  1355. <col style="width: 83.3334%;">
  1356. </colgroup>
  1357. <thead>
  1358. <tr>
  1359. <th class="tableblock halign-left valign-top">Property</th>
  1360. <th class="tableblock halign-left valign-top">Value</th>
  1361. </tr>
  1362. </thead>
  1363. <tbody>
  1364. <tr>
  1365. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Group</strong>:</p></td>
  1366. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>io.pivotal.workshop</em></p></td>
  1367. </tr>
  1368. <tr>
  1369. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Artifact</strong>:</p></td>
  1370. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>demo-starter</em></p></td>
  1371. </tr>
  1372. <tr>
  1373. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Name</strong>:</p></td>
  1374. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>demo-starter</em></p></td>
  1375. </tr>
  1376. <tr>
  1377. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Package Name</strong>:</p></td>
  1378. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>io.pivotal.workshop</em></p></td>
  1379. </tr>
  1380. <tr>
  1381. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Project Type</strong>:</p></td>
  1382. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>Maven</em></p></td>
  1383. </tr>
  1384. <tr>
  1385. <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Spring Boot</strong>:</p></td>
  1386. <td class="tableblock halign-left valign-top"><p class="tableblock"><em>2.0.0.M7</em></p></td>
  1387. </tr>
  1388. </tbody>
  1389. </table>
  1390. <div class="paragraph">
  1391. <div class="title">Figure 1.0: Spring Initializr - <a href="http://start.spring.io" class="bare" target="_blank">http://start.spring.io</a></div>
  1392. <p><span class="image"><img src="images/14-spring-boot-extending-02.png" alt="SpringInitializr" title="Spring Initializr"></span></p>
  1393. </div>
  1394. </li>
  1395. <li>
  1396. <p>This is just a simple <strong>Spring Boot</strong> app, without any additional <strong><em>Dependencies</em></strong> from the <strong>Spring Initializr</strong>.</p>
  1397. </li>
  1398. <li>
  1399. <p>Click the <strong><em>Generate Project</em></strong> button.</p>
  1400. </li>
  1401. <li>
  1402. <p><strong>IMPORTANT</strong> Unzip the file in any directory you want and <strong>COPY the content</strong> in the <strong>workspace/demo-starter</strong> directory.</p>
  1403. </li>
  1404. <li>
  1405. <p>Import the project into your favorite IDE.</p>
  1406. </li>
  1407. <li>
  1408. <p>Add the <strong>directory-web-client-spring-boot-starter</strong> dependency to your <strong>pom.xml</strong>:</p>
  1409. <div class="listingblock">
  1410. <div class="content">
  1411. <pre class="CodeRay highlight"><code data-lang="xml"><span class="tag">&lt;dependency&gt;</span>
  1412. <span class="tag">&lt;groupId&gt;</span>io.pivotal.workshop<span class="tag">&lt;/groupId&gt;</span>
  1413. <span class="tag">&lt;artifactId&gt;</span>directory-web-client-spring-boot-starter<span class="tag">&lt;/artifactId&gt;</span>
  1414. <span class="tag">&lt;version&gt;</span>0.0.1-SNAPSHOT<span class="tag">&lt;/version&gt;</span>
  1415. <span class="tag">&lt;/dependency&gt;</span></code></pre>
  1416. </div>
  1417. </div>
  1418. </li>
  1419. <li>
  1420. <p>In the <strong>src/main/resources/application.properties</strong> file add the following properties:</p>
  1421. <div class="listingblock">
  1422. <div class="content">
  1423. <pre class="CodeRay highlight"><code data-lang="properties">directory.web.client.username=admin
  1424. directory.web.client.password=admin
  1425. directory.web.client.uri=http://localhost:8585/api/persons</code></pre>
  1426. </div>
  1427. </div>
  1428. <div class="paragraph">
  1429. <p>These are the defaul values, but this give us more flexibility if the <strong>directory-web-security</strong> app has different credentials or is running in a different port.</p>
  1430. </div>
  1431. </li>
  1432. <li>
  1433. <p>Next, we are ready to start testing. Make sure you have the <strong>directory-web-security</strong> running in the port <strong>8585</strong>.</p>
  1434. </li>
  1435. </ol>
  1436. </div>
  1437. <div class="sect2">
  1438. <h3 id="_testing_the_strong_directorywebclient_strong_bean">Testing the <strong>DirectoryWebClient</strong> bean</h3>
  1439. <div class="olist arabic">
  1440. <ol class="arabic">
  1441. <li>
  1442. <p>In your <strong>demo-starter</strong> project open the <strong>DemoStarterApplication</strong> class and add the following code:</p>
  1443. <div class="listingblock">
  1444. <div class="content">
  1445. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop</span>;
  1446. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.client.DirectoryWebClient</span>;
  1447. <span class="keyword">import</span> <span class="include">org.springframework.boot.ApplicationRunner</span>;
  1448. <span class="keyword">import</span> <span class="include">org.springframework.boot.SpringApplication</span>;
  1449. <span class="keyword">import</span> <span class="include">org.springframework.boot.autoconfigure.SpringBootApplication</span>;
  1450. <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Bean</span>;
  1451. <span class="annotation">@SpringBootApplication</span>
  1452. <span class="directive">public</span> <span class="type">class</span> <span class="class">DemoStarterApplication</span> {
  1453. <span class="directive">public</span> <span class="directive">static</span> <span class="type">void</span> main(<span class="predefined-type">String</span><span class="type">[]</span> args) {
  1454. SpringApplication.run(DemoStarterApplication.class, args);
  1455. }
  1456. <span class="annotation">@Bean</span>
  1457. ApplicationRunner getPersons(DirectoryWebClient client){
  1458. <span class="keyword">return</span> args -&gt; {
  1459. client.getAll().forEach(<span class="predefined-type">System</span>.out::println);
  1460. };
  1461. }
  1462. }</code></pre>
  1463. </div>
  1464. </div>
  1465. <div class="paragraph">
  1466. <p>In the above code we are using the <strong>DirectoryWebClient</strong> client and calling the <strong>getAll()</strong> method.</p>
  1467. </div>
  1468. </li>
  1469. <li>
  1470. <p>Run the application and you should see all the persons that are in the <strong>directory-web-security</strong> app.</p>
  1471. </li>
  1472. </ol>
  1473. </div>
  1474. <div class="admonitionblock tip">
  1475. <table>
  1476. <tr>
  1477. <td class="icon">
  1478. <div class="title">Tip</div>
  1479. </td>
  1480. <td class="content">
  1481. If you are using the command: <code>./mvnw spring-boot:run</code> remember that you need to do a: <code>./mvnw install</code> in the root folder (<strong><em>workspace</em></strong>), so the <strong>directory-web-client-spring-boot-starter</strong> and its dependencies get installed so they can be used.
  1482. </td>
  1483. </tr>
  1484. </table>
  1485. </div>
  1486. </div>
  1487. <div class="sect2">
  1488. <h3 id="_testing_the_strong_enabledirectorywebclientutils_strong_annotation">Testing the <strong>@EnableDirectoryWebClientUtils</strong> annotation.</h3>
  1489. <div class="olist arabic">
  1490. <ol class="arabic">
  1491. <li>
  1492. <p>In your <strong>demo-starter</strong> project open the <strong>DemoStarterApplication</strong> class and add the following code:</p>
  1493. <div class="listingblock">
  1494. <div class="content">
  1495. <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop</span>;
  1496. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.annotation.Algorithm</span>;
  1497. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.annotation.EnableDirectoryWebClientUtils</span>;
  1498. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.client.DirectoryWebClient</span>;
  1499. <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.utils.DirectoryWebClientUtils</span>;
  1500. <span class="keyword">import</span> <span class="include">org.springframework.boot.ApplicationRunner</span>;
  1501. <span class="keyword">import</span> <span class="include">org.springframework.boot.SpringApplication</span>;
  1502. <span class="keyword">import</span> <span class="include">org.springframework.boot.autoconfigure.SpringBootApplication</span>;
  1503. <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Bean</span>;
  1504. <span class="annotation">@EnableDirectoryWebClientUtils</span>(algorithm = Algorithm.PBKDF2)
  1505. <span class="annotation">@SpringBootApplication</span>
  1506. <span class="directive">public</span> <span class="type">class</span> <span class="class">DemoStarterApplication</span> {
  1507. <span class="directive">public</span> <span class="directive">static</span> <span class="type">void</span> main(<span class="predefined-type">String</span><span class="type">[]</span> args) {
  1508. SpringApplication.run(DemoStarterApplication.class, args);
  1509. }
  1510. <span class="annotation">@Bean</span>
  1511. ApplicationRunner getPersons(DirectoryWebClient client){
  1512. <span class="keyword">return</span> args -&gt; {
  1513. client.getAll().forEach(<span class="predefined-type">System</span>.out::println);
  1514. };
  1515. }
  1516. <span class="annotation">@Bean</span>
  1517. ApplicationRunner encode(DirectoryWebClientUtils utils){
  1518. <span class="keyword">return</span> args -&gt; {
  1519. <span class="predefined-type">String</span> text = <span class="string"><span class="delimiter">&quot;</span><span class="content">This text will be encrypted</span><span class="delimiter">&quot;</span></span>;
  1520. <span class="predefined-type">String</span> hash = utils.getEncoder().encode(text);
  1521. <span class="predefined-type">System</span>.out.println(<span class="string"><span class="delimiter">&quot;</span><span class="content">&gt;&gt;&gt; ENCRYPT: </span><span class="delimiter">&quot;</span></span> + hash);
  1522. <span class="predefined-type">System</span>.out.println(<span class="string"><span class="delimiter">&quot;</span><span class="content">&gt;&gt;&gt; Verify: </span><span class="delimiter">&quot;</span></span> + utils.getEncoder().matches(text,hash));
  1523. };
  1524. }
  1525. }</code></pre>
  1526. </div>
  1527. </div>
  1528. </li>
  1529. <li>
  1530. <p>Run the application and you will see the encrypted text.</p>
  1531. </li>
  1532. </ol>
  1533. </div>
  1534. <div class="paragraph">
  1535. <p><strong>CONGRATS!</strong> you have created your first custom <strong>spring-boot-starter</strong></p>
  1536. </div>
  1537. </div>
  1538. </div>
  1539. </div>
  1540. <div class="sect1">
  1541. <h2 id="_challenges">Challenges</h2>
  1542. <div class="sectionbody">
  1543. <div class="olist arabic">
  1544. <ol class="arabic">
  1545. <li>
  1546. <p>Comment out the <strong>@EnableDirectoryWebClientUtils</strong>, run the app again and see how the it fails because is looking for the <strong>DirectoryWebClientUtils</strong> bean. That&#8217;s the power of creating a <strong>@Enable</strong>* technology.</p>
  1547. </li>
  1548. <li>
  1549. <p>Add the code to add a new person using the <strong>DirectoryWebClient</strong> bean.</p>
  1550. </li>
  1551. </ol>
  1552. </div>
  1553. </div>
  1554. </div>
  1555. <div class="sect1">
  1556. <h2 id="_homework">HOMEWORK</h2>
  1557. <div class="sectionbody">
  1558. <div class="olist arabic">
  1559. <ol class="arabic">
  1560. <li>
  1561. <p>Create a Web app that has the <strong>CRUD</strong> (Create, Read, Up, Delete) Forms for all these actions. It will use the <strong>directory-web-client-spring-boot-starter</strong>:</p>
  1562. <div class="ulist">
  1563. <ul>
  1564. <li>
  1565. <p>It will encrypt the user password (TIP: You can use the <strong>DirectoryWebClientUtils</strong> bean)</p>
  1566. </li>
  1567. <li>
  1568. <p>Add all the missing logic for Update, Delete, etc to the <strong>directory-web-client-spring-boot-autoconfigure</strong> so it can be more reusable for this new web app.</p>
  1569. </li>
  1570. </ul>
  1571. </div>
  1572. </li>
  1573. </ol>
  1574. </div>
  1575. </div>
  1576. </div>
  1577. </div>
  1578. <div id="footer">
  1579. <div id="footer-text">
  1580. Last updated 2017-11-28 17:39:36 PST
  1581. </div>
  1582. </div>
  1583. </body>
  1584. </html>