123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="UTF-8">
- <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <meta name="generator" content="Asciidoctor 1.5.5">
- <title>Spring Boot - Creating a Custom Spring Boot Starter</title>
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
- <style>
- /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
- /* Remove comment around @import statement below when using as a custom stylesheet */
- /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
- article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
- audio,canvas,video{display:inline-block}
- audio:not([controls]){display:none;height:0}
- [hidden],template{display:none}
- script{display:none!important}
- html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
- a{background:transparent}
- a:focus{outline:thin dotted}
- a:active,a:hover{outline:0}
- h1{font-size:2em;margin:.67em 0}
- abbr[title]{border-bottom:1px dotted}
- b,strong{font-weight:bold}
- dfn{font-style:italic}
- hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
- mark{background:#ff0;color:#000}
- code,kbd,pre,samp{font-family:monospace;font-size:1em}
- pre{white-space:pre-wrap}
- q{quotes:"\201C" "\201D" "\2018" "\2019"}
- small{font-size:80%}
- sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
- sup{top:-.5em}
- sub{bottom:-.25em}
- img{border:0}
- svg:not(:root){overflow:hidden}
- figure{margin:0}
- fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
- legend{border:0;padding:0}
- button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
- button,input{line-height:normal}
- button,select{text-transform:none}
- button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
- button[disabled],html input[disabled]{cursor:default}
- input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
- input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
- input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
- button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
- textarea{overflow:auto;vertical-align:top}
- table{border-collapse:collapse;border-spacing:0}
- *,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
- html,body{font-size:100%}
- body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
- a:hover{cursor:pointer}
- img,object,embed{max-width:100%;height:auto}
- object,embed{height:100%}
- img{-ms-interpolation-mode:bicubic}
- .left{float:left!important}
- .right{float:right!important}
- .text-left{text-align:left!important}
- .text-right{text-align:right!important}
- .text-center{text-align:center!important}
- .text-justify{text-align:justify!important}
- .hide{display:none}
- img,object,svg{display:inline-block;vertical-align:middle}
- textarea{height:auto;min-height:50px}
- select{width:100%}
- .center{margin-left:auto;margin-right:auto}
- .spread{width:100%}
- p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
- .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
- div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
- a{color:#2156a5;text-decoration:underline;line-height:inherit}
- a:hover,a:focus{color:#1d4b8f}
- a img{border:none}
- p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
- p aside{font-size:.875em;line-height:1.35;font-style:italic}
- h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
- h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
- h1{font-size:2.125em}
- h2{font-size:1.6875em}
- h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
- h4,h5{font-size:1.125em}
- h6{font-size:1em}
- hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
- em,i{font-style:italic;line-height:inherit}
- strong,b{font-weight:bold;line-height:inherit}
- small{font-size:60%;line-height:inherit}
- code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
- ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
- ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em}
- ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
- ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
- ul.square{list-style-type:square}
- ul.circle{list-style-type:circle}
- ul.disc{list-style-type:disc}
- ul.no-bullet{list-style:none}
- ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
- dl dt{margin-bottom:.3125em;font-weight:bold}
- dl dd{margin-bottom:1.25em}
- abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
- abbr{text-transform:none}
- blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
- blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
- blockquote cite:before{content:"\2014 \0020"}
- blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
- blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
- @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
- h1{font-size:2.75em}
- h2{font-size:2.3125em}
- h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
- h4{font-size:1.4375em}}
- table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
- table thead,table tfoot{background:#f7f8f7;font-weight:bold}
- table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
- table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
- table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
- table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
- h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
- h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
- .clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
- .clearfix:after,.float-group:after{clear:both}
- *:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
- *:not(pre)>code.nobreak{word-wrap:normal}
- *:not(pre)>code.nowrap{white-space:nowrap}
- 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}
- em em{font-style:normal}
- strong strong{font-weight:400}
- .keyseq{color:rgba(51,51,51,.8)}
- kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
- .keyseq kbd:first-child{margin-left:0}
- .keyseq kbd:last-child{margin-right:0}
- .menuseq,.menu{color:rgba(0,0,0,.8)}
- b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
- b.button:before{content:"[";padding:0 3px 0 2px}
- b.button:after{content:"]";padding:0 2px 0 3px}
- p a>code:hover{color:rgba(0,0,0,.9)}
- #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
- #header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
- #header:after,#content:after,#footnotes:after,#footer:after{clear:both}
- #content{margin-top:1.25em}
- #content:before{content:none}
- #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
- #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
- #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
- #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
- #header .details span:first-child{margin-left:-.125em}
- #header .details span.email a{color:rgba(0,0,0,.85)}
- #header .details br{display:none}
- #header .details br+span:before{content:"\00a0\2013\00a0"}
- #header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
- #header .details br+span#revremark:before{content:"\00a0|\00a0"}
- #header #revnumber{text-transform:capitalize}
- #header #revnumber:after{content:"\00a0"}
- #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
- #toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
- #toc>ul{margin-left:.125em}
- #toc ul.sectlevel0>li>a{font-style:italic}
- #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
- #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
- #toc li{line-height:1.3334;margin-top:.3334em}
- #toc a{text-decoration:none}
- #toc a:active{text-decoration:underline}
- #toctitle{color:#7a2518;font-size:1.2em}
- @media only screen and (min-width:768px){#toctitle{font-size:1.375em}
- body.toc2{padding-left:15em;padding-right:0}
- #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
- #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
- #toc.toc2>ul{font-size:.9em;margin-bottom:0}
- #toc.toc2 ul ul{margin-left:0;padding-left:1em}
- #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
- body.toc2.toc-right{padding-left:0;padding-right:15em}
- body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
- @media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
- #toc.toc2{width:20em}
- #toc.toc2 #toctitle{font-size:1.375em}
- #toc.toc2>ul{font-size:.95em}
- #toc.toc2 ul ul{padding-left:1.25em}
- body.toc2.toc-right{padding-left:0;padding-right:20em}}
- #content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
- #content #toc>:first-child{margin-top:0}
- #content #toc>:last-child{margin-bottom:0}
- #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
- #footer-text{color:rgba(255,255,255,.8);line-height:1.44}
- .sect1{padding-bottom:.625em}
- @media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}
- .sect1+.sect1{border-top:1px solid #efefed}
- #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
- #content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
- #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
- #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
- #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
- .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
- .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
- table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
- .paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
- table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
- .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
- .admonitionblock>table td.icon{text-align:center;width:80px}
- .admonitionblock>table td.icon img{max-width:none}
- .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
- .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
- .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
- .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
- .exampleblock>.content>:first-child{margin-top:0}
- .exampleblock>.content>:last-child{margin-bottom:0}
- .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
- .sidebarblock>:first-child{margin-top:0}
- .sidebarblock>:last-child{margin-bottom:0}
- .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
- .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
- .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
- .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
- .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
- .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
- @media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
- @media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
- .literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
- .listingblock pre.highlightjs{padding:0}
- .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
- .listingblock pre.prettyprint{border-width:0}
- .listingblock>.content{position:relative}
- .listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
- .listingblock:hover code[data-lang]:before{display:block}
- .listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
- .listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
- table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
- table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
- table.pyhltable td.code{padding-left:.75em;padding-right:0}
- pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
- pre.pygments .lineno{display:inline-block;margin-right:.25em}
- table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
- .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
- .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
- .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
- .quoteblock blockquote{margin:0;padding:0;border:0}
- .quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
- .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
- .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
- .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
- .quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
- .quoteblock .quoteblock blockquote:before{display:none}
- .verseblock{margin:0 1em 1.25em 1em}
- .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
- .verseblock pre strong{font-weight:400}
- .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
- .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
- .quoteblock .attribution br,.verseblock .attribution br{display:none}
- .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
- .quoteblock.abstract{margin:0 0 1.25em 0;display:block}
- .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
- .quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
- table.tableblock{max-width:100%;border-collapse:separate}
- table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
- table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
- table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0}
- table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0}
- table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0}
- table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0}
- table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0}
- table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0}
- table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0}
- table.frame-all{border-width:1px}
- table.frame-sides{border-width:0 1px}
- table.frame-topbot{border-width:1px 0}
- th.halign-left,td.halign-left{text-align:left}
- th.halign-right,td.halign-right{text-align:right}
- th.halign-center,td.halign-center{text-align:center}
- th.valign-top,td.valign-top{vertical-align:top}
- th.valign-bottom,td.valign-bottom{vertical-align:bottom}
- th.valign-middle,td.valign-middle{vertical-align:middle}
- table thead th,table tfoot th{font-weight:bold}
- tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
- tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
- p.tableblock>code:only-child{background:none;padding:0}
- p.tableblock{font-size:1em}
- td>div.verse{white-space:pre}
- ol{margin-left:1.75em}
- ul li ol{margin-left:1.5em}
- dl dd{margin-left:1.125em}
- dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
- ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
- ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none}
- ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em}
- ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em}
- ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px}
- ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
- ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
- ul.inline>li>*{display:block}
- .unstyled dl dt{font-weight:400;font-style:normal}
- ol.arabic{list-style-type:decimal}
- ol.decimal{list-style-type:decimal-leading-zero}
- ol.loweralpha{list-style-type:lower-alpha}
- ol.upperalpha{list-style-type:upper-alpha}
- ol.lowerroman{list-style-type:lower-roman}
- ol.upperroman{list-style-type:upper-roman}
- ol.lowergreek{list-style-type:lower-greek}
- .hdlist>table,.colist>table{border:0;background:none}
- .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
- td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
- td.hdlist1{font-weight:bold;padding-bottom:1.25em}
- .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
- .colist>table tr>td:first-of-type{padding:0 .75em;line-height:1}
- .colist>table tr>td:last-of-type{padding:.25em 0}
- .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
- .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
- .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
- .imageblock>.title{margin-bottom:0}
- .imageblock.thumb,.imageblock.th{border-width:6px}
- .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
- .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
- .image.left{margin-right:.625em}
- .image.right{margin-left:.625em}
- a.image{text-decoration:none;display:inline-block}
- a.image object{pointer-events:none}
- sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
- sup.footnote a,sup.footnoteref a{text-decoration:none}
- sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
- #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
- #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
- #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em}
- #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
- #footnotes .footnote:last-of-type{margin-bottom:0}
- #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
- .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
- .gist .file-data>table td.line-data{width:99%}
- div.unbreakable{page-break-inside:avoid}
- .big{font-size:larger}
- .small{font-size:smaller}
- .underline{text-decoration:underline}
- .overline{text-decoration:overline}
- .line-through{text-decoration:line-through}
- .aqua{color:#00bfbf}
- .aqua-background{background-color:#00fafa}
- .black{color:#000}
- .black-background{background-color:#000}
- .blue{color:#0000bf}
- .blue-background{background-color:#0000fa}
- .fuchsia{color:#bf00bf}
- .fuchsia-background{background-color:#fa00fa}
- .gray{color:#606060}
- .gray-background{background-color:#7d7d7d}
- .green{color:#006000}
- .green-background{background-color:#007d00}
- .lime{color:#00bf00}
- .lime-background{background-color:#00fa00}
- .maroon{color:#600000}
- .maroon-background{background-color:#7d0000}
- .navy{color:#000060}
- .navy-background{background-color:#00007d}
- .olive{color:#606000}
- .olive-background{background-color:#7d7d00}
- .purple{color:#600060}
- .purple-background{background-color:#7d007d}
- .red{color:#bf0000}
- .red-background{background-color:#fa0000}
- .silver{color:#909090}
- .silver-background{background-color:#bcbcbc}
- .teal{color:#006060}
- .teal-background{background-color:#007d7d}
- .white{color:#bfbfbf}
- .white-background{background-color:#fafafa}
- .yellow{color:#bfbf00}
- .yellow-background{background-color:#fafa00}
- span.icon>.fa{cursor:default}
- .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
- .admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
- .admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
- .admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
- .admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
- .admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
- .conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
- .conum[data-value] *{color:#fff!important}
- .conum[data-value]+b{display:none}
- .conum[data-value]:after{content:attr(data-value)}
- pre .conum[data-value]{position:relative;top:-.125em}
- b.conum *{color:inherit!important}
- .conum:not([data-value]):empty{display:none}
- dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
- h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
- p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
- p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
- p{margin-bottom:1.25rem}
- .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
- .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
- .print-only{display:none!important}
- @media print{@page{margin:1.25cm .75cm}
- *{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
- a{color:inherit!important;text-decoration:underline!important}
- a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
- a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
- abbr[title]:after{content:" (" attr(title) ")"}
- pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
- thead{display:table-header-group}
- svg{max-width:100%}
- p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
- h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
- #toc,.sidebarblock,.exampleblock>.content{background:none!important}
- #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
- .sect1{padding-bottom:0!important}
- .sect1+.sect1{border:0!important}
- #header>h1:first-child{margin-top:1.25rem}
- body.book #header{text-align:center}
- body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
- body.book #header .details{border:0!important;display:block;padding:0!important}
- body.book #header .details span:first-child{margin-left:0!important}
- body.book #header .details br{display:block}
- body.book #header .details br+span:before{content:none!important}
- body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
- body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
- .listingblock code[data-lang]:before{display:block}
- #footer{background:none!important;padding:0 .9375em}
- #footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
- .hide-on-print{display:none!important}
- .print-only{display:block!important}
- .hide-for-print{display:none!important}
- .show-for-print{display:inherit!important}}
- </style>
- <style>
- /* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */
- /*pre.CodeRay {background-color:#f7f7f8;}*/
- .CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em}
- .CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)}
- .CodeRay .line-numbers strong{color:rgba(0,0,0,.4)}
- table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none}
- table.CodeRay td{vertical-align: top;line-height:1.45}
- table.CodeRay td.line-numbers{text-align:right}
- table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)}
- table.CodeRay td.code{padding:0 0 0 .5em}
- table.CodeRay td.code>pre{padding:0}
- .CodeRay .debug{color:#fff !important;background:#000080 !important}
- .CodeRay .annotation{color:#007}
- .CodeRay .attribute-name{color:#000080}
- .CodeRay .attribute-value{color:#700}
- .CodeRay .binary{color:#509}
- .CodeRay .comment{color:#998;font-style:italic}
- .CodeRay .char{color:#04d}
- .CodeRay .char .content{color:#04d}
- .CodeRay .char .delimiter{color:#039}
- .CodeRay .class{color:#458;font-weight:bold}
- .CodeRay .complex{color:#a08}
- .CodeRay .constant,.CodeRay .predefined-constant{color:#008080}
- .CodeRay .color{color:#099}
- .CodeRay .class-variable{color:#369}
- .CodeRay .decorator{color:#b0b}
- .CodeRay .definition{color:#099}
- .CodeRay .delimiter{color:#000}
- .CodeRay .doc{color:#970}
- .CodeRay .doctype{color:#34b}
- .CodeRay .doc-string{color:#d42}
- .CodeRay .escape{color:#666}
- .CodeRay .entity{color:#800}
- .CodeRay .error{color:#808}
- .CodeRay .exception{color:inherit}
- .CodeRay .filename{color:#099}
- .CodeRay .function{color:#900;font-weight:bold}
- .CodeRay .global-variable{color:#008080}
- .CodeRay .hex{color:#058}
- .CodeRay .integer,.CodeRay .float{color:#099}
- .CodeRay .include{color:#555}
- .CodeRay .inline{color:#000}
- .CodeRay .inline .inline{background:#ccc}
- .CodeRay .inline .inline .inline{background:#bbb}
- .CodeRay .inline .inline-delimiter{color:#d14}
- .CodeRay .inline-delimiter{color:#d14}
- .CodeRay .important{color:#555;font-weight:bold}
- .CodeRay .interpreted{color:#b2b}
- .CodeRay .instance-variable{color:#008080}
- .CodeRay .label{color:#970}
- .CodeRay .local-variable{color:#963}
- .CodeRay .octal{color:#40e}
- .CodeRay .predefined{color:#369}
- .CodeRay .preprocessor{color:#579}
- .CodeRay .pseudo-class{color:#555}
- .CodeRay .directive{font-weight:bold}
- .CodeRay .type{font-weight:bold}
- .CodeRay .predefined-type{color:inherit}
- .CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold}
- .CodeRay .key{color:#808}
- .CodeRay .key .delimiter{color:#606}
- .CodeRay .key .char{color:#80f}
- .CodeRay .value{color:#088}
- .CodeRay .regexp .delimiter{color:#808}
- .CodeRay .regexp .content{color:#808}
- .CodeRay .regexp .modifier{color:#808}
- .CodeRay .regexp .char{color:#d14}
- .CodeRay .regexp .function{color:#404;font-weight:bold}
- .CodeRay .string{color:#d20}
- .CodeRay .string .string .string{background:#ffd0d0}
- .CodeRay .string .content{color:#d14}
- .CodeRay .string .char{color:#d14}
- .CodeRay .string .delimiter{color:#d14}
- .CodeRay .shell{color:#d14}
- .CodeRay .shell .delimiter{color:#d14}
- .CodeRay .symbol{color:#990073}
- .CodeRay .symbol .content{color:#a60}
- .CodeRay .symbol .delimiter{color:#630}
- .CodeRay .tag{color:#008080}
- .CodeRay .tag-special{color:#d70}
- .CodeRay .variable{color:#036}
- .CodeRay .insert{background:#afa}
- .CodeRay .delete{background:#faa}
- .CodeRay .change{color:#aaf;background:#007}
- .CodeRay .head{color:#f8f;background:#505}
- .CodeRay .insert .insert{color:#080}
- .CodeRay .delete .delete{color:#800}
- .CodeRay .change .change{color:#66f}
- .CodeRay .head .head{color:#f4f}
- </style>
- <link rel="stylesheet"
- href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"
- integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u"
- crossorigin="anonymous">
- <link rel="stylesheet"
- href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap-theme.min.css"
- integrity="sha384-rHyoN1iRsVXV4nD0JutlnGaslCJuC7uwjduW9SVrLvRYooPp2bWYgmgJQIXwl/Sp"
- crossorigin="anonymous">
-
- <style>
- .c2cb{
- position: absolute; left: 0; top: 0;
- cursor: pointer
- }
- .c2cb:focus {
- outline: none;
- }
- body {
- font-size: 18px;
- }
-
- p {
- font-size: 18px;
- }
-
- td.content {
- font-size:2.0625rem;
- }
-
- div.title {
- font-size:2.0625rem;
- }
- </style>
-
- <script src="js/jquery-3.2.1.min.js"></script>
- <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js"></script>
- <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
- <script>
-
- $(function() {
- var button = $("<div style='padding: 10px;'><button data-toggle='tooltip' placement='right' data-trigger='click' title='Copied!' class='c2cb glyphicon glyphicon-copy'></button></div>");
- $(".listingblock > .content pre").prepend(button);
-
- $('[data-toggle="tooltip"]').tooltip();
-
- $('[data-toggle="tooltip"]').mouseout(function() {
- $(this).tooltip('hide');
- $(this).trigger('blur');
- });
-
- var clipboard = new Clipboard('.c2cb', {
- target: function(c2cb) {
- return $(c2cb).parent().siblings("code")[0];
- }
- });
- clipboard.on('success', function(e) {
- e.clearSelection();
- });
- });
-
- </script>
- </head>
- <body class="article toc2 toc-left">
- <div id="header">
- <h1><a id="spring-boot-security"></a>Spring Boot - Creating a Custom Spring Boot Starter</h1>
- <div id="toc" class="toc2">
- <div id="toctitle">Labs</div>
- <ul class="sectlevel1">
- <li><a href="#_spring_boot_starter">Spring Boot Starter</a></li>
- <li><a href="#_project_structure">Project Structure</a></li>
- <li><a href="#_directory_web_client_spring_boot_starter">Directory Web Client Spring Boot Starter</a></li>
- <li><a href="#_directory_web_client_spring_boot_autoconfigure">Directory Web Client Spring Boot Autoconfigure</a></li>
- <li><a href="#_demo_starter">Demo Starter</a>
- <ul class="sectlevel2">
- <li><a href="#_testing_the_strong_directorywebclient_strong_bean">Testing the <strong>DirectoryWebClient</strong> bean</a></li>
- <li><a href="#_testing_the_strong_enabledirectorywebclientutils_strong_annotation">Testing the <strong>@EnableDirectoryWebClientUtils</strong> annotation.</a></li>
- </ul>
- </li>
- <li><a href="#_challenges">Challenges</a></li>
- <li><a href="#_homework">HOMEWORK</a></li>
- </ul>
- </div>
- </div>
- <div id="content">
- <div id="preamble">
- <div class="sectionbody">
- <div class="paragraph">
- <p>You will create a custom <strong>Spring Boot Starter</strong> using the <strong>auto-configuration</strong> features.</p>
- </div>
- <div class="paragraph">
- <p><strong>Time:</strong> 30 minutes.</p>
- </div>
- <!-- toc disabled -->
- </div>
- </div>
- <div class="sect1">
- <h2 id="_spring_boot_starter">Spring Boot Starter</h2>
- <div class="sectionbody">
- <div class="paragraph">
- <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>
- </div>
- <div class="ulist">
- <ul>
- <li>
- <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>
- </li>
- <li>
- <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>
- </li>
- </ul>
- </div>
- </div>
- </div>
- <div class="sect1">
- <h2 id="_project_structure">Project Structure</h2>
- <div class="sectionbody">
- <div class="olist arabic">
- <ol class="arabic">
- <li>
- <p>Create a directory structure where we are going to place 3 apps:</p>
- <div class="ulist">
- <ul>
- <li>
- <p>demo-starter</p>
- </li>
- <li>
- <p>directory-web-client-spring-boot-autoconfigure</p>
- </li>
- <li>
- <p>directory-web-client-spring-boot-starter</p>
- <div class="listingblock">
- <div class="content">
- <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>
- </div>
- </div>
- </li>
- </ul>
- </div>
- </li>
- <li>
- <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>
- <div class="listingblock">
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="xml"><span class="preprocessor"><?xml version="1.0" encoding="UTF-8"?></span>
- <span class="tag"><project</span> <span class="attribute-name">xmlns</span>=<span class="string"><span class="delimiter">"</span><span class="content">http://maven.apache.org/POM/4.0.0</span><span class="delimiter">"</span></span> <span class="attribute-name">xmlns:xsi</span>=<span class="string"><span class="delimiter">"</span><span class="content">http://www.w3.org/2001/XMLSchema-instance</span><span class="delimiter">"</span></span>
- <span class="attribute-name">xsi:schemaLocation</span>=<span class="string"><span class="delimiter">"</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">"</span></span><span class="tag">></span>
- <span class="tag"><modelVersion></span>4.0.0<span class="tag"></modelVersion></span>
- <span class="tag"><groupId></span>io.pivotal.workshop<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>directory-web-client<span class="tag"></artifactId></span>
- <span class="tag"><version></span>0.0.1-SNAPSHOT<span class="tag"></version></span>
- <span class="tag"><packaging></span>pom<span class="tag"></packaging></span>
- <span class="tag"><name></span>directory-web-client<span class="tag"></name></span>
-
- <span class="tag"><modules></span>
- <span class="tag"><module></span>directory-web-client-spring-boot-autoconfigure<span class="tag"></module></span>
- <span class="tag"><module></span>directory-web-client-spring-boot-starter<span class="tag"></module></span>
- <span class="tag"><module></span>demo-starter<span class="tag"></module></span>
- <span class="tag"></modules></span>
-
-
-
- <span class="tag"><dependencyManagement></span>
- <span class="tag"><dependencies></span>
- <span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.springframework.boot<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>spring-boot-dependencies<span class="tag"></artifactId></span>
- <span class="tag"><version></span>2.0.0.M7<span class="tag"></version></span>
- <span class="tag"><type></span>pom<span class="tag"></type></span>
- <span class="tag"><scope></span>import<span class="tag"></scope></span>
- <span class="tag"></dependency></span>
- <span class="tag"></dependencies></span>
- <span class="tag"></dependencyManagement></span>
-
-
- <span class="tag"><repositories></span>
- <span class="tag"><repository></span>
- <span class="tag"><id></span>spring-snapshots<span class="tag"></id></span>
- <span class="tag"><name></span>Spring Snapshots<span class="tag"></name></span>
- <span class="tag"><url></span>https://repo.spring.io/snapshot<span class="tag"></url></span>
- <span class="tag"><snapshots></span>
- <span class="tag"><enabled></span>true<span class="tag"></enabled></span>
- <span class="tag"></snapshots></span>
- <span class="tag"></repository></span>
- <span class="tag"><repository></span>
- <span class="tag"><id></span>spring-milestones<span class="tag"></id></span>
- <span class="tag"><name></span>Spring Milestones<span class="tag"></name></span>
- <span class="tag"><url></span>https://repo.spring.io/milestone<span class="tag"></url></span>
- <span class="tag"><snapshots></span>
- <span class="tag"><enabled></span>false<span class="tag"></enabled></span>
- <span class="tag"></snapshots></span>
- <span class="tag"></repository></span>
- <span class="tag"></repositories></span>
-
- <span class="tag"><pluginRepositories></span>
- <span class="tag"><pluginRepository></span>
- <span class="tag"><id></span>spring-snapshots<span class="tag"></id></span>
- <span class="tag"><name></span>Spring Snapshots<span class="tag"></name></span>
- <span class="tag"><url></span>https://repo.spring.io/snapshot<span class="tag"></url></span>
- <span class="tag"><snapshots></span>
- <span class="tag"><enabled></span>true<span class="tag"></enabled></span>
- <span class="tag"></snapshots></span>
- <span class="tag"></pluginRepository></span>
- <span class="tag"><pluginRepository></span>
- <span class="tag"><id></span>spring-milestones<span class="tag"></id></span>
- <span class="tag"><name></span>Spring Milestones<span class="tag"></name></span>
- <span class="tag"><url></span>https://repo.spring.io/milestone<span class="tag"></url></span>
- <span class="tag"><snapshots></span>
- <span class="tag"><enabled></span>false<span class="tag"></enabled></span>
- <span class="tag"></snapshots></span>
- <span class="tag"></pluginRepository></span>
- <span class="tag"></pluginRepositories></span>
-
-
- <span class="tag"></project></span></code></pre>
- </div>
- </div>
- <div class="paragraph">
- <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>
- </div>
- </li>
- </ol>
- </div>
- </div>
- </div>
- <div class="sect1">
- <h2 id="_directory_web_client_spring_boot_starter">Directory Web Client Spring Boot Starter</h2>
- <div class="sectionbody">
- <div class="paragraph">
- <p>It’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>
- </div>
- <div class="olist arabic">
- <ol class="arabic">
- <li>
- <p>In the directory <strong>workspace/directory-web-client-spring-boot-starter</strong> add the following <strong>pom.xml</strong> file:</p>
- <div class="listingblock">
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="xml"><span class="preprocessor"><?xml version="1.0" encoding="UTF-8"?></span>
- <span class="tag"><project</span> <span class="attribute-name">xmlns</span>=<span class="string"><span class="delimiter">"</span><span class="content">http://maven.apache.org/POM/4.0.0</span><span class="delimiter">"</span></span> <span class="attribute-name">xmlns:xsi</span>=<span class="string"><span class="delimiter">"</span><span class="content">http://www.w3.org/2001/XMLSchema-instance</span><span class="delimiter">"</span></span>
- <span class="attribute-name">xsi:schemaLocation</span>=<span class="string"><span class="delimiter">"</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">"</span></span><span class="tag">></span>
- <span class="tag"><modelVersion></span>4.0.0<span class="tag"></modelVersion></span>
- <span class="tag"><groupId></span>io.pivotal.workshop<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>directory-web-client-spring-boot-starter<span class="tag"></artifactId></span>
- <span class="tag"><version></span>0.0.1-SNAPSHOT<span class="tag"></version></span>
- <span class="tag"><packaging></span>jar<span class="tag"></packaging></span>
-
- <span class="tag"><name></span>directory-web-client-spring-boot-starter<span class="tag"></name></span>
- <span class="tag"><description></span>Demo project for Spring Boot<span class="tag"></description></span>
-
- <span class="tag"><properties></span>
- <span class="tag"><project.build.sourceEncoding></span>UTF-8<span class="tag"></project.build.sourceEncoding></span>
- <span class="tag"><project.reporting.outputEncoding></span>UTF-8<span class="tag"></project.reporting.outputEncoding></span>
- <span class="tag"></properties></span>
-
- <span class="tag"><parent></span> <span class="comment"><!-- <1> --></span>
- <span class="tag"><groupId></span>io.pivotal.workshop<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>directory-web-client<span class="tag"></artifactId></span>
- <span class="tag"><version></span>0.0.1-SNAPSHOT<span class="tag"></version></span>
- <span class="tag"><relativePath></span>..<span class="tag"></relativePath></span>
- <span class="tag"></parent></span>
-
- <span class="tag"><dependencies></span>
- <span class="tag"><dependency></span>
- <span class="tag"><groupId></span>io.pivotal.workshop<span class="tag"></groupId></span> <span class="comment"><!-- <2> --></span>
- <span class="tag"><artifactId></span>directory-web-client-spring-boot-autoconfigure<span class="tag"></artifactId></span>
- <span class="tag"><version></span>0.0.1-SNAPSHOT<span class="tag"></version></span>
- <span class="tag"></dependency></span>
- <span class="tag"></dependencies></span>
-
-
-
- <span class="tag"></project></span></code></pre>
- </div>
- </div>
- <div class="colist arabic">
- <ol>
- <li>
- <p>See that we are using our parent pom.</p>
- </li>
- <li>
- <p>We are adding our <strong>auto-configuration</strong> app.</p>
- </li>
- </ol>
- </div>
- <div class="paragraph">
- <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>
- </div>
- </li>
- </ol>
- </div>
- </div>
- </div>
- <div class="sect1">
- <h2 id="_directory_web_client_spring_boot_autoconfigure">Directory Web Client Spring Boot Autoconfigure</h2>
- <div class="sectionbody">
- <div class="paragraph">
- <p>This project will have all the logic to be a reusable component in any project.</p>
- </div>
- <div class="olist arabic">
- <ol class="arabic">
- <li>
- <p>Open a browser and hit the url: <a href="http://start.spring.io" class="bare" target="_blank">http://start.spring.io</a></p>
- </li>
- <li>
- <p>Click the <strong><em>Switch to the full version</em></strong> link.</p>
- </li>
- <li>
- <p>Fill out the Directory Web Client Spring Boot Autoconfigure Project metadata with (See Figure 1.0):</p>
- <table class="tableblock frame-all grid-all spread">
- <caption class="title">Table 1. Directory Web Client Spring Boot Autoconfigure - metadata</caption>
- <colgroup>
- <col style="width: 16.6666%;">
- <col style="width: 83.3334%;">
- </colgroup>
- <thead>
- <tr>
- <th class="tableblock halign-left valign-top">Property</th>
- <th class="tableblock halign-left valign-top">Value</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Group</strong>:</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><em>io.pivotal.workshop</em></p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Artifact</strong>:</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><em>directory-web-client-spring-boot-autoconfigure</em></p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Name</strong>:</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><em>directory-web-client-spring-boot-autoconfigure</em></p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Package Name</strong>:</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><em>io.pivotal.workshop.directory</em></p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Dependencies</strong>:</p></td>
- <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>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Project Type</strong>:</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><em>Maven</em></p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Spring Boot</strong>:</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><em>2.0.0.M7</em></p></td>
- </tr>
- </tbody>
- </table>
- <div class="paragraph">
- <div class="title">Figure 1.0: Spring Initializr - <a href="http://start.spring.io" class="bare" target="_blank">http://start.spring.io</a></div>
- <p><span class="image"><img src="images/14-spring-boot-extending-01.png" alt="SpringInitializr" title="Spring Initializr"></span></p>
- </div>
- </li>
- <li>
- <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>
- </li>
- <li>
- <p>Click the <strong><em>Generate Project</em></strong> button.</p>
- </li>
- <li>
- <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>
- </li>
- <li>
- <p>Import your project in any IDE you want.</p>
- </li>
- <li>
- <p>Modify the <strong>pom.xml</strong> and make sure it looks like this:</p>
- <div class="listingblock">
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="xml"><span class="preprocessor"><?xml version="1.0" encoding="UTF-8"?></span>
- <span class="tag"><project</span> <span class="attribute-name">xmlns</span>=<span class="string"><span class="delimiter">"</span><span class="content">http://maven.apache.org/POM/4.0.0</span><span class="delimiter">"</span></span> <span class="attribute-name">xmlns:xsi</span>=<span class="string"><span class="delimiter">"</span><span class="content">http://www.w3.org/2001/XMLSchema-instance</span><span class="delimiter">"</span></span>
- <span class="attribute-name">xsi:schemaLocation</span>=<span class="string"><span class="delimiter">"</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">"</span></span><span class="tag">></span>
- <span class="tag"><modelVersion></span>4.0.0<span class="tag"></modelVersion></span>
-
- <span class="tag"><groupId></span>io.pivotal.workshop<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>directory-web-client-spring-boot-autoconfigure<span class="tag"></artifactId></span>
- <span class="tag"><version></span>0.0.1-SNAPSHOT<span class="tag"></version></span>
- <span class="tag"><packaging></span>jar<span class="tag"></packaging></span>
-
- <span class="tag"><name></span>directory-web-client-spring-boot-autoconfigure<span class="tag"></name></span>
- <span class="tag"><description></span>Demo project for Spring Boot<span class="tag"></description></span>
-
- <span class="tag"><properties></span>
- <span class="tag"><project.build.sourceEncoding></span>UTF-8<span class="tag"></project.build.sourceEncoding></span>
- <span class="tag"><project.reporting.outputEncoding></span>UTF-8<span class="tag"></project.reporting.outputEncoding></span>
- <span class="tag"><java.version></span>1.8<span class="tag"></java.version></span>
- <span class="tag"></properties></span>
-
- <span class="tag"><parent></span>
- <span class="tag"><groupId></span>io.pivotal.workshop<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>directory-web-client<span class="tag"></artifactId></span>
- <span class="tag"><version></span>0.0.1-SNAPSHOT<span class="tag"></version></span>
- <span class="tag"><relativePath></span>..<span class="tag"></relativePath></span>
- <span class="tag"></parent></span>
-
- <span class="tag"><dependencies></span>
-
- <span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.projectlombok<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>lombok<span class="tag"></artifactId></span>
- <span class="tag"></dependency></span>
- <span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.springframework.boot<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>spring-boot-starter-security<span class="tag"></artifactId></span>
- <span class="tag"></dependency></span>
-
- <span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.springframework.hateoas<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>spring-hateoas<span class="tag"></artifactId></span>
- <span class="tag"></dependency></span>
-
- <span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.springframework.boot<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>spring-boot-starter-web<span class="tag"></artifactId></span>
- <span class="tag"></dependency></span>
-
-
- <span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.springframework.boot<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>spring-boot-starter-test<span class="tag"></artifactId></span>
- <span class="tag"><scope></span>test<span class="tag"></scope></span>
- <span class="tag"></dependency></span>
- <span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.springframework.security<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>spring-security-test<span class="tag"></artifactId></span>
- <span class="tag"><scope></span>test<span class="tag"></scope></span>
- <span class="tag"></dependency></span>
-
- <span class="tag"><dependency></span>
- <span class="tag"><groupId></span>org.springframework.boot<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>spring-boot-configuration-processor<span class="tag"></artifactId></span>
- <span class="tag"><optional></span>true<span class="tag"></optional></span>
- <span class="tag"></dependency></span>
-
-
-
- <span class="tag"></dependencies></span>
-
-
- <span class="tag"></project></span></code></pre>
- </div>
- </div>
- </li>
- <li>
- <p>Let’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>
- <div class="listingblock">
- <div class="title">src/main/resources/META-INF/spring.factories</div>
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="properties">org.springframework.boot.autoconfigure.EnableAutoConfiguration=io.pivotal.workshop.directory.configuration.DirectoryWebClientAutoConfiguration</code></pre>
- </div>
- </div>
- <div class="paragraph">
- <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>
- </div>
- </li>
- <li>
- <p>Next let’s create the <strong>io.pivotal.workshop.directory.configuration.DirectoryWebClientAutoConfiguration</strong> class:</p>
- <div class="listingblock">
- <div class="title">src/main/java/io/pivotal/workshop/directory/configuration/DirectoryWebClientAutoConfiguration.java</div>
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.configuration</span>;
-
- <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.client.DirectoryWebClient</span>;
- <span class="keyword">import</span> <span class="include">org.slf4j.Logger</span>;
- <span class="keyword">import</span> <span class="include">org.slf4j.LoggerFactory</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.boot.autoconfigure.condition.ConditionalOnClass</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.boot.context.properties.EnableConfigurationProperties</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.boot.web.client.RestTemplateBuilder</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Bean</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Configuration</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.hateoas.Resource</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.web.client.RestTemplate</span>;
-
- <span class="comment">//</span><b class="conum">(1)</b>
- <span class="annotation">@Configuration</span>
- <span class="annotation">@ConditionalOnClass</span>({Resource.class,RestTemplateBuilder.class})
- <span class="annotation">@EnableConfigurationProperties</span>(DirectoryWebClientProperties.class)
- <span class="directive">public</span> <span class="type">class</span> <span class="class">DirectoryWebClientAutoConfiguration</span> {
-
- <span class="directive">private</span> <span class="directive">final</span> <span class="predefined-type">Logger</span> log = LoggerFactory.getLogger(DirectoryWebClientAutoConfiguration.class);
- <span class="directive">private</span> DirectoryWebClientProperties webClientProperties;
- <span class="directive">private</span> RestTemplateBuilder restTemplateBuilder;
-
- <span class="comment">//</span><b class="conum">(2)</b>
- <span class="directive">public</span> DirectoryWebClientAutoConfiguration(DirectoryWebClientProperties webClientProperties, RestTemplateBuilder restTemplateBuilder) {
- <span class="local-variable">this</span>.webClientProperties = webClientProperties;
- <span class="local-variable">this</span>.restTemplateBuilder = restTemplateBuilder;
- }
-
- <span class="comment">//</span><b class="conum">(3)</b>
- <span class="annotation">@Bean</span>
- <span class="directive">public</span> DirectoryWebClient directoryClient(){
- log.info(<span class="string"><span class="delimiter">"</span><span class="content">Creating a Directory Web Client...</span><span class="delimiter">"</span></span>);
- <span class="keyword">return</span> <span class="keyword">new</span> DirectoryWebClient(restTemplate(),<span class="local-variable">this</span>.webClientProperties);
- }
-
-
- <span class="comment">//</span><b class="conum">(4)</b>
- <span class="annotation">@Bean</span>
- <span class="directive">public</span> RestTemplate restTemplate(){
- <span class="comment">// Make sure the directory-web-security has the httpBasic() security enabled and NOT the formLogin()</span>
- log.info(<span class="string"><span class="delimiter">"</span><span class="content">Setting up admin credentials for Directory Web Client ...</span><span class="delimiter">"</span></span>);
- <span class="keyword">return</span> <span class="local-variable">this</span>.restTemplateBuilder.basicAuthorization(webClientProperties.getUsername(),webClientProperties.getPassword()).build();
- }
-
-
- }</code></pre>
- </div>
- </div>
- <div class="colist arabic">
- <ol>
- <li>
- <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>
- </li>
- <li>
- <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>
- </li>
- <li>
- <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>
- </li>
- <li>
- <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>
- </li>
- </ol>
- </div>
- <div class="admonitionblock tip">
- <table>
- <tr>
- <td class="icon">
- <div class="title">Tip</div>
- </td>
- <td class="content">
- 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>
- </td>
- </tr>
- </table>
- </div>
- </li>
- <li>
- <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>
- <div class="listingblock">
- <div class="title">src/main/java/io/pivotal/workshop/directory/configuration/DirectoryWebClientProperties.java</div>
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.configuration</span>;
-
- <span class="keyword">import</span> <span class="include">lombok.Data</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.boot.context.properties.ConfigurationProperties</span>;
-
- <span class="keyword">import</span> <span class="include">java.util.Arrays</span>;
- <span class="keyword">import</span> <span class="include">java.util.List</span>;
-
- <span class="annotation">@Data</span>
- <span class="annotation">@ConfigurationProperties</span>(prefix = <span class="string"><span class="delimiter">"</span><span class="content">directory.web.client</span><span class="delimiter">"</span></span>)
- <span class="directive">public</span> <span class="type">class</span> <span class="class">DirectoryWebClientProperties</span> {
-
- <span class="predefined-type">String</span> username = <span class="string"><span class="delimiter">"</span><span class="content">admin</span><span class="delimiter">"</span></span>;
- <span class="predefined-type">String</span> password = <span class="string"><span class="delimiter">"</span><span class="content">admin</span><span class="delimiter">"</span></span>;
- <span class="predefined-type">String</span> uri = <span class="string"><span class="delimiter">"</span><span class="content">http://localhost:8585/api/persons</span><span class="delimiter">"</span></span>;
-
- }</code></pre>
- </div>
- </div>
- <div class="paragraph">
- <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>
- </div>
- </li>
- <li>
- <p>Next, let’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>
- <div class="listingblock">
- <div class="title">src/main/java/io/pivotal/workshop/directory/client/DirectoryWebClient.java</div>
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.client</span>;
-
-
- <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.configuration.DirectoryWebClientProperties</span>;
- <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.domain.Directory</span>;
- <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.domain.Person</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.core.ParameterizedTypeReference</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.hateoas.MediaTypes</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.hateoas.Resource</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.http.HttpStatus</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.http.RequestEntity</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.http.ResponseEntity</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.web.client.RestTemplate</span>;
-
- <span class="keyword">import</span> <span class="include">java.util.Collection</span>;
- <span class="keyword">import</span> <span class="include">java.util.Collections</span>;
-
- <span class="keyword">import</span> <span class="include">static</span> <span class="include">java.net.URI.create</span>;
-
- <span class="directive">public</span> <span class="type">class</span> <span class="class">DirectoryWebClient</span> {
-
-
- <span class="directive">private</span> RestTemplate restTemplate;
- <span class="directive">private</span> DirectoryWebClientProperties props;
-
- <span class="directive">public</span> DirectoryWebClient(RestTemplate restTemplate, DirectoryWebClientProperties props){
- <span class="local-variable">this</span>.restTemplate = restTemplate;
- <span class="local-variable">this</span>.props = props;
- }
-
- <span class="directive">public</span> Person add(Person person){
- ResponseEntity<Resource<Person>> response =
- <span class="local-variable">this</span>.restTemplate.exchange(
- RequestEntity.post(
- create(<span class="local-variable">this</span>.props.getUri()))
- .body(person)
- ,<span class="keyword">new</span> ParameterizedTypeReference<Resource<Person>>() {});
-
- <span class="keyword">return</span> response.getBody().getContent();
- }
-
- <span class="directive">public</span> <span class="predefined-type">Collection</span><Person> getAll() {
-
- ResponseEntity<Resource<Directory>> responseEntity =
- <span class="local-variable">this</span>.restTemplate.exchange(RequestEntity.get(create(<span class="local-variable">this</span>.props.getUri()))
- .accept(MediaTypes.HAL_JSON)
- .build(),<span class="keyword">new</span> ParameterizedTypeReference<Resource<Directory>>() {});
-
- <span class="keyword">if</span>(responseEntity.getStatusCode() == HttpStatus.OK) {
- Directory company = responseEntity.getBody().getContent();
- <span class="keyword">return</span> company.getEmbedded().getPersons();
- }<span class="keyword">else</span>
- <span class="keyword">return</span> <span class="predefined-type">Collections</span>.emptyList();
- }
-
- }</code></pre>
- </div>
- </div>
- <div class="paragraph">
- <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>
- </div>
- </li>
- <li>
- <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>
- <div class="listingblock">
- <div class="title">src/main/java/io/pivotal/workshop/directory/domain/Directory.java</div>
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.domain</span>;
-
- <span class="keyword">import</span> <span class="include">com.fasterxml.jackson.annotation.JsonIgnoreProperties</span>;
- <span class="keyword">import</span> <span class="include">com.fasterxml.jackson.annotation.JsonProperty</span>;
- <span class="keyword">import</span> <span class="include">lombok.Data</span>;
-
- <span class="keyword">import</span> <span class="include">java.util.List</span>;
-
- <span class="annotation">@Data</span>
- <span class="annotation">@JsonIgnoreProperties</span>(ignoreUnknown = <span class="predefined-constant">true</span>)
- <span class="directive">public</span> <span class="type">class</span> <span class="class">Directory</span> {
-
- <span class="annotation">@JsonProperty</span>(<span class="string"><span class="delimiter">"</span><span class="content">_embedded</span><span class="delimiter">"</span></span>)
- <span class="directive">public</span> Embedded embedded;
-
- <span class="annotation">@Data</span>
- <span class="directive">public</span> <span class="type">class</span> <span class="class">Embedded</span> {
-
- <span class="directive">public</span> <span class="predefined-type">List</span><Person> persons;
-
- }
- }</code></pre>
- </div>
- </div>
- <div class="listingblock">
- <div class="title">src/main/java/io/pivotal/workshop/directory/domain/Person.java</div>
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.domain</span>;
-
-
- <span class="keyword">import</span> <span class="include">com.fasterxml.jackson.annotation.JsonIgnoreProperties</span>;
- <span class="keyword">import</span> <span class="include">com.fasterxml.jackson.annotation.JsonProperty</span>;
- <span class="keyword">import</span> <span class="include">lombok.AllArgsConstructor</span>;
- <span class="keyword">import</span> <span class="include">lombok.Data</span>;
- <span class="keyword">import</span> <span class="include">lombok.NoArgsConstructor</span>;
-
- <span class="keyword">import</span> <span class="include">java.text.ParseException</span>;
- <span class="keyword">import</span> <span class="include">java.text.SimpleDateFormat</span>;
- <span class="keyword">import</span> <span class="include">java.util.Date</span>;
-
- <span class="annotation">@JsonIgnoreProperties</span>(ignoreUnknown = <span class="predefined-constant">true</span>)
- <span class="directive">public</span> <span class="type">class</span> <span class="class">Person</span> {
-
-
- <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">"</span><span class="content">yyyy-MM-dd</span><span class="delimiter">"</span></span>);
-
- <span class="directive">private</span> <span class="predefined-type">String</span> id;
- <span class="directive">private</span> <span class="predefined-type">String</span> email;
- <span class="directive">private</span> <span class="predefined-type">String</span> name;
- <span class="directive">private</span> <span class="predefined-type">String</span> password;
- <span class="directive">private</span> <span class="predefined-type">String</span> role = <span class="string"><span class="delimiter">"</span><span class="content">USER</span><span class="delimiter">"</span></span>;
- <span class="directive">private</span> <span class="type">boolean</span> enabled = <span class="predefined-constant">true</span>;
- <span class="directive">private</span> <span class="predefined-type">Date</span> birthday;
- <span class="directive">private</span> <span class="predefined-type">Date</span> created;
- <span class="directive">private</span> <span class="predefined-type">Date</span> modified;
-
- <span class="directive">public</span> Person() {
- <span class="local-variable">this</span>.created = <span class="keyword">new</span> <span class="predefined-type">Date</span>();
- <span class="local-variable">this</span>.modified = <span class="keyword">new</span> <span class="predefined-type">Date</span>();
- }
-
- <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="local-variable">this</span>();
- <span class="local-variable">this</span>.email = email;
- <span class="local-variable">this</span>.name = name;
- <span class="local-variable">this</span>.password = password;
-
- <span class="keyword">try</span> {
- <span class="local-variable">this</span>.birthday = date.parse(birthday);
- } <span class="keyword">catch</span> (<span class="exception">ParseException</span> e) {
- <span class="local-variable">this</span>.birthday = <span class="predefined-constant">null</span>;
- }
- }
-
- <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) {
- <span class="local-variable">this</span>();
- <span class="local-variable">this</span>.email = email;
- <span class="local-variable">this</span>.name = name;
- <span class="local-variable">this</span>.password = password;
- <span class="local-variable">this</span>.birthday = birthday;
- }
-
- <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) {
- <span class="local-variable">this</span>(email, name, password, birthday);
- <span class="local-variable">this</span>.role = role;
- <span class="local-variable">this</span>.enabled = enabled;
- }
-
- <span class="directive">public</span> <span class="predefined-type">String</span> getId() {
- <span class="keyword">return</span> id;
- }
-
- <span class="directive">public</span> <span class="type">void</span> setId(<span class="predefined-type">String</span> id) {
- <span class="local-variable">this</span>.id = id;
- }
-
- <span class="directive">public</span> <span class="predefined-type">String</span> getEmail() {
- <span class="keyword">return</span> email;
- }
-
- <span class="directive">public</span> <span class="type">void</span> setEmail(<span class="predefined-type">String</span> email) {
- <span class="local-variable">this</span>.email = email;
- }
-
- <span class="directive">public</span> <span class="predefined-type">String</span> getName() {
- <span class="keyword">return</span> name;
- }
-
- <span class="directive">public</span> <span class="type">void</span> setName(<span class="predefined-type">String</span> name) {
- <span class="local-variable">this</span>.name = name;
- }
-
- <span class="directive">public</span> <span class="predefined-type">String</span> getPassword() {
- <span class="keyword">return</span> password;
- }
-
- <span class="directive">public</span> <span class="type">void</span> setPassword(<span class="predefined-type">String</span> password) {
- <span class="local-variable">this</span>.password = password;
- }
-
- <span class="directive">public</span> <span class="predefined-type">Date</span> getBirthday() {
- <span class="keyword">return</span> birthday;
- }
-
- <span class="directive">public</span> <span class="type">void</span> setBirthday(<span class="predefined-type">Date</span> birthday) {
- <span class="local-variable">this</span>.birthday = birthday;
- }
-
- <span class="directive">public</span> <span class="predefined-type">Date</span> getCreated() {
- <span class="keyword">return</span> created;
- }
-
- <span class="directive">public</span> <span class="predefined-type">Date</span> getModified() {
- <span class="keyword">return</span> modified;
- }
-
- <span class="directive">public</span> <span class="predefined-type">String</span> getRole() {
- <span class="keyword">return</span> role;
- }
-
- <span class="directive">public</span> <span class="type">void</span> setRole(<span class="predefined-type">String</span> role) {
- <span class="local-variable">this</span>.role = role;
- }
-
- <span class="directive">public</span> <span class="type">boolean</span> isEnabled() {
- <span class="keyword">return</span> enabled;
- }
-
- <span class="directive">public</span> <span class="type">void</span> setEnabled(<span class="type">boolean</span> enabled) {
- <span class="local-variable">this</span>.enabled = enabled;
- }
-
- <span class="annotation">@Override</span>
- <span class="directive">public</span> <span class="predefined-type">String</span> toString() {
- <span class="keyword">return</span> <span class="string"><span class="delimiter">"</span><span class="content">Person{</span><span class="delimiter">"</span></span> +
- <span class="string"><span class="delimiter">"</span><span class="content">id='</span><span class="delimiter">"</span></span> + id + <span class="string"><span class="delimiter">'</span><span class="char">\'</span><span class="delimiter">'</span></span> +
- <span class="string"><span class="delimiter">"</span><span class="content">, email='</span><span class="delimiter">"</span></span> + email + <span class="string"><span class="delimiter">'</span><span class="char">\'</span><span class="delimiter">'</span></span> +
- <span class="string"><span class="delimiter">"</span><span class="content">, name='</span><span class="delimiter">"</span></span> + name + <span class="string"><span class="delimiter">'</span><span class="char">\'</span><span class="delimiter">'</span></span> +
- <span class="string"><span class="delimiter">"</span><span class="content">, password='</span><span class="delimiter">"</span></span> + password + <span class="string"><span class="delimiter">'</span><span class="char">\'</span><span class="delimiter">'</span></span> +
- <span class="string"><span class="delimiter">"</span><span class="content">, role='</span><span class="delimiter">"</span></span> + role + <span class="string"><span class="delimiter">'</span><span class="char">\'</span><span class="delimiter">'</span></span> +
- <span class="string"><span class="delimiter">"</span><span class="content">, enabled=</span><span class="delimiter">"</span></span> + enabled +
- <span class="string"><span class="delimiter">"</span><span class="content">, birthday=</span><span class="delimiter">"</span></span> + birthday +
- <span class="string"><span class="delimiter">"</span><span class="content">, date=</span><span class="delimiter">"</span></span> + date +
- <span class="string"><span class="delimiter">"</span><span class="content">, created=</span><span class="delimiter">"</span></span> + created +
- <span class="string"><span class="delimiter">"</span><span class="content">, modified=</span><span class="delimiter">"</span></span> + modified +
- <span class="string"><span class="delimiter">'</span><span class="content">}</span><span class="delimiter">'</span></span>;
- }
- }</code></pre>
- </div>
- </div>
- </li>
- <li>
- <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>
- <div class="listingblock">
- <div class="title">src/main/java/io/pivotal/workshop/directory/annotation/EnableDirectoryWebClientUtils.java</div>
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.annotation</span>;
-
-
- <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.utils.DirectoryWebClientUtilsConfiguration</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Import</span>;
-
- <span class="keyword">import</span> <span class="include">java.lang.annotation.ElementType</span>;
- <span class="keyword">import</span> <span class="include">java.lang.annotation.Retention</span>;
- <span class="keyword">import</span> <span class="include">java.lang.annotation.RetentionPolicy</span>;
- <span class="keyword">import</span> <span class="include">java.lang.annotation.Target</span>;
-
- <span class="annotation">@Retention</span>(<span class="predefined-type">RetentionPolicy</span>.RUNTIME)
- <span class="annotation">@Target</span>(<span class="predefined-type">ElementType</span>.TYPE)
- <span class="annotation">@Import</span>(DirectoryWebClientUtilsConfiguration.class)
- <span class="directive">public</span> <span class="annotation">@interface</span> EnableDirectoryWebClientUtils {
- Algorithm algorithm() <span class="keyword">default</span> Algorithm.BCRYPT;
- }</code></pre>
- </div>
- </div>
- <div class="listingblock">
- <div class="title">src/main/java/io/pivotal/workshop/directory/annotation/Algorithm.java</div>
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.annotation</span>;
-
- <span class="directive">public</span> <span class="type">enum</span> Algorithm {
- BCRYPT, PBKDF2
- }</code></pre>
- </div>
- </div>
- </li>
- <li>
- <p>Next let’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>
- <div class="listingblock">
- <div class="title">src/main/java/io/pivotal/workshop/directory/utils/DirectoryWebClientUtilsConfiguration.java</div>
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.utils</span>;
-
-
- <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.annotation.Algorithm</span>;
- <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.annotation.EnableDirectoryWebClientUtils</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.ImportSelector</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.core.annotation.AnnotationAttributes</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.core.type.AnnotationMetadata</span>;
-
- <span class="directive">public</span> <span class="type">class</span> <span class="class">DirectoryWebClientUtilsConfiguration</span> <span class="directive">implements</span> ImportSelector {
-
- <span class="directive">public</span> <span class="predefined-type">String</span><span class="type">[]</span> selectImports(AnnotationMetadata annotationMetadata) {
- AnnotationAttributes attributes =
- AnnotationAttributes.fromMap(
- annotationMetadata.getAnnotationAttributes(EnableDirectoryWebClientUtils.class.getName(), <span class="predefined-constant">false</span>));
- Algorithm algorithm = attributes.getEnum(<span class="string"><span class="delimiter">"</span><span class="content">algorithm</span><span class="delimiter">"</span></span>);
- <span class="keyword">switch</span>(algorithm){
- <span class="keyword">case</span> PBKDF2:
- <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">"</span><span class="content">io.pivotal.workshop.directory.utils.Pbkdf2Encoder</span><span class="delimiter">"</span></span>};
- <span class="keyword">case</span> BCRYPT:
- <span class="keyword">default</span>:
- <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">"</span><span class="content">io.pivotal.workshop.directory.utils.BcryptEncoder</span><span class="delimiter">"</span></span>};
- }
- }
- }</code></pre>
- </div>
- </div>
- <div class="paragraph">
- <p>The <strong>DirectoryWebClientUtilsConfiguration</strong> will decide which class to configure based on the <strong>Algorithm</strong> selected.</p>
- </div>
- </li>
- <li>
- <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>
- <div class="listingblock">
- <div class="title">src/main/java/io/pivotal/workshop/directory/utils/BCryptEncoder.java</div>
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.utils</span>;
-
- <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Bean</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Configuration</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder</span>;
-
- <span class="annotation">@Configuration</span>
- <span class="directive">public</span> <span class="type">class</span> <span class="class">BCryptEncoder</span> {
-
- <span class="annotation">@Bean</span>
- <span class="directive">public</span> DirectoryWebClientUtils utils(){
- <span class="keyword">return</span> <span class="keyword">new</span> DirectoryWebClientUtils(<span class="keyword">new</span> BCryptPasswordEncoder(<span class="integer">16</span>));
- }
- }</code></pre>
- </div>
- </div>
- <div class="listingblock">
- <div class="title">src/main/java/io/pivotal/workshop/directory/utils/Pbkdf2Encoder.java</div>
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.utils</span>;
-
- <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Bean</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Configuration</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.security.crypto.password.Pbkdf2PasswordEncoder</span>;
-
- <span class="annotation">@Configuration</span>
- <span class="directive">public</span> <span class="type">class</span> <span class="class">Pbkdf2Encoder</span> {
-
- <span class="annotation">@Bean</span>
- <span class="directive">public</span> DirectoryWebClientUtils utils(){
- <span class="keyword">return</span> <span class="keyword">new</span> DirectoryWebClientUtils(<span class="keyword">new</span> Pbkdf2PasswordEncoder());
- }
- }</code></pre>
- </div>
- </div>
- </li>
- <li>
- <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>
- <div class="listingblock">
- <div class="title">src/main/java/io/pivotal/workshop/directory/utils/DirectoryWebClientUtils.java</div>
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop.directory.utils</span>;
-
- <span class="keyword">import</span> <span class="include">lombok.Data</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.security.crypto.password.PasswordEncoder</span>;
-
-
- <span class="annotation">@Data</span>
- <span class="directive">public</span> <span class="type">class</span> <span class="class">DirectoryWebClientUtils</span> {
-
- <span class="directive">private</span> PasswordEncoder encoder;
-
- <span class="directive">public</span> DirectoryWebClientUtils(PasswordEncoder encoder){
- <span class="local-variable">this</span>.encoder = encoder;
- }
-
- }</code></pre>
- </div>
- </div>
- </li>
- </ol>
- </div>
- </div>
- </div>
- <div class="sect1">
- <h2 id="_demo_starter">Demo Starter</h2>
- <div class="sectionbody">
- <div class="paragraph">
- <p>This project will test the custom spring-boot-starter.</p>
- </div>
- <div class="olist arabic">
- <ol class="arabic">
- <li>
- <p>Open a browser and hit the url: <a href="http://start.spring.io" class="bare" target="_blank">http://start.spring.io</a></p>
- </li>
- <li>
- <p>Click the <strong><em>Switch to the full version</em></strong> link.</p>
- </li>
- <li>
- <p>Fill out the Demo Starter Project metadata with (See Figure 1.0):</p>
- <table class="tableblock frame-all grid-all spread">
- <caption class="title">Table 2. Demo Starter - metadata</caption>
- <colgroup>
- <col style="width: 16.6666%;">
- <col style="width: 83.3334%;">
- </colgroup>
- <thead>
- <tr>
- <th class="tableblock halign-left valign-top">Property</th>
- <th class="tableblock halign-left valign-top">Value</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Group</strong>:</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><em>io.pivotal.workshop</em></p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Artifact</strong>:</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><em>demo-starter</em></p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Name</strong>:</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><em>demo-starter</em></p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Package Name</strong>:</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><em>io.pivotal.workshop</em></p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Project Type</strong>:</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><em>Maven</em></p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Spring Boot</strong>:</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock"><em>2.0.0.M7</em></p></td>
- </tr>
- </tbody>
- </table>
- <div class="paragraph">
- <div class="title">Figure 1.0: Spring Initializr - <a href="http://start.spring.io" class="bare" target="_blank">http://start.spring.io</a></div>
- <p><span class="image"><img src="images/14-spring-boot-extending-02.png" alt="SpringInitializr" title="Spring Initializr"></span></p>
- </div>
- </li>
- <li>
- <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>
- </li>
- <li>
- <p>Click the <strong><em>Generate Project</em></strong> button.</p>
- </li>
- <li>
- <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>
- </li>
- <li>
- <p>Import the project into your favorite IDE.</p>
- </li>
- <li>
- <p>Add the <strong>directory-web-client-spring-boot-starter</strong> dependency to your <strong>pom.xml</strong>:</p>
- <div class="listingblock">
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><dependency></span>
- <span class="tag"><groupId></span>io.pivotal.workshop<span class="tag"></groupId></span>
- <span class="tag"><artifactId></span>directory-web-client-spring-boot-starter<span class="tag"></artifactId></span>
- <span class="tag"><version></span>0.0.1-SNAPSHOT<span class="tag"></version></span>
- <span class="tag"></dependency></span></code></pre>
- </div>
- </div>
- </li>
- <li>
- <p>In the <strong>src/main/resources/application.properties</strong> file add the following properties:</p>
- <div class="listingblock">
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="properties">directory.web.client.username=admin
- directory.web.client.password=admin
- directory.web.client.uri=http://localhost:8585/api/persons</code></pre>
- </div>
- </div>
- <div class="paragraph">
- <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>
- </div>
- </li>
- <li>
- <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>
- </li>
- </ol>
- </div>
- <div class="sect2">
- <h3 id="_testing_the_strong_directorywebclient_strong_bean">Testing the <strong>DirectoryWebClient</strong> bean</h3>
- <div class="olist arabic">
- <ol class="arabic">
- <li>
- <p>In your <strong>demo-starter</strong> project open the <strong>DemoStarterApplication</strong> class and add the following code:</p>
- <div class="listingblock">
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop</span>;
-
- <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.client.DirectoryWebClient</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.boot.ApplicationRunner</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.boot.SpringApplication</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.boot.autoconfigure.SpringBootApplication</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Bean</span>;
-
- <span class="annotation">@SpringBootApplication</span>
- <span class="directive">public</span> <span class="type">class</span> <span class="class">DemoStarterApplication</span> {
-
- <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) {
- SpringApplication.run(DemoStarterApplication.class, args);
- }
-
- <span class="annotation">@Bean</span>
- ApplicationRunner getPersons(DirectoryWebClient client){
- <span class="keyword">return</span> args -> {
- client.getAll().forEach(<span class="predefined-type">System</span>.out::println);
- };
- }
-
- }</code></pre>
- </div>
- </div>
- <div class="paragraph">
- <p>In the above code we are using the <strong>DirectoryWebClient</strong> client and calling the <strong>getAll()</strong> method.</p>
- </div>
- </li>
- <li>
- <p>Run the application and you should see all the persons that are in the <strong>directory-web-security</strong> app.</p>
- </li>
- </ol>
- </div>
- <div class="admonitionblock tip">
- <table>
- <tr>
- <td class="icon">
- <div class="title">Tip</div>
- </td>
- <td class="content">
- 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.
- </td>
- </tr>
- </table>
- </div>
- </div>
- <div class="sect2">
- <h3 id="_testing_the_strong_enabledirectorywebclientutils_strong_annotation">Testing the <strong>@EnableDirectoryWebClientUtils</strong> annotation.</h3>
- <div class="olist arabic">
- <ol class="arabic">
- <li>
- <p>In your <strong>demo-starter</strong> project open the <strong>DemoStarterApplication</strong> class and add the following code:</p>
- <div class="listingblock">
- <div class="content">
- <pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">io.pivotal.workshop</span>;
-
- <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.annotation.Algorithm</span>;
- <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.annotation.EnableDirectoryWebClientUtils</span>;
- <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.client.DirectoryWebClient</span>;
- <span class="keyword">import</span> <span class="include">io.pivotal.workshop.directory.utils.DirectoryWebClientUtils</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.boot.ApplicationRunner</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.boot.SpringApplication</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.boot.autoconfigure.SpringBootApplication</span>;
- <span class="keyword">import</span> <span class="include">org.springframework.context.annotation.Bean</span>;
-
- <span class="annotation">@EnableDirectoryWebClientUtils</span>(algorithm = Algorithm.PBKDF2)
- <span class="annotation">@SpringBootApplication</span>
- <span class="directive">public</span> <span class="type">class</span> <span class="class">DemoStarterApplication</span> {
-
- <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) {
- SpringApplication.run(DemoStarterApplication.class, args);
- }
-
- <span class="annotation">@Bean</span>
- ApplicationRunner getPersons(DirectoryWebClient client){
- <span class="keyword">return</span> args -> {
- client.getAll().forEach(<span class="predefined-type">System</span>.out::println);
- };
- }
-
- <span class="annotation">@Bean</span>
- ApplicationRunner encode(DirectoryWebClientUtils utils){
- <span class="keyword">return</span> args -> {
- <span class="predefined-type">String</span> text = <span class="string"><span class="delimiter">"</span><span class="content">This text will be encrypted</span><span class="delimiter">"</span></span>;
- <span class="predefined-type">String</span> hash = utils.getEncoder().encode(text);
- <span class="predefined-type">System</span>.out.println(<span class="string"><span class="delimiter">"</span><span class="content">>>> ENCRYPT: </span><span class="delimiter">"</span></span> + hash);
- <span class="predefined-type">System</span>.out.println(<span class="string"><span class="delimiter">"</span><span class="content">>>> Verify: </span><span class="delimiter">"</span></span> + utils.getEncoder().matches(text,hash));
- };
- }
-
- }</code></pre>
- </div>
- </div>
- </li>
- <li>
- <p>Run the application and you will see the encrypted text.</p>
- </li>
- </ol>
- </div>
- <div class="paragraph">
- <p><strong>CONGRATS!</strong> you have created your first custom <strong>spring-boot-starter</strong></p>
- </div>
- </div>
- </div>
- </div>
- <div class="sect1">
- <h2 id="_challenges">Challenges</h2>
- <div class="sectionbody">
- <div class="olist arabic">
- <ol class="arabic">
- <li>
- <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’s the power of creating a <strong>@Enable</strong>* technology.</p>
- </li>
- <li>
- <p>Add the code to add a new person using the <strong>DirectoryWebClient</strong> bean.</p>
- </li>
- </ol>
- </div>
- </div>
- </div>
- <div class="sect1">
- <h2 id="_homework">HOMEWORK</h2>
- <div class="sectionbody">
- <div class="olist arabic">
- <ol class="arabic">
- <li>
- <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>
- <div class="ulist">
- <ul>
- <li>
- <p>It will encrypt the user password (TIP: You can use the <strong>DirectoryWebClientUtils</strong> bean)</p>
- </li>
- <li>
- <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>
- </li>
- </ul>
- </div>
- </li>
- </ol>
- </div>
- </div>
- </div>
- </div>
- <div id="footer">
- <div id="footer-text">
- Last updated 2017-11-28 17:39:36 PST
- </div>
- </div>
- </body>
- </html>
|