From eedbec77dc765cfca21c5011d69bf459f4ca79bf Mon Sep 17 00:00:00 2001 From: Mark Pollack Date: Tue, 17 Jul 2012 17:50:14 -0400 Subject: [PATCH] SHL-23 - Create docbook based reference guide --- docs/src/reference/docbook/images/logo.png | Bin 0 -> 9627 bytes docs/src/reference/docbook/index.xml | 49 ++++---- .../docbook/introduction/introduction.xml | 15 +++ .../docbook/introduction/requirements.xml | 18 +++ docs/src/reference/docbook/preface.xml | 61 +++++++++- .../reference/dev-guide/dev-spring-shell.xml | 43 +++++++ .../reference/dev-guide/introduction.xml | 5 + .../docbook/reference/introduction.xml | 7 ++ .../src/reference/docbook/reference/shell.xml | 112 ++++++++++++++++++ .../docbook/samples/introduction.xml | 11 ++ .../docbook/samples/simple-application.xml | 19 +++ 11 files changed, 312 insertions(+), 28 deletions(-) create mode 100644 docs/src/reference/docbook/images/logo.png create mode 100644 docs/src/reference/docbook/introduction/introduction.xml create mode 100644 docs/src/reference/docbook/introduction/requirements.xml create mode 100644 docs/src/reference/docbook/reference/dev-guide/dev-spring-shell.xml create mode 100644 docs/src/reference/docbook/reference/dev-guide/introduction.xml create mode 100644 docs/src/reference/docbook/reference/introduction.xml create mode 100644 docs/src/reference/docbook/reference/shell.xml create mode 100644 docs/src/reference/docbook/samples/introduction.xml create mode 100644 docs/src/reference/docbook/samples/simple-application.xml diff --git a/docs/src/reference/docbook/images/logo.png b/docs/src/reference/docbook/images/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..a9f6d959e77f14eed6bdb750190ff83289279793 GIT binary patch literal 9627 zcmV;MC1l!(P)(_`g8%^e{{R4h=>PzAFaQARU;qF*m;eA5Z<1fd zMgRaMAxT6*RCwC#U1xk$#n(Q!?cQzaZAn5Jgfv14BoKO&UIGeIq**9Rvj8F*5ET&V zN)y3?iqbpMq&I;8fg~h>^v0%cw%;=Ehh0)PVRsV???304FI?`<&dxk@%5%=lUp$5vg)gpX^qM(a79G2Eh^GYio;+j` z|I-IsL;|`=|24@!A-9t69l3IpCkOzH$BDyNk0oRzHQC=L`G-WMRe??e7y$r)5wJ>HC$41o-F=;S!!NdSo5IR zi68oV`26qU?_tKHlef+syn5_b%3Yma13FD`tB8bc*D9gOl_upbe5yPqqM8S|FLbvb z+616R5sv2woOls?-U#upfi+x+zq;wj_RI0t3JWrU5&$UxgaBY(%#5mUQiMZ@=US4m z%PZNJl)KQtKJ{{%jA29*fEp+-DEJzx|9HgzcHzK|6F;1Zy9frY33-44&w^gNVB$y1 zr+kcISdCBVn4DWrVpy&m0qf~Bp{4ucCJ6q|itYOE=*?3rcCWb-e-&5*2*n_hK0_r7 zjA6l~k5)|i#OwzZ%0F1X9LEI!R8H|O4Dc52A7a=)$3!B4+@icfWpQzN3Bwow!vKK5 za0jWqoml4S(o8HA)nn;+gs|r?&E>V@$-D1B3u4 zDLY3;slAV@m!I5kSmaAF-G+&4ak(phUw{1SF|1yWmq*B6Eb;U38{DyPx7N|Jij`T1 zTur#S^7r+MQiZ+Les0W+{t>-vtd=KvX@{?!xSVj~X^8^k*sg86Eg8Q+KnVcg*v(TL z_HQcJX4NdmI1IAyNIqe1fgQqJd?uCS2ct z<=BHK5A(|k%eAUPWf6weN2;{(54*PJr0w>1$EjZyZI3M|$N*XbwH6|1)q}f_*!%Gh zG$k|#zIADeuL)d)RpWhlp4a=iz31aH?e7EMfvd;X?A>rR@fNRD10WzMAPB$-s5;y{ z2Rsif13U)=)vi^$t@Ac^3~X1mov|z4*nRLjpoR51H2^#h7zP5`$HRB>OXFq^dEL#y z#q7I93uv&;vq1l7QiW69Dxgs$GllJDV=qqW{XZs(G6~{O=Cqi)vH^;4b^Ws;>5$0&X4YhW`jfm2kl6u20xii-Pq_Q|ftO3O?84j+zgx2V{9ab82B8=zAyjHI z^@RslXAXTmG4oM=&J(bA1PlYA=t)*`QdUX@{;caNAeLi}Ts(N{_PKel%>HcBqIzPQ zGL7=Rt&6`q{ynhFbB5H+AXkH&rTlYB?vs8Wj{5Gv79a>P@1`K&*w3cK`noqav&vQH zQwzSpfW*Meufi|_0hf~hxmuqJ0DAUmBa)F5SI^x1`#Qi$pv9Hij$^@~2b~6V8qjNi z(F4!b=o8S=)XYb@MFkCr?l2%Jkk}=p+j^#Kew$m>dUEyE9vOAZ|m_N4xHNqQisZ6Vhq6O#g1;S_AZW62OP&Z zjxQ`P$|=kPRVh%k$&O$E2CclAe={eydbI`*dYu`gMvx|LY7|it~ z90&r8ej7o8NcPR|8$y}~&K&Z3t*O*cT|4XI^^+jAuNK8{EU*UPIN*8H!mIGjXff2S zN}rFv#H{4uvEx$G9+&#i}dW#XG&7U%#C; zO3&u|yT0F$(Clex;hKY+0Z`>6=`^icw4OC=T4byC9*%C#c1}2kb3FI7RFUyC>;97m zCvKg)l@eE~DrH$#X6L+o$|rJXkGca5&cV(prvDJWimJeIT%*(6O1Yb@$kCUVf>30d z36cVqS+qSiqY<$mc)NI3ZRWGxt504y z01~@O@UjNr*Z|*Fc401#;Vj2)IsSd_(<~rJTkw}%m^(6dT*~A7 z^@0z8=j|L^hje_&jIW@Lds=p!z%BAZNL-v<^u3$iAYa$n53*)(oU*0ICm2TAhQ9|H z32Es`P_ZNox-RW|?p^%7hogIqH~l<({5*VmhIgGkVtTQv^iIm%;_}ik-;j{zf%RH< zgSU(4j(Ho*+Wo&$;x-)I_S>I(fO$5rB&97cU9e+mbV#I>meggki%OmXL6|g_R_)~C zId$N~DgDNV_yjc|_}7Jpg`8V?h^mDH1gKo2+JE`TCqI6Xou2^$p-~Oz znO*Vb{q%?H_HPEEsB%3Uv`!ALAB~^?=D>+{h51LWpUllquM2p8mni06Rs8Gm8+IYm;@!I8T^-2T(T?T!wv!04aRUy{2I zuKjfOw|cV~Bmf3H4-E5izp+==onH0E(guOAN}2?#B{+uLOYElfAOGv39TKTMAilyK zJbC-9&Y-XO_@*N})FlN_L2VlJzFq+*R~&qI5+OWsbe;~1S&@=I#L3LAqDj;rdn<3h2kwPvfq zGNJb?yB2H{3B|y%CdY^%zd5{}Ve4H~90xoXJ7w|ji+>36ZqZnssUHemL!-v^83S5% zg(vzTJ*lX?$V6Wh=I*(80BBLgcoHPFX4>+OE!);h^*@K*s}p~FE*;u>cpHeM02X*) z2+3%vIpcfFz!d>lm0rUD@QlLEQaVsZx5hCtr+8OZ(GDAiTO<&g++hH~2~Jaf;OfzT zKE*VsW8Yb$-lFsVR-EG)_^e+I|P z2{((2@+;XBt$J+VS7V|FH}D(H<1gcB*8AUn3_Nd!VYUY8D%~Sg@0zPi1uC`o$~18v z4lxLEfD!46jb+-~*0vMo6GVt*l@JutYxi!PvEjYc+_Zmq*VX%@-gb8L297g&_qNR9x(xNm>lg1_vRoVxX=*yk7Afcupv_pV)Uy!@toyyfz%# zmYJRimhU9M@uKo#Gb7350`N9;3&V)~(tS?SE&|dO1B~U>j|*0DyvC|VLVbfHL!v-a z{;W});n*$vzv(c$cg&}+tv|T+?A?p$1zG>Vyt>*u5AQq>DvFa4|0F-7F3T&HIe#{3 zF^>NWrRmNxCt5&P;;f44i_b`^q)0i=!?js-NMysm(M(hlpPsP!=nm^hZGwzXOJG=r zs-Aaec?|%v34ekzZJdEEbdW?U%1#hCt<=QjmHh7IJlXO_#6r=si3^86zOPo5n${9d zfJjnSUUKOCzC&k!qwJhq?VX#sGz;?y?$EMLbZ}&IH!o*9r@v!rBLmy-Ks*2fzozGu-drDbB6SUDFx#rK(a>R1N?<=kMVw5sLp7{B1tELtCnNe#~1P ze+ik%xyAWDZr;^Bux3^|e--Nv=Xh0N`8ii<-=}5A05A+AvP*t&vmYWLt%xD|wC(Zp z!tHNTwcf6t zAdvyj15N;r7b%O&wJIm6LoNIgyRs7ptxaC^sSHju3}ol-7`4Sbo~tc7}Hzc>1ej z!~2XTNfI12 z1O9tbJrRH$YpsXbYL65(1Wo*U-;_ytkHA5<-Qap0KFD8<-q8nT6lzkKnM~$ z4#DL+=Ldf{;?rMN{XKRL(E^&PgOcSD|6cGwe|)iT>6@R%^cfTA8-n2^XjGunfL>>!=l}r6ffh3yAG>AIR%5+SgQcjv z1T<<>j+N(J9GqoVdD#D|Py{8a7MB29F;iRa@lUrxA@o}Zy9DFl(&gc6bjUbytaBQN-MraK%e>R%$e$L zldD~Sk^F%iw=!? zvGCX0FBmF9Nt`GteR`$76pl^!OU!y?FxE5j$WCJK?&zwmUEEf`(BgB~Pwcx=O<{Q0 zj}Qy|pT!W?A&^BXp4SRV4+Ojsk$NVVw+YP_%IF?3;Vs%4EA0RPNGiK9mthzSqQW|5 z>xmyUWeQUn9LM>%d)J>f{SQjd@NOh6F@X;md`TTSXp)M|yz2F?*)bX-d_~%C!!N zA}RAE6hY<|=ESEb*5BZ*l)KvwZ39wZ(&;+QYrRL)FVrbj0N~^1-L^$|)k2=bmk#|{ ze<2S*YVMQ#!u)znC|-lcs~U6LC_>S#2iFc?KUwuzGlwx!I>dS}5JQLq1OmdjN*>ud zuQ$6e_rT@D7av?LRhK>YWrkyy{qoi0j6|TGC30BC$IXj0%axE+QHf&oXOr$czF${^ zkFrxIubN&~USh%@qqleU9Nm2cyl6rTgk!pm0FJ9f28K;rH*fvHtxAou_WK5w*?0L! z|Bpsx=BEKcSrq?P2G|&8;25nzYfJethVwl4<=%~hBVVf6NQ>jNr{il$xeEak*v3DB zO)Der@%@;k6Ee~gfD*P1?$D=g_pYIxI)_A7Y|^PzdwT63x6f@ky5rQ1la(7>5CT%r zEiAfj10zU!9N%yLu*Ku&Pkw2a5ebA&}??89~ zWm4Z)*B#oLll#P!%p@tDUOjjHoS)AAIyiDbs85iGle>$ZbLP{mr0kSq*H50gbp{Zs zzlxw5{z#I-07HNP!^*X)lJe5#ZeAHVsn)AN`d0ka?@#|abI8=nKv>o8*dv|? z49hDnxRnx@SDcTu>T27W4cY*|uz?->)~gvL#meG$znQ;!|2Lh3BEx)xMYJd}Gx_GD z+X?9jz_KRr0f1K1GO*qJmuJC?DXtDKpNxBd+LzNS3!?}U2=eyBo44byfk-N(ghEQ7 z(Q8?)8h94W)_7NE*Q?>Lh1~bvlXwGT031i^@*-u4zlYBy-Ud1z0|Z|m{`S=#F-|f^ z(>D=zo{r;^azD1lej*H`03!`-fzdZWzzHe2g%$ZcLQhK+KnYCKFQ7p{^Bh}LrYI^Y zc<|^pAR~u`0K-i?hN=!3V<3d$wQntRe)bdU)XpRY2;~%H?afWwYfSFpgmG>_AT)8G z2Ccol^Uim_c6W4x7gk>HKjFrsJ3IDo0jpr zrR0&oi4D`2zdC3VXjEX(SJOB+Zd!E}yZSj67(H!7CjcNs;6$Kj%R2EF*{U5a5SnI- zq>{5!1HA&k=5!=MZa%i7Di?@jLNCYHFpNZ&6$K*T1*EIakj-*RlP8LJdy%Eg1&(1$ zURw|m(E}I*Xv%?O0ik-`M+69gP7MZqWO$c9zC8NQ&^PKwUXXX-ywP*OpaZrJN{C}Y zt!(KR`g`op<9d!Xi=k?z2{>-~VO9c40499_!1ExM%4%$usK6ZJvHEvsRstAR<;`oO zRziz^{9yBncUHMOyMtN@1|1+Cj4Pqyk7YnrCKX9%je18)i-9+hDg=&)`3BXAztHAE zZT(w=v4()6EhA92WUkJIBB%wU=UiQXcFDBQqgqGP0+DIyB4ku@ z{@yKTy!_6Ym4{-Y2bU;IOzIFJk$~==F=VI^tO1I%>uN(oP2rwdBk&Sph%s2SP z-Ai@tpQ~5@5PW&*;TtD=wdq#HCX#Z8k)`UtEb}4>hAUy%62M5K@f8XEB|_`=<4Ap7}OS)7>l=vv~fN7R*rJ(#M9VgvgCl+1y(x=-tg(gZ zgQpDZJm}bsKaSrzT~Jh@=U9nA=;`X!H6&_i=K;-Kz3OSf(^>xY%#~~QY)~0=Qi0&@ z5i|TOKEpIX?z?fumzxi6Q85Ookbdu#InCWFzw51mld=`r=WhQA7#`vmvS9R_=Qb#J z^4KtA#im2ws`VPFNc!H(vpnjq^YfSc#*Uvq|K(XF>az6wOdX@g03&eRU+yavNgO2h z05Ey=JDf&oswHKZh?Z?@{JNUw4`nHGI?e5uo1Xy!8g!a3rZ3m(waa!c1=^-!4ZXHg zo9<^<9H@GtnSm{eOCPIcvhnAK5g3LMJg+x8d>pR{l*f8HPG}TYn&ntyO(jW?Bw?w^ zo4oq%ACB%Y9jc<&h6T2d-*UNn(8KEu29eNedRe2_)^qNg&7U>G;<+cgHDYHfBq8%r z)a*VgO}R;Vsms>B`}N!r)2cGKHHm3&SI-gALrf+Z@u%a?_YCg>0+Ee$G)biwWR$2% zt9dP?v%NUNvUD6mh%tf>0V@)Cy2|=DRwzdjBrOoq0-@#Lv&`wlZ2%ttG-ST(`7BKd ztp#5LJ5wPa?p&rSRhYoX8th%Y`$zPykv=e!7?~F{!@M+T9gx!hq))4cxo zh2hwRJC-i`_7fl}Q$`o@gh=wi%kN;dxL@;$;aS7p>>V`#v?>tNKb+b9Qv04>-YqLj zLM#`abF+7;y-`X)I%8mYT|PpHZSMSrfOKw}-T$(vwCcmxPxMoE$D-rx2nCP5d+-vG6Ig*xXAj+ z9bRsl;Qy?Ys>&Aa__W)*1BQP*=ECiBAQV-C&!B7W6ZFMo^XDtqSr`-2yw&#iHc6!p zpf2BX{QF6L$N2h(SqDLc0H9M)huVZH%anYCz@UzOfB0~_*hPNw;=z>MC!fBy z5O@|WA90?OIeWa)ZMYdltxM&39rnD_S9!$ZI2|ZoLQ|gqk+GJFq*X`YKe$)zpO-)H zUA}bVBuMRn7FR3bV;LML*3Vw^a@RU98hQ=_Mn(_*dC_;IKsamD!U=sw_l)WfdW#Ri z&}(C&2iFdH06?XC$RS<*CKw?OAtu0WfwQ#7e`l>Wnj<_j_lWjKbB)F zw^o@Zj|X+RgqCcbx3T^lrbXx9AG!I*)KxP+n-bfnUH9;5U9_5VcrK-6&^bD}-`sGv zh1{=Jd{i2jK2Bpu!|SdEM2JPe2e{4mcAoNI8}7ZAkNkFFzd@(z6xwOt$QdtOC3B-o zmLjM3!r`e&w?QNU1i&#sQeE5j_?qQwl|E#6=FWgT{_~fVMYu;LR^v0<2|{Z1+nG+H$_=dzl9_2CEf&)tQLodfu^i$M4!W-?lyZw zNNU0ItfCzRE;6S+5yz>dqL7vzu@2&njs8=Ua~>yWr4*}`G$rtF<`?YMQbOB!g43hy z)c7Y4w2Z;s!MRO98+Qj=j#bqe^a+`dg1lQ+B)c?vZBkZ>pGR|RPgi-8m#)@pTl)qB zKw?%h!!p6%ft2-kfH54Cl$nzGG@GUbJ{~?Tn)%tv5}?G)M+q5^SdIzx4G#4Qs8G02)$?+;8g9e8`)}VL`Ffj*-sUe9lwwmdOjiSLSlH0zjFyK&nJW==6CDp4knNuy+4uYny5_vpX@^^=iV+;Y-FtFA;PjFWkRkZ6mi*?)CX# zDDBRiv0<$mMcJPtu^VY!ETtci!J25Qt`r0`sPw(*#3?1HiFpv1- zH%}ip@}t(EI~=>qj7n~ZUO9U6lzogh^cKSaC+IEi_)f1PWr=wWq&#;ispFpsK~;2K zn?DnR&OHpcn%q5IvBkg^qrXie-sugUVE6g`6;BjpMOwYq+IF%OIqu_vpoehh>0gXb zG&=3;>*hc-bePqLVOgtMTe|B@=nU^}TU_yE+F3z|W!gIlxgW5+(nz=<;CZCu_;L~D z?dSS#Ti;ziF4HK&@$YkTgS=Y;2cP}2YW<%LwLBR2!Ojz*V$hYl8QmfrQmN|Cwl+?p3cKrN`{bE7h zEeCYyW9=CPr{m6pRv*)KsFTc5QC6fVD{_=M4Cy=&c<%iDE4ANm=&iehBl{g+eqi#d z=_!xy{CajzOy|L!f;v>=0a-e;?!+r<+WbZQl0RXZiBQc$t&0$Nvn=qz&#^$orle@&&+{9EYb z5dx8TO24tTef()zVX0c_X75seskSAOU;GqEe8;Jucb(f~JTd^saHUoSJf!8PH$MIV zAUe3?iO=`Fxo-BKmyQftH1g+6AVCrYAilY)mzPVkXNQp@k|41Vu3bR* z--15?2$1_8{q(nwb}n1DYx$u0!!K<-+x6Kt6Gv&6P|tOM;Sym>k-(S4W&f6vhzg2` z3W_kAo3Sh2*thq`JE`}q!e6j=AmQqC_OCN}B?an?Th*JwZ&uKZ|xg=?B=PZKds=E%J*ixEfiSiDs>5s0$RA|;(>@3 zZ35(eIF3KeNCFJQuzz}da2$VQz-#ZWocY$eIiFAYxJyWsMz7s@>gR-vN8h}&%6QkS zh4M8%J8Ymc^b$cgV&YdbwR)ZPRHA&nQu*ZkMi2)IP0(@HW7$FggPollack SpringSource + + Jarred + Li + VMware + + + Costin + Leau + SpringSource + @@ -32,41 +42,28 @@ - + \ No newline at end of file diff --git a/docs/src/reference/docbook/introduction/introduction.xml b/docs/src/reference/docbook/introduction/introduction.xml new file mode 100644 index 00000000..212f77ab --- /dev/null +++ b/docs/src/reference/docbook/introduction/introduction.xml @@ -0,0 +1,15 @@ + + + The Spring Shell provides an interactive shell that lets you + contribute commands using a simple POJO based programming model. + + This document is the reference guide for the Spring Shell and covers + the key classes that are part of the Shell infrastructure, the plugin model, + how to create commands for the shell as well as discussion of the sample + application. + diff --git a/docs/src/reference/docbook/introduction/requirements.xml b/docs/src/reference/docbook/introduction/requirements.xml new file mode 100644 index 00000000..19dde886 --- /dev/null +++ b/docs/src/reference/docbook/introduction/requirements.xml @@ -0,0 +1,18 @@ + + + Requirements + + The Spring Shell requires JDK level 6.0 (just like Hadoop) and above + and the Spring Framework 3.0 (3.1 + recommended) and above. + diff --git a/docs/src/reference/docbook/preface.xml b/docs/src/reference/docbook/preface.xml index 6800d9d4..74418e05 100644 --- a/docs/src/reference/docbook/preface.xml +++ b/docs/src/reference/docbook/preface.xml @@ -1,6 +1,63 @@ - + Preface - + The Spring Shell provides an interactive shell that allows you to + plugin your own custom commands using a Spring based POJO programming + model. + + The shell has been extracted from the Spring Roo project, giving it a + strong foundation and rich feature set. One significant change from Spring + Roo is that the plugin model is no longer based on OSGi but instead uses + Spring IoC container to discover commands through classpath scanning. There + is currently no classloader isolation between plugins, however that maybe + added in future versions. + + Spring Shell's features include + + + + A POJO based programming model to contribute custom + commands + + + + Use Spring's classpath scanning functionality as a basis for a + command plugin strategy + + + + Inheritance of the Roo + Shell features + + + + Tab completion + + + + Scripting and Script recording + + + + Customize command prompt, banner, shell history file name. + + + + This document assumes that the reader already has a basic familiarity + with the Spring Framework. + + While every effort has been made to ensure that this documentation is + comprehensive and there are no errors, nevertheless some topics might + require more explanation and some typos might have crept in. If you do spot + any mistakes or even more serious errors and you can spare a few cycles + during lunch, please do bring the error to the attention of the Spring Shell + team by raising an + issue. diff --git a/docs/src/reference/docbook/reference/dev-guide/dev-spring-shell.xml b/docs/src/reference/docbook/reference/dev-guide/dev-spring-shell.xml new file mode 100644 index 00000000..34e6922e --- /dev/null +++ b/docs/src/reference/docbook/reference/dev-guide/dev-spring-shell.xml @@ -0,0 +1,43 @@ + + + Developing Spring Shell Applications + + The commands are + + + + + + + +
+ Marker Interface + + The marker interface.... +
+ +
+ CLI Annotations + + annotations +
+ +
+ Logging + + +
+ +
+ Building and running the shell + + +
+ diff --git a/docs/src/reference/docbook/reference/dev-guide/introduction.xml b/docs/src/reference/docbook/reference/dev-guide/introduction.xml new file mode 100644 index 00000000..a0f0a240 --- /dev/null +++ b/docs/src/reference/docbook/reference/dev-guide/introduction.xml @@ -0,0 +1,5 @@ + + + This section provides some guidance on how one can create commands for + the Spring Shell. + diff --git a/docs/src/reference/docbook/reference/introduction.xml b/docs/src/reference/docbook/reference/introduction.xml new file mode 100644 index 00000000..825f2b95 --- /dev/null +++ b/docs/src/reference/docbook/reference/introduction.xml @@ -0,0 +1,7 @@ + + + Document structure + + This part of the reference documentation explains the core componets + of the Spring Shell. + diff --git a/docs/src/reference/docbook/reference/shell.xml b/docs/src/reference/docbook/reference/shell.xml new file mode 100644 index 00000000..81558b7a --- /dev/null +++ b/docs/src/reference/docbook/reference/shell.xml @@ -0,0 +1,112 @@ + + + Spring Shell + + The core components of the shell are its plugin model, built-in + commands, and converters + +
+ Plugin Model + + The plugin model is based Spring. Each plugin jar is required to + contain the file + META-INF/spring/spring-shell-plugin.xml. These files + will be loaded to bootstrap a Spring + ApplicationContext when the shell is + started. The essential boostrapping code that looks for your contributions + looks like thisnew ClassPathXmlApplicationContext("classpath*:/META-INF/spring/spring-shell-plugin.xml"); + + In the spring-shell-plugin.xml file you should + declare the commands and any collaboration objects that support the + commands actions. An easy way to declare the commands is to use Spring's + component scanning functionality. + + Here is an example spring-shell-plugin.xml that + from the sample application. + + <beans xmlns="http://www.springframework.org/schema/beans" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns:context="http://www.springframework.org/schema/context" + xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd + http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.1.xsd"> + + <context:component-scan base-package="org.springframework.shell.samples.helloworld.commands" /> + +</beans> + + The commands are Spring components, demarcated as such using the + @Component annotation. For example, the + HelloWorldCommands class from the sample + application looks like this + + @Component +public class HelloWorldCommands implements CommandMarker { + + // methods with @Cli annotations go here + + // use any Spring annotations for Dependency Injection or other Spring interfaces as required. + +} + + One the commands are registered and instantiated by the Spring + container, they are registered with the core shell parser so that the + @Cli annotationscan be processed. The way the commands + are identified is through the use of the + CommandMarker interface. + +
+ Converters + + The + org.springframework.shell.core.Converter + interface provides the contract to convert the strings that are entered + in the command to rich Java types passed into the arguments of + @Cli-annotated methods. + + By default converters for common types are registered. These cover + primitive types (boolean, int, float...) as well as Date, Character, and + File. + + If you need to register any additional + Converter instances, register them with + the Spring container in the + spring-shell-plugin.xml file and they will be + picked up automatically. +
+
+ +
+ Built in commands + + There are a few built in commands. Here is a listing of their class + name and functionality + + + + EssentialCommands - + exit and quit - to exit the + shell. + + + + HelpCommands - help - + list all commands and their usage + + + + OsCommands - the keyword for this command + is the exclamation point, !. After the exclamation + point you can pass in a unix/windows command string to be + executed. + + + + +
+ diff --git a/docs/src/reference/docbook/samples/introduction.xml b/docs/src/reference/docbook/samples/introduction.xml new file mode 100644 index 00000000..2b34c4d4 --- /dev/null +++ b/docs/src/reference/docbook/samples/introduction.xml @@ -0,0 +1,11 @@ + + + Document structure + + This part of the reference documentation covers the sample + applications included with Spring Shell that demonstrate the features in a + code centric manner. + + Describes a simple Spring Shell + application that echo's the command parameters to the console + diff --git a/docs/src/reference/docbook/samples/simple-application.xml b/docs/src/reference/docbook/samples/simple-application.xml new file mode 100644 index 00000000..cad272a1 --- /dev/null +++ b/docs/src/reference/docbook/samples/simple-application.xml @@ -0,0 +1,19 @@ + + + Simple sample application using the Spring Shell + +
+ Introduction + + This sample demonstrates how to execute a MapReduce application and a script that interacts with HDFS inside a Spring based application. It does not use spring Batch or Spring Integration. + + The example code is located in the distribution directory + <spring-hadoop-install-dir>/samples/wordcount. +
+