From a59157a6ab9bbdae35f10adc4117c5c40f75fa1e Mon Sep 17 00:00:00 2001 From: Christopher Broderick Date: Thu, 5 Nov 2026 20:13:36 +0000 Subject: [PATCH 1/2] Move to markdown and update developer guide --- docs/DeveloperGuide.md | 186 ++++++++++++++++++++++++++++++++++++++++ docs/DeveloperGuide.odt | Bin 22639 -> 0 bytes 2 files changed, 186 insertions(+) create mode 100644 docs/DeveloperGuide.md delete mode 100644 docs/DeveloperGuide.odt diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md new file mode 100644 index 000000000..84ff7ba1b --- /dev/null +++ b/docs/DeveloperGuide.md @@ -0,0 +1,186 @@ + +Table of Contents + +[1. Overview 1](#__RefHeading___Toc295_46039121) + +[1.1. Source Code and Development Methodology 1](#__RefHeading___Toc6146_46039121) + +[1.2. Development Tools 1](#__RefHeading___Toc297_46039121) + +[1.3. Development Process 2](#__RefHeading___Toc299_46039121) + +[1.4. Application Documentation 2](#__RefHeading___Toc301_46039121) + +[1.5. Logging 2](#__RefHeading___Toc303_46039121) + +[1.6. Code Review Prior To Commit 3](#__RefHeading___Toc305_46039121) + +[1.7. Website Update 3](#__RefHeading___Toc307_46039121) + +[2. Release Process 3](#__RefHeading___Toc6148_46039121) + + +OpenAS2 Developer Guide + +# Overview + +## Source Code and Development Methodology + +- Code is stored in Github: [https://github.com/OpenAS2/OpenAs2App/](https://github.com/OpenAS2/OpenAs2App/) + +- Follow the gitflow development principal (create a branch off “dev” and raise commit back to that branch when ready and then “master” branch will be updated when ready for next release. All releases are tagged with the version number in format vX.X.X) + +- Code must be designed to be modular and reusable as far as possible. + +- Code review and merge must be done by a different developer than the on(s) who made the code changes. + +- Code style: + + - Indent 4 spaces. Use spaces to replace tabs for indenting. + + - Formatting of braces is not consistent but prefer braces on next line for all but array initializers + +## Development Tools + +- Make sure the IDE’s Java compiler is set up for the current lowest supported Java version for OpenAS2 compatibility. + +- If you want to use newer library calls that are more efficient then make sure you provide the ability for the code to use 1.6 compatible code through a check for class availability. + try + + \{ + + Class.forName("java.nio.file.Path"); + + // it exists on the classpath + + \} catch(ClassNotFoundException e) \{ + + // it does not exist on the classpath + + canUseNio = false; + + \} + + if (canUseNio) + + \{ + + java.nio.file.Path fp = f.toPath(); + + java.nio.file.Files.delete(fp); + + \} + + else if (!f.delete()) throw new IOException("Failed to delete file: " + f.getName()); + +- + +## Development Process + +- The project is built using Maven. To update the version number run this command: + mvnw versions:set -DnewVersion=x.x.x +The version number x.x.x can include SNAPSHOT as a suffix (eg. 2.5.0SNAPSHOT3) for intermediate builds to ensure they are not confused with actual releases. The release version number will be updated in the Maven POM. It is only necessary to update the version in the server POM file in \/Server/pom.xml and the build process will ensure that it is included in the manifest so that the server reports its version when starting up. + +- The project is built using the following command: + mvnw clean package + +## Application Documentation + +- Use Libre Office to update the OpenAS2HowTo.odt as and when necessary. + +- Remember to update the index table after completing the main document editing (right click on it and choose to update) + +- Generate a PDF to the same folder once update is complete + +- Upload the new version as an HTML file to the OpenAS2 website (see section below for steps) + +## Logging + +- Generally ***info*** level is left turned on so do not overuse the info level. It should be used to log key milestones in the AS2 message process and provide some user feedback for realtime monitoring + +- For ***error*** and ***warn*** level messages always pass the Message object instead of a plain text message to facilitate extended reporting + +- Use ***trace*** level for logging for fine grained logging such as code sequence execution verification + +- Use ***debug*** level to provide information about key events not reported at info level + +- For performance reasons, use either of the following for logging at ***debug*** or ***trace*** level as they are generallly turned off: + + - use the placeholder formatting logging methods: +logger.debug(“AS2 file: \{\} Encoding: \{\} HTTP headers: \{\}”, msg.getFileEncoding(), msg.getHeaders()); + +OR + + - check for logging level using the ***logger.isDubugEnabled*** or l***ogger.isTraceEnabled*** calls + +This avoids the costly process of building out a log message when it will not actually be used if that level of logging is turned off. + +- Always append msg.getLogMsgID() to log calls that only pass a string to ensure logs are identified to the message they were from. + +## Code Review Prior To Commit + +- Remove all compiler warnings where possible + + +## Website Update + +- Export the ***OpenAS2HowTo.odt*** as xhtml/html and name the file ***index.html*** + +- Host: **web.sourceforge.net** + +- Port: **22** + +- Protocol: **sftp** + +- User Id: your normal sourceforge user + +- Password: your normal sourceforge password + +- Use FileZilla or similar to connect. + +- Change directory to: /home/project-web/openas2/htdocs +NOTE: the folder “openas2” will not be visible in the folder listing for /home/project-web/ and you must manually change to the destination folder + +- Upload the index.html file exported from the how to document and overwrite the file in sourceforge + + +# Release Process + +- Update the library versions to the latest stable releases: **mvnw versions:use-latest-releases** + +- Set the release version eg. **mvnw versions:set -DnewVersion=4.15.0** + +- **Push any changes to upstream and raise a PR to merge into the master branch.** + +- **Create a release in the online repository:** + + - **Code → Tags → Releases → Draft New Release** + + - **Create a new tag in the format vx.x.x. eg v4.15.0** + + - **Select to auto generate release notes and then remove the auto generated commits in the release notes done by dependabot.** + + - **Click to make release.** + +- **Pull latest master down and create the release package: mvnw clean package** + +- **Upload files to Sourceforge:** + + - **Got to project page: [https://sourceforge.net/projects/openas2/**](https://sourceforge.net/projects/openas2/) + + - **Click the “Files” tab** + + - **Click “Add file”** + + - **Drag and drop or select the latest release package zip file (located in the Server/target/dist directory)** + + - **Drag and drop or select the RELEASE-NOTES.md from the project base directory.** + + - **Once the uploads complete successfully (can take a while sometimes), go back to the “Files” tab** + + - **Click the “i” icon for the README.md file and rename the file to RELEASE-NOTES-\.md where \ is the prior version that was the latest release.** + + - **Click the “i” icon for the RELEASE-NOTES.md file and rename the file to README.md** + + - **Click the “i” icon for the newly uploaded zip file and check the “Select All” link and save.** + diff --git a/docs/DeveloperGuide.odt b/docs/DeveloperGuide.odt deleted file mode 100644 index bdb216255431ee7f455795f3e1e628dbdfbe3b48..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 22639 zcmeFYbC4xZyDr+Cwrx*O+qP}n_G;U>ty2QB>(>k_Q(If4(vZIAv;@B3o~cH zKVcjh>Fn+7o$delI@A4!A0#B?KP3Lk=}+S?k^j}tz{tqN+T>3dI{=-LGXU@x-Oa`t z6i8kQ;xB0+kiVBd$N!!V<{$0<8rIa>&cMk8@SkM<)g%7|`p*l&zwxrLF)%Z6q!YAo zvN5oC{2!eE9i)?;owcFC{{;E(`pwbFz{%P1fA+)uH&pEbc4hz*$Nvw{f5-FhL;9cb z{vFT1cV};4YhwLBJYVQPJRP0ftxX*NKEexJo!GVJn~tvD>wND-nz2o{rHR97eEEAn z(omPgBT$+dRvZabVN08%rLAkFBctIyjMTUOG+@}NPL5J!A^A87_0V24RnXg9vfQ7;iB z66@pw*gCXWwfgQBBF&a%su9WP;gOI8DdW_PJx~HkYI~e|bDpd^VVBZG~&a2W@TRgvxp?M73|bNl|XjR8cNS~_{XrJ3Ne-&_~bxuA!4=( zF1e6Q*PP~htX-~H8QWq4pdVjPJKh&CCag)R-8LnZv=R(%>CkJ1#Yvh9;Qr9^6t<`# zk)^K}`d6MaPh>mIPSbn3_n3t>3+xlEN#ES+DD=Ue6`D(XXa|0FFl|XoX-_9;39$B| zpqi7{?lkOaoFdQxvy`kcN^mL&WWAsY!r}6`k-B}&HOF(j!Pze{`bi5NiIXN|7JERM z?kI0BR|6-`OEj#n)_3Krz(@L32vQ*uKx-od3zm{zx+|+;LP1=NF?Ei!GT!hNLn`3r zs`1-!Wr{i&8R-pqYshF^$gyyhpLnQ?AirJ)0sH_1 zDao|&hDH@yKtDH^=v0iC0<&~li+ulqj+XngSCq+V5oJDxqai^_eJJNzC+~C{PBMK@ z2b?l~-c@J~ne-Y|*@4o{Z!8{6DL7)*FccP)Vz9Lz(o&ipDcrr!Q9MV#COAUKpQA&7P*q8eIp{l^8HU|C>>50^MO%k_3dj;B$yL-Y`bQd0zXp2?#c#oA+;6YW zW`vrApw9<;6jlnr#n1FXEg~w|<_t~Kcoua{d3t;?R$Q!xzT$$_Ap}pY6qtst)Gq9) ztgwnnr24=Vk+6?R#{Cg|)0vT!vF?T6QAa>jq0YWV=D51<^#}+O9y|7cxqO=7Mf|)* ztI6=+yc)8=x^~73`*JaOEC|I;o`h->4IxnSuHh57YTwnl6Ul?w%$^s6cKJj!U|ci?%WUx~i|? z9{)64DrGA%NRi>duiK8@>K=9OGhn~;3~S<>V#;xNx>E6w6=QKbvOJuXyPttfSbh14 zS?H(rX=(p_TAp75D!hk1?B#+l=nvgVGzU3~{yZSMevy6-@A5<=$;NFGhRK7C;GfTW1MDlfpbFxkLp<}# zNC0^=vW9Y}<@cV#9k2|I) zc^uvpT#TK7XK-54>)1T}ldYf9I=+(j?4TKKiAIS93d%zi&Vu6AG`hnjpW3Dlg~|oIOX#Q_(aQhz~KN!VR|od zNtfwe$&_ttjx!yT1Jzxpy(_<9{PMp*rr|LSPuWn7-=nil5=s5^)o0lfhKbFw5|^5R zzTVB~bT`S+rM2V9s3fA1q3VvbdYverbz+7(+R&lDQhEd2FLh&9!R&m;)Q2I-po=)hGcv9`Cvb=WL)q#2^+G$NxIIQZ)BHyPW>E&sGB zFMkt+^+3{o_g$1YCm8c04D3>}W5Ye~m;BB-dwiznh63`^214s{1JYQjm%{QNpVnf1 z>nxDY{wVl8ZV$-;c$^m`E<8_-9k>#;G*H6+wzHPpFXONGHr9bJ^$+3EpA;Sn)vCx4 z-|UG^3S@5chfVjGr2H}C5H~I(wy&`=mdKFxbLvH06ARVuGQcrYAnHkX3%D)<>i5Zr z-}f6Lj#gA%ALd`aeLwYe+cJQfW6QD#|dVW~$jqzLV)Ca5u+vdTZQO^Zt6hMma($obn-|~HUI=^Q2 zHIX&C+ulIhm_4{|EhG6Q0YnvMlk{dmC`JPUel_e0tyR9AM<*$a4To}91z&!TjMRGX z=0T-wO&4B>T)fR_=(kH~yqgD|ue1&tdtfojf`SkBB6b{+=~4CieO_8A()mRjp_(Z< z9y`HfLs72F7Yf4F=ResBcL<{U#h*1WvEaY5m4BB6!Twn!+Zfndn3^~`(E^N3ClV)Y z1L+ZiuDF9uCYSl?z`+4OMq4a%yIDfi!Rc-@kT*MH5>*v`m7V6!?^TL2ZN=1QUKrpG zN7k0~C^H*Tkd2C)H=Iy$w$Zi}u5qp|H&PK~;N4gT7Uoj6y4q55=%obHu)$hS)&2b8 zmT|`|*G}BC!0sRpJ6InB356dmXz{S`h0QU!3uUUN;B=N3=l(><6S=`znpX>L(5ToE z+DI7h&mRpXJsRW`h}$YFHNcc|r@+yZf3Z8H-!T{XlUx6qDrRbVGYq!qKzF;N`cgY^ z%PZO32(d2ZllizG=ui}6zKw2jOC>*$kq>I-YPs@_G|nt!su>^1JF{+2*Rtm<#F zSN~)_3l0nf6bSl1b>BaUtcjDs-wY!;$XVx_4N_ zb-s^M`kn%m{%qJ7R(<5;w%fLr^VH!iYrFac?3KzCGoR2@mVOavM`N{ChKy+4?Kez1!3v}<3X=yMxVqwxjv z{-fzcod5=ryC+FD)zQbzZ`_&0xp7?hJQSFlAw9Jpnf~Mk9kQ-b3TjH22L4=f!kt*B zV2RYkq>{CGL{TYGvuUIn=|z}(&>JUdY8L!~2b0UMiJa=sj4OHEgAUl_SDjRRq4`^1 zKW@Ec196PEH11G>ga+c#8A-6n++$$G-Q!IyVw42QFmUoR3;IKeiKIfhe3DVEqjiPd zPz+j0(sug093-G}a-b`gvoL-EK6gcK4U0SG^&+3R6n%bWPK_L{8Qvn?*Q&jv)7(2J zbo63)hg3Z^yZS_LQXomU?uDWg8_=%4)IpgkWV<_}-4JK=vF9yWx(dyfo4OmhyK2G= zXktYrmmg076b44vAR%06OhnSDSuUnr*(o5rhk{)_qGuTkiOQ(%cSZ9(eeFIV{tgkO z*~G_-KSSj0e;guz-!MlLCnpPAvwsrN22CwTY%W+IzAoZEPiP`2nKaVu;G~okuy5i_ z#dfA@esb-LF&A*xSFz_h>>S$2t=r@w9pbh360gQr6RGahvbq8mF}ICQkEM#7z*vU; z2m6ip%+}eu$(`#T&VhRj2>JL1X@i6lrQeK>k-P<~q;#fiw^9_z&W4$noJS0&olzDU zfLpvOJ|9n7l~Q!lVQBSirId^kJX*LjCwM0&`SLT8rYftd#x5^!XAlq4k`tUPFb&Y}J9YQDh=x;6Ucopeo(YuQ)=u_Z-mUNf>n@8oN zz}1_{G`Zysk&!GJ``o3j7E4+f|-b9^PvSX?;irg^(L! znkgt9KyMDr(>qR5(P7}qE*f)HU^KTDK@kzL!!#pk-RODZ zh*ltH5D$x_Dx9d}6n%SpMSxATXgg`l+H8-|0B@l4@lRJfE5XVPLQ>8SZlVM0`#1 z7332PS?dK6*8DuSA@p>M2eBqz(PD@qh#O3OqSAc=y&0v7s7Zy?Z(QBV!2@J2VL-fO zNK9+3M~raLg3J*f(ltZ{t*qke;^^R}`e~YUIbwN0H2&k5#VM=?Hv{cj#v2j)_;%6(>8heh7NNq!`HG1<~oiQvO5g*-nfK}tCCx5gIHmkqpgxGbH=}O8q zN+k@$mgtdMxX?>dv`f$wG z6=q^Fb8xoewIX=qgR|JzapgHunKz+8U}0~b zILyqhNyF0|#9C{gXf-95&ufdBhah(6B$RVPIDGXno*0@O9<-#IFjeod0oum=GF&5k zd%*J=Kjx9Zt9A>#5i(4OM5?pqP=7JNV8>< zGQ_?#Hj|ZwO8s6X^9V{=z1pj5mZsLF3DTs~&6i(h10|P^y&Bjv*GbBz=6 zwzT{q5--z(fFgQLI$e%r*+TU4`&eNC8D^>F#4Ta@82c0(% zaZY~mJyaAA_(-0NRo#P!Ad7j~T5VqgLcP|!jnMkb(dx^?fC)oB!Yh`Fap+0DVHV{* z=@<#ZBOg7JjeK~MO}CAGyO;n1ho%>}33ffDJicp^JS4W;j#XA#u+0QI(2yQ1u#LO& zwt+Pp4Dc(`mBF~;4iReOCMn{Bo4FW;T)6qi-S%Uw_i*uH&eZfueEQj=e`8->)!>y& zuIfWj%A+9^Hj~hM93MfghTjN|B3Bw^8(D+lHGX$$Oq7k#yvuzp68L2s% zYWD?$5kd1AvUvDlP3(pkGk8;R*1H`#)>VBY=tMC(V(0VE99hsF8FFTb=L9>?I=BWp z1eOsFXzy{ObWdw{4ZJ=#MZ=*Yd=c!TA0=w9&;w$jVi1*oN^oHTD-F+@ewoSbBAjwT zpVfO~pS;UgkNV_M@F{kDl{e|uG^~8bki2rGL8iFDH;a3fMlZcHJ+9t2p<7PPc8sGq zdYUP&-hm!Zf9j)uCMxH35W8hz3=SImZ%GwSLR?t!&u;?|5HJwrpQ#V1_haY;2P=z`(%D%F4;f$;->j!lK^Uxz)p? zJuomZDk>^5F)=eUv!I}$yu7@=zWz^LGdQ?6BBDPoZYVKvBqL)yFK?=#V7k0~p{{PZ zy?vv*yL)VGth;+_Zf88>KQ+pvHeCEW{Z93<^nn=}qi z%YDy~&F7>{$c&y}tALZ#ggC7bnN*e0IxqZLyu76FX3>#RpCmlDk89I_45-UaqR*W8 zMgCXybg=pOn^!oby#V6;GL`Zfe`?k*C=VdH??pJ)C$ae-A9HI%*q}PE{&8Ecr zhWKf07pmWJnqg34iYF3Oh4r(Bslt-s4!@ouH4J}=DgqQ^K-%^dvh99f7A3xV*kRaJ z$v3~91FjNwD!2RQP%m-Z(mcPM^*#h5ot9rqUpcvJE=axcl&il>ThA6Ii6)X(To^~C z3gY0h=NBrn7esYCCo8&DgLl}04=t+L4Hx8F4mZVIY7m(90EJ9KQR7>ywy3pLV zi&MsVPoDt$4%Rn1(eI9^&0G3wnNdu#MP*gJ-Y99s213F)Raq?kRREwiFsAg2LH#Og z2>!Z{1j*csgV&{fC=-$b!Le%%l8&~=jE6w*BQNGC7N^P^@awXZ;LwZcL^etEN?-xL zc-CJ#4-WSkbYv~Nb!#L1`-Q-zH!IS{LY_kmyd>@+Zo|l1B6BXRYTWd4luAlfGDz&6 zrba$6aIym*8ZU=4@gb-c(6fvdnJro=5RRu{L__(eUT2lH9^ab`PPVB@QXqYRI3mPc zC3wG}mQ&NiC|0)(2|}UxW#a3PQh25Z-Ts(Fy-Kgl_2jx&=FXy?rFt__*P-ZrTW^L| zqah(91L2ll zhr)wzSe@-1Qs80-d>jeesR^;n=?;7Wio1vBM8^YI1(=SPBcfMFC+NPvk(RkTAx8~v z7OBIywIOol+v;q1rmUwE@TdcZvYydB#hj-m6!DbNPSdI&_Iy&R77SFpkv$?@VM{^@ zz>6be*e`o7ncBbnxCm}7+_u5^_Rm5E9TOl90~UIE{rb#+TUnY?zVo+%u_0FV%I);y z|9G#11z;b-Ku=RZ25lKEH8rAN#f^&e0A@jedf-ulFI(nT(+?K z-n@c*7~FVm#b&yTCv)y)hbu884e6^rob0Cyu^R{5=0D~t(fnt$NK9^!u^jzOI;?*Y zBr70LW+cC1S@!3F6yuWHb%7`m@H_%}MTABIKStbUpnP(2<$r61NPpY^95+ySwXRs( z;w`PBNz0hO?(MsV$^y=Lyp)&6hgM>j<#U3-*DMi=;VcnDAa#aJ z^q4g=!o#&yXnPi;dbymjqJDLD`AhK1Z6n**BqU?4j$z}rW*aqj0oI4h3qh6iYrDbh zwvX{m$XD&Daybwg0lP5qUDWg-Kj1@GDmI&=In;^%5x^dB*Zo#l;IIOk!-K2%WejtQg&DQriL0DQY=U`qsL%r(Y-PUp`UN zhMV5x9Php=e!Z+|)!}{8sloM%y>;>9Xzs49>ap7P?bo$KU~av83BBNx?O74dEXtpA6{7J4l89Qy0>(=85b@rPnzf= z9Jv*bjgKd-+#G#)t#mp_xvJC>J^TaIw7RkjZH+0RizO3MN-HIoDgyu=Sn2V#$E%Sv zGD{mFv@k8Ql6v>lGM?OJCqEy3EL7<}lAY*IOffT`Fg1wYq92A#dOMQk112YPWA()z96EY5x_;{xXS&ptx*4hHzQ+Ny+InSUX9H2_ z$ETH*Toa}a@*O&(XzW3zk>z7U1+AU(8&lnF-fc+b_)M4{qMwRk8VyQSY91M}$E5NX zde6z``9bAY5f}|%j%c)+-tl_JJ|$H=tJ<#4@p?(f_zKt`3+J=< z2Mec+$*Fhlc-|c=0n#{CrgbXm27#Ew-uWKwSyh@{{0LS2oX?utdgY&n99_1b2Mi`bhoDyhLO%MQJ8N_^OM+j+bToaAwTxzwK1Ht*^4Vjy zu&3f4h90ZR#RKwaI7W+&3i7DYlKi0>J zB^wOe+oCLV4%Z}bjNS}OHwLkpV(I!&4iG75)>OcMmpZBdQ(qW@J;E+HIWH3Z$6DmG z6<(uw^E)OA3k_wVq9S~-Bq(>|9Oc0DUJ6M28LlO~z55QVoYEajub*f!N`s%Pc!j)F zzBErq$(fDxCbd#&=VEoY&y4paZ{94)iIw>oNZE&G+l3%txgo_8RLn_5OSAI9qvFsJ zUsOJGL9^@J1`5NqZpF>JBMHDu;o_!d$)#6*uxRbksv0@qW$-Xdqvq0b>qvSisVjA- zICJPw(s*3-+tI;<0&Nop_-$7;6rD_mdX(iN(}9Q$uZ|M$ z#MXxGI}XCol*YBcp{`X#$n8_gteEb7GWC8PHr1yH1mc zC-Lm^dugBrr4Oy?!S9zGxP=vgjo?)e+m43bwoA|6O$FLcM!I^wt*@J*T;Gp{uh;9H zs#xE3LgzUy_!{qa_dmOtvJYEd%`aP-u~l0gYXpy7pHJ9td^fMxVaio*)KJ_ny%N2hqER&yR9zIr!`-@&Gya~ch5P!t#v&!*TaULUWo)-KPF%Z0Cw*F8SAD!%pio7|>9Xg+U4Mo-QT+*h=UcNFNi`^d-V zo1XAAM_81L|t1`$?6TcW# zNX<(ePyMxpdxNrUZbn{_ocBD%Nvfw;5oh9u$;Ae=CRpLRLhGIhzANY0f^EF+dExOw z>|EX14oU7d|8B`Hyuq<1*(c{37L87SLX05-kVFR8xNsqFE20_;^rKY;gCn3t2#&DE z5C*vk#0g;u>a^Ox37$PpG^`z7-vDt^4>$PSSb8U09txgiDN+DCLBcH?WE{9NB6dzX zIHJUGPDKWa`30cU@;9U;ftjxaC~!jvYlZ#3SXGyx(JaQX_diUR)r=aQWN4q+Tc&y^ zPVcp{fPB+YW->i$*29Usd*(@L0oezO4@_E4YOfs;BGsUZ!g9ywC5J#2nu!a>{&{R0 zj2Kh($O1asJv7(fi^ct#5{$y9s3ZBjW*-I_0TwN+O!bAT=bK75+sTfNf7YdpO@x#~ zR%{P3{EbG3idr`~h$uCOhA9d zhP4t+=-ynJD_{V$jsmKjSTV0C7#=xA{tfE8m__w3`;cN3&agy(NK#gd$}mDS$EL>M zmepDmBAG+?RdiNit(^BoVdQDfGFJsl59%@lRBykLTd-(gq>u!DhJP^u z*RU--d~XN=;CLs$GG4(M1cR7RB*yK zMFvebD8GS7e9}}{uRMvGMOxk4cj!`1U)&Pa5phBc9G~x@abNy0(q^5!N*`3EAzJWk z)~S_xO`Rv({TDCFfadZPgvWJl4q6zo3VfFA&Ru%na7z|uJ(?ux+i9YnlXL%2H(d7g z7+6Mp=n5?tiD4(ya;UQLZ_Q*q3U|>%tWJ;xfHF=Ht$3WdfC5`pg!f-?qvUR4z}3I` z#abctAS}rVfeTUln&f#xV2H`^8{)6g{LjQW(p#6=v1NbC3xK$Cek=No+CiNWQG z$B9-6J247K5iZ}*Fq^>NT!5OfKQK5AwxWazk zkg?TH8B%Dr>#G?enyt$mn1ygd(jy!b8SXfU^c%Tc%P^K63u{&`j+G{ z=rs@LH%zZYePQaX!W-#_FFNHTuB$W1^G4-PdNRbA4YLZw|$u5^Eyqnlgc_=f;% zKDrczve87i_UOW47ND{uV7D|hKs29;B55|kbOXW6L#=cOS!w*lvlKs`9-Fs{C}K7G zAW53wEKZSitupU-;2|u*s=Cccy0y5#ki++yHtW2*`cfkaaSRp_-62#n_m4`2;qBOj zQJFLE!k^C7s~H44ae~oebw4;e^Ra%P5%vA-hc%Hop4ev}B@DeZ46qGBGpsEM-WM8% zSEDd7ze4qPqAf69Q8px%Z*ct8R1>ZFo*#7A&+$p=ooTt>e1z+@dHAh6z zQ?!z#JF!JG3q^9YA%@UBbKeXD%}<^F>=QfjMK7sVG13 z;puuI&mePc+k_9EO_B3EJyf)F*LnSJ)u0WdITEcg4WLz%YRRF4ayO(Exk@;sV$*94 z)@jq5B;r=G2R*JGk<=NhM?V{xYS4o6p-W1GIl;j7CGXAZ59nvKov$k5v>``Y>UC!c z|9&0g^OM3ZNYFG5S7uf;o~^saBI7zHAjrLT_P9?YG^><%b2o?L@tAoNZucfCKE?G@ z!1>%GnOxw(Wt`ietx%@=Izl>RZD@1TjTX6GF_i~PjMqgsm#y)S#c|tqJ(&*aTe$+| z21n(R=0(PLoC-C86Zrr(O?U$R7P(n7 zQNft2hYOaY8^!3BU7aU-KyE{(o)hY#3-*GMLhnylG2a1YZ&+4i`1t6JK}?i0b0JvVqO1VoRw3x%+rxF%vNC?Y3l<6DqYA9C%o4Ia0?OLQ>%w;^kDxH9JP&WRke zn_XOO=_xkSWHzE_L$|}Lv?ZzNr0Tf!l;4VAH;KoEVOu6OY`VTas~bxsd&06_o+Jl~ zw~#aa4P#_N4TpoES2Su_m1vrHBKDoeDog+XaBNb1=(9?3(s&k*GF*n`Q7HYmoSGrEe*?TW+D!E->ij!CkZA@ltf5!Dre@9kCECt`Fb zj}+jaZlhBa44r3?!M`mDjKYU_W)^zmF@$wRgs}@CCL|k&Wm(8$&P7<#9ih zif#4bI3kDrxqDJIxid`45%Il7XAgo@(K#*~?1Wa{%pMqMH(wG+LU2DGDd~atAWsOY z-9;oU8}eI>{$qe*gi%!O6NjZ9ib+feG(NA`&M{uvIHVAaNP?gw5Mf!-p;OEj|3eyG zqT_J{fy+h(DV5+c?l5Wq!@E9lBrY6#FD09K&c`_0lK_>hC>|#tb6L#WLAS^VKZBr< zmX9bQA0EJ!NyjP~R_Oawx8w|DQf+*$;8?8HE^@Bc>Bm_bLfW|C1Bx60u zIGU1Qk7l&#uoN+?$f7ru63ljM2F?K&TAF+=32S8^0~; zeVZ#Y2k)x2k09UzqM7}V@f`!o= z@iqn=JpJFWC4r$y?m^5*>yfsXO8vkK%6gE_0_Y9(ybi5E+>&-w@}!6mwJ8~!zQy?J zKZTKi3;iCc+Y6E!?P0h<`aOQ45U5AH(rGZ?z#C#?JvGL9$)*c`_@V$8BQ+I!`l&xF_v<$yF`$eFofN)l;cSu7j6LegRR6qYOiNiS9ext z*|Qn)r^+C@6SdN1E#|>1Gw{dIoF@bauOUrf;#a`${#L0jo)`C0TM7l#5=uV5lxzC} z^Gd(;rv;43vjk$T=`XJZAnSX-_7f|cNiL>{ZWmWdcZ(K6$=VgrV=|En_@E-{@Xb&@ zQr%`C!+#Ol>Mb;6hBAk;3r`I!A{Tq`@o$3FVVftYGIMEDmAXB#2g|$9$d%MX5z|1# zb!=upzdUj4?oi-WHxk7SsgJ;bHs(vtfeq~*nHKewq2(M11kqHF4{|nTd}d?SD2P`1 zdHSkU|6qX&aN|3JQQNB&rjnDu&VLbPYl*7a=tt=sq{+-$o(Q4c-}zxZvsf(L5O`QF zh-JWpm7fQe7;apDylFR#dg!r7M%Q(l#7w{pS+z$Xg;yYEw2G&TZ%Ln|2%-(>bHtfb z`uUo4apXR5r112=>Z}S{eb`d$51eTtc>hz zo&NKKrwg66gf&r*&M76rJ<8O2jQ}t={3=r^Dvd@(&SbOpwqzU?6!SQBe{;+Y%t>oX z6`zQGQ^&+e?fsf}(wDExZ;)}@z_Qs^`E+0N+%-V{%Ya?Q;Mk2$muM`kb{b5#-Rx!%1s3Z^?TS6M`Y)UU&9kt= zpBmvfnoBk-+qyj3Y<(`X!dAXzN3CA%6u#elZp@2(U zu`OR((Z96SeyzIN(&1v_Bp>VfyzHUj+Ybnm8tE?yiq3jmV~AF#X6$i$gOHw1$(~_F zxzn#}+go!wW_H<_&F7bGf~!P`S!#Va+0Bd;B;B$_+(QeDGjLc!<@iCs)+AfaX@i^C z!jLx1I6O2*jo?lV}~`?DstN}RA*2VHeo%exz1UGb=L9Xi6HBUa zjD9i0k)F^V6f&$I}NVqm_LP8xA z>800S-B-#`5Bmjvce5^z{ddr>^8qNfDJE&b&QyKp|8|Q7_{tZWgqqY(&J4W-5EK-ntI6GIZ>%vBxPnBNMI-mdKEvJ3H7lj(W?4IhlVCFCNYV)UcC=`(L)L91=@S9WR0Cr?=x{Fsz z%ZD8YG$n*VS2(VGLf(pWQ(;5KXbEO1y>8Hc$ow?A6w2yE-rLEF10xnQbZU5@abjY*SMxN>>DV5lj+~-Y&Fg;|& zd+g+=`aph)49*yzoL1qR(ukD-vvkmHBb9b3+%s8HQuCWI_E`=dWcvel#Vns=kQ0xT zpQteYsyl@lbDO^))TPkT*1x#yZJmh~N<^+5U{?8&Z9T%TMftDp&pue@_=K6NP@9MN z*0QG_RUh_=@qc&!Y=AiV9`z>JfZWn5ur5}eIj{HnBM(d{`5TyyJf^eSCPnkqI22Kn zrzcK@=cu)P*to49Wztem%M;rA%;PujT^m<19#h{!1O&rwjF(*}*PuJ`p$3;AGZs_d zQ85UGm=ko9+*O-od-Df~M7-N2qsJpdFBe)_r1^?TA*0ZTd&5v?dFOi)d5F^DA9Xwd z5DnU68%W&qY0#Fw>fuSFYexgXSLY@!)N2n04^x9Wo(oou7f2PBI%Yh-SyzYEeGvvn zhp(D94A5>7C<$YPd_?c#Vk&f^{jin%YXWQE6|8#%TorlG_De`<=7Tmw8IdR-OJgmKeSo`NBvOf*{VH0@OYQ- zW;dHhUsRs*6!VBXwFJ$o_)b+6dj--zo+YP2cx#d2DGAF&AMnT}wWh+P+t}8Rvds6= zr`#2XCthWM^9nd2YraCx$hXnhenT#-|9&}Jgqtg91Xno8V`2ee~UomAj%Xu5Gmx>APSnPBhf%&4{|t@ZI~^ryu)511h@+ifHe`mYRl zLl<|dCL3*JHUxZ8RZEHGT+Gx}w=IGwvyj_ypQs#{*e;IVM&PXSRGo3E{Cw7|&~_fW zSuRB#T#_p*yHu|+?$qGZSfyjld712=c-2r=8Igv>Q)$s^^buEf9*T(TnRsoH9l$Hc zkJ$Q6(5$>svkUw<@hTy{fCqt6GFW#0Jk77t5Yt%{qkd-ukKo*PDYduZelOaFi4Z zgc9}vIaf+^UyOyn;+mWTmJ95G2BdPR9jE>gl?ZKB())D96SDmDg2WY+s;fKMC zoR;HZuMco~x0O2&PFJ`>Y^44CNr} zTZg5`4AW#$%BB*mkV2xy=nCqbZ-oDEtC-(q9`S#bJ%5xubxY;PbSFu56sFIp zpc-4}QDrA0Q|y_VqH+vT4-@$+GkUWWW=iAF6yIw7S1L*{c=oI<1qd%s25S5{@Ksc! zGH&H3_I0lUk(S{^r}e>Nm1y8Z<)sFgF$HKAX7#}uRHOru=H>qimHrB4{t+tw6{^t1 zf|DGxVhRKzamzORbwHc@#_ZYq2jQP!QhyO_{z3RhsQec}>A$!* zFN_)WKz{o_x-rcEqZ`w&M!8X8usSCb z!O1D>=*;1(+*ke?34hdlf7H@F$v7KwOn-gvZ7r`rrv26r6w&tuu)3qdd~VD>wA8cO)6{wb1J9VCrg4 zZEKT2oIMhXvgivu8hRU1qCRN0imHDXuUq^QgN7fS1kMUIi$7RX+7dwh2cy=c=K+he zaD=751=O>+PQ@zABHSTX)x6|->vA;&rX(_#vW)HyFi2odu&(_Qa;INQz@)!{z*4Cc zTVLD_2^lTGt3fm(g?}X>(>%y`?=3l6&4MP}z}@3FF_oo=`ZmlnYPgi}2l~*?xGVh+ zCck%UGf`rJy;`;By!)0Ic23iXH%OO=j}z%%2FyS$GwMd8rYD`VVAaiBgyu(4d$7XeD9(1&wFYhnprxwt>zMo!w zxSs1@>wl(YqcK{mvB;u=&8^pUjCmUyd{>in0y_(@vpJDN$O|f|JCVwiEL-F9FT%=i zs&@9sjnsFV2J}^FQgFzvgH}#j=n~v_JZMaZwSF>JUGQ6vZf?kpHcV58a7Msiny@i) zz4}ev+r?=dNkQ$vPLM%h6FIWLS6AY1W%6*n0iP`8wP-ZY|ZM(tavDAAaps!7yH7-(cJGyG;C~_R;sxKp7g=ic zoPQHYXF9S!ySxNyCMf(~yOA^MUetGJV-t7Uwf?QkBK4K%o;JVrfxy~zfUn$)osmz9 zk~BP?PBRGWe^=DSE(;vqAv~cD3S=%T1J@DgrOiGc&zye(B2(e-JfNT zh*6mka~Ig1CQlNNv^p_$N5~Y+Pv{kdAEz|u24(aBVH=0JO3j$POBz>ijH{hx#5}Kt z-|aE~0k-#8_5IyF2Y&$MN-VLhe%T$w7TCH($&nDMADG~1Tm}T0Dt;ztOgGxTug`2f z4D*PWn=w{!OneTxd_Kl=(t>*eX-Lpgnx81-%o9I)hI*Y^H1JW7LKvNQZ%P1ZJWc3` zhJd4))@geu>9zoI?ZV1XCAKR8+deoVvLiW_H7bYbD#3p48S7l>1J4;r>G=F+JX3lf z4N^$w*002s*=18)s*kJ&2jXt9f+!(a+V5QuevB|U5zIS2;CYV0yvqDAjfm6+Oa~++ zp8fk1e<__8^0P0*+NPit7kNts-Bea1bcgYqr4Xn(86HCUFLIb$r7A95=P}AESC_*3 z|EG_$0E)U>!#K5c$C4i*DcvCr3JXYsAEB^xNJ`fV2rRKkvl7yc(h>rzNP|cV0+Nc- zEiHGs_xb@|x$n--oSoh0IXUOd&i}kWVFaif3rkbn{>YDglewa%uKbN`BvC7Hqnol~ zisfDg+=;k-)p>-Z<4wGAu&dZMI=)LRM{(fn&9x4}I;bb8j%_!he96m5T& zHK>3J6yR9jARw)+r;7{KX4b*9%UiR0`M%;UF@sk80Bc`H`W-Jp}#_q{6y}EI?UMZHFX*T)Y*iI~} z{nbfRQZ@uvY9IRz>*d3p4f+c0#%K-2jX*`}h5QK@H?5J?3Xiz`GZaPA534C(7SPF@ z4M<Tmi!ki@{@fqT^P zerq+eIWhTLzZHft7+Yi-^8UT?@d_=rSxLve1%fY&Lt1>%k5LWPi(`MD`bQV;;bsq4 zN(MXxN3TITRr#_Q@#mo`zArEuN?g8eZ*t~Lc8B(IZf&KrPI~Kh-wUiMC3jrlykp#7 z`w~(pRMX>B(6n-o)GJKRLDjTks?Wg?EI%itaw7K~?W=S{es%I$#CvfZ{lSn^ zem!0|?QluR*TuTI8(ikRm5_(cn38AJzT5L3LS$FCre17tDJvlVRgmJ5f{w=+Odzj+ zZY@N|8B)2Yv}uX$N87mD)6{+vlU%A_cl(SluPakn7K49dzsw=k_E~cFewF3ma~Reg z=z2p0GilXocb`IE82O4=X`=HOw(zLIL!jy?-E9<#DUIlyURgzw>b62zDeOaye)==yj4P=CU*$P%rOq+_Jk|( zY~f^3ms+MsR?4Dg*a(NQq~^eV?GmbE8OQCbyeB#op4Q=TI4c>uQPbF%)6;$4mdhR6 zr^7_`p;tlU_ap4PDLxv~L;OXPjDU#Qa3B^MGCBK{j^d$tl5YQqk$94$>6*CeXW5pr z7mZvk6Q@BU-(k0!tBz|oeDz7Wm5kdarsdPrqGPs8mAJC?b7y3$+6jbGxQLH#uOyIg zM|E~CwFRYSeorrPZlWlPwJ{0PB7T8|qbb^_B~vgh#SYde`xuP+Nekh_#>X5qb~K=5 z0U?g}wCSMg7dSdG7&((uq~Y2<9bOT`y@%Bwib~~lpD`^|BNd-O-<^?C87E&Sh1e>* z$HE}MCLDkH{lV7asbmtdh}n|ij6!CO6G0m>G}ATGwJVNIHrrb@sFJ{6dj9y`4)VHa zqmL{Sic&QH^0O+{VuiEe!r%bs-bV7)2#Y*3kFVu@W6&1JzE_&7@ltG zsJ39P-CbCsZDMh0Z$C3G8CeH!CAQRGH!EdE+_FwIetvGXNU+0iLdjpk%McgBHzdVZf8&FL zugxA8hxKA)-+fV>K!cZIguaKj2_z<(Z*=mb*FOW$ED#&v8DAe;aOwKH(%0c;fIQLvscJ z`Qg8jB4WoON!Ae+G*F@)Iijn{bKNVoHCSa-406MZGK&Q!)f)tHcfj)9qPFE8og1H`*?Y{ z=ZyCed}W^rvyggM=q!l#aaUpp8HG~_!N@uW;B;AKmLhg}GzJ#cyCy8hhyCDrF=7`D$3?X- zHZqqCebOH-XoIbzR+A}QQ-JKfS_C;589&W zV?XnlTKXFEv*xrtSBt8sh-l9Gh|tWzVXENcBk)2m5Mxz_a%{9Zwv zZBv>xYWFBdf}Ps81wwCK*zPZGdXWEU?M&O?(+#H-fX_fqp&3uSD67->2YToC1|n`T zc10`u4r5vc_)!yVMnaoXutKeFOuBls@V>OXAE{O(Blpr*IGURz!zxx=K4N-l8nu*7 z!aU4N^%E(j;!tI`X&a*Jj*#qo+CfEKgSti@=wJJ(-dny9l7t5h`ld_3JzF(Gt_7bg z!kZu`KOZ6^-9WI|_qk*_B;ClPI&pEG?B$fyC?!4XM2ZQfYLHt)y`8^imh!z7Dj^?@ z?>d^EgST7UmdujYAA5Tu@@E#hnH>Oq9^71;hUs0w3}JCpe3|pC?&?h9cU7x|k7_1A zo4l5fAX+VYYLK)adEbRP_;ZR(%i!)8P+#W~T}6}n0bl4X_10YY*X}fTj}UciVH(`z zuO;_-!(;L7AqPDTvG9<1Q4`PhSJ>No&>!_SM40)EGetTS=u=tHotzF`039pL(m0Rj zOn`D`l*-~8ovyqbUuZmprlR`;-n#TE*0#A}^TRHZlUuk9V8jGiBrF2%*Fx{~wZjo! zo1Dq=v|jB%hG9=EU(TepAM6d@6`Go9AQRxTE8fxiNyW z+R)%Z(Nw8mwy!!XovfxRE#?pZkdI-qBuKu-%S3gjcl^Ym`{_5fYa>5bm2jg)sY;_t zznz6WVYQ(<#EP37i@?^>XB?`k7E0Jhh0)k4PY%4nLD2(QGj|z!%`yy9A$gG zY7P1B@x%^N<)j1eKw{qc7*~E#xrNOJ3I;xbslFyG_T+p8(*C&$&mH#h0#sPC+pTPh zFC8gqC`_=HFfFbpkkCu+T5|*?X*|r;GPw!USh?dGkrmx8SaN`}sEm_@cHEFUF*ztKe=iJVVAVm)4?=JsC z@x0#bYLhhoV0J`0OwaiE+Ss! z$_0_%g_rmCs||0~Mjj}aj*H)wm$#tvz5gQUkeGo#o&;KI03^)-1%(v(DnagC<+|se F{srR7FrEMa From a9158704a308b17c1298776a20d64c1886d3bb81 Mon Sep 17 00:00:00 2001 From: Christopher Broderick Date: Thu, 5 Nov 2026 20:14:25 +0000 Subject: [PATCH 2/2] Fix release notes --- RELEASE-NOTES.md | 10 +-- changes.txt | 2 +- docs/DeveloperGuide.md | 138 ++++++++++++----------------------------- 3 files changed, 47 insertions(+), 103 deletions(-) diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index 07a12b83a..01eeddebe 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -1,15 +1,15 @@ # OpenAS2 Server -# Version 4.13.0 +# Version 4.15.0 # RELEASE NOTES ----- -The OpenAS2 project is pleased to announce the release of OpenAS2 4.13.0 +The OpenAS2 project is pleased to announce the release of OpenAS2 4.15.0 -The release download file is: OpenAS2Server-4.13.0.zip +The release download file is: OpenAS2Server-4.15.0.zip The zip file contains a PDF document (OpenAS2HowTo.pdf) providing information on installing and using the application. -## NOTE: Testing covers Java 17 to 21. +## NOTE: Testing covers Java 17 to 25. -Version UNRELEASED +Version 4.15.0 2026-11-05 =========================== This is a minor enhancement and bugfix release. diff --git a/changes.txt b/changes.txt index 93750cb64..e2e827dbc 100644 --- a/changes.txt +++ b/changes.txt @@ -1,6 +1,6 @@ **IMPORTANT NOTE**: Please review upgrade notes in the RELEASE-NOTES.md if you are upgrading -Version UNRELEASED +Version 4.15.0 2026-11-05 =========================== This is a minor enhancement and bugfix release. diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 84ff7ba1b..e44ecc3eb 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -1,26 +1,4 @@ - -Table of Contents - -[1. Overview 1](#__RefHeading___Toc295_46039121) - -[1.1. Source Code and Development Methodology 1](#__RefHeading___Toc6146_46039121) - -[1.2. Development Tools 1](#__RefHeading___Toc297_46039121) - -[1.3. Development Process 2](#__RefHeading___Toc299_46039121) - -[1.4. Application Documentation 2](#__RefHeading___Toc301_46039121) - -[1.5. Logging 2](#__RefHeading___Toc303_46039121) - -[1.6. Code Review Prior To Commit 3](#__RefHeading___Toc305_46039121) - -[1.7. Website Update 3](#__RefHeading___Toc307_46039121) - -[2. Release Process 3](#__RefHeading___Toc6148_46039121) - - -OpenAS2 Developer Guide +**OpenAS2 Developer Guide** # Overview @@ -28,7 +6,9 @@ OpenAS2 Developer Guide - Code is stored in Github: [https://github.com/OpenAS2/OpenAs2App/](https://github.com/OpenAS2/OpenAs2App/) -- Follow the gitflow development principal (create a branch off “dev” and raise commit back to that branch when ready and then “master” branch will be updated when ready for next release. All releases are tagged with the version number in format vX.X.X) +- Release packages are found in SourceForge: [https://sourceforge.net/projects/openas2/](https://sourceforge.net/projects/openas2/) + +- Standard flow is to create a branch off “master” and raise commit back to that branch when ready. - Code must be designed to be modular and reusable as far as possible. @@ -44,45 +24,15 @@ OpenAS2 Developer Guide - Make sure the IDE’s Java compiler is set up for the current lowest supported Java version for OpenAS2 compatibility. -- If you want to use newer library calls that are more efficient then make sure you provide the ability for the code to use 1.6 compatible code through a check for class availability. - try - - \{ - - Class.forName("java.nio.file.Path"); - - // it exists on the classpath - - \} catch(ClassNotFoundException e) \{ - - // it does not exist on the classpath - - canUseNio = false; - - \} - - if (canUseNio) - - \{ - - java.nio.file.Path fp = f.toPath(); - - java.nio.file.Files.delete(fp); - - \} - - else if (!f.delete()) throw new IOException("Failed to delete file: " + f.getName()); - -- - ## Development Process - The project is built using Maven. To update the version number run this command: - mvnw versions:set -DnewVersion=x.x.x -The version number x.x.x can include SNAPSHOT as a suffix (eg. 2.5.0SNAPSHOT3) for intermediate builds to ensure they are not confused with actual releases. The release version number will be updated in the Maven POM. It is only necessary to update the version in the server POM file in \/Server/pom.xml and the build process will ensure that it is included in the manifest so that the server reports its version when starting up. +mvnw versions:set -DnewVersion=x.x.x +The version number x.x.x can include SNAPSHOT as a suffix (eg. 2.5.0SNAPSHOT3) for intermediate builds to ensure they are not confused with actual releases. The release version number will be updated in the Maven POM. -- The project is built using the following command: - mvnw clean package +- The tests are run using this command: mvnw test + +- The project is built using this command: mvnw clean package ## Application Documentation @@ -98,51 +48,22 @@ The version number x.x.x can include SNAPSHOT as a suffix (eg. 2.5.0SNAPSHOT3) - Generally ***info*** level is left turned on so do not overuse the info level. It should be used to log key milestones in the AS2 message process and provide some user feedback for realtime monitoring -- For ***error*** and ***warn*** level messages always pass the Message object instead of a plain text message to facilitate extended reporting - -- Use ***trace*** level for logging for fine grained logging such as code sequence execution verification +- Use ***trace*** level for fine grained logging such as detailed information on objects and state that help with code sequence execution verification - Use ***debug*** level to provide information about key events not reported at info level -- For performance reasons, use either of the following for logging at ***debug*** or ***trace*** level as they are generallly turned off: +- For performance reasons, use either of the following for logging at ***debug*** or ***trace*** level as they are generally turned off: - - use the placeholder formatting logging methods: -logger.debug(“AS2 file: \{\} Encoding: \{\} HTTP headers: \{\}”, msg.getFileEncoding(), msg.getHeaders()); - -OR - - - check for logging level using the ***logger.isDubugEnabled*** or l***ogger.isTraceEnabled*** calls - -This avoids the costly process of building out a log message when it will not actually be used if that level of logging is turned off. - -- Always append msg.getLogMsgID() to log calls that only pass a string to ensure logs are identified to the message they were from. - -## Code Review Prior To Commit - -- Remove all compiler warnings where possible - - -## Website Update + - use the placeholder formatting logging method calls: +logger.debug(“AS2 file: \{\} Encoding: \{\} HTTP headers: \{\}”, msg.getFileEncoding(), msg.getHeaders()); -- Export the ***OpenAS2HowTo.odt*** as xhtml/html and name the file ***index.html*** - -- Host: **web.sourceforge.net** - -- Port: **22** - -- Protocol: **sftp** - -- User Id: your normal sourceforge user - -- Password: your normal sourceforge password - -- Use FileZilla or similar to connect. +OR -- Change directory to: /home/project-web/openas2/htdocs -NOTE: the folder “openas2” will not be visible in the folder listing for /home/project-web/ and you must manually change to the destination folder + - check for logging level using the ***logger.isDubugEnabled*** or l***ogger.isTraceEnabled*** calls for complicated logging -- Upload the index.html file exported from the how to document and overwrite the file in sourceforge +This avoids the costly process of building out a log message when it will not actually be used if that level of logging is turned off. +- Always append msg.getLogMsgID() to log calls that only pass a string to ensure logs are identified to the message they were from. # Release Process @@ -150,6 +71,8 @@ NOTE: the folder “openas2” will not be visible in the folder listing for /ho - Set the release version eg. **mvnw versions:set -DnewVersion=4.15.0** +- Update the RELEASE-NOTES.md and README.md files to ensure the version number and release date are correctly set in both. + - **Push any changes to upstream and raise a PR to merge into the master branch.** - **Create a release in the online repository:** @@ -166,7 +89,7 @@ NOTE: the folder “openas2” will not be visible in the folder listing for /ho - **Upload files to Sourceforge:** - - **Got to project page: [https://sourceforge.net/projects/openas2/**](https://sourceforge.net/projects/openas2/) + - \*\*Go to project page: [https://sourceforge.net/projects/openas2/\*\*](https://sourceforge.net/projects/openas2/) - **Click the “Files” tab** @@ -184,3 +107,24 @@ NOTE: the folder “openas2” will not be visible in the folder listing for /ho - **Click the “i” icon for the newly uploaded zip file and check the “Select All” link and save.** +## Website Update + +- Export the ***OpenAS2HowTo.odt*** as xhtml/html and name the file ***index.html*** + +- Host: **web.sourceforge.net** + +- Port: **22** + +- Protocol: **sftp** + +- User Id: your normal sourceforge user + +- Password: your normal sourceforge password + +- Use FileZilla or similar to connect. + +- Change directory to: /home/project-web/openas2/htdocs +NOTE: the folder “openas2” will not be visible in the folder listing for /home/project-web/ and you must manually change to the destination folder + +- Upload the index.html file exported from the how to document and overwrite the file in sourceforge +