doc(batch): add commentaries

alfredo-toledano · alfredo-toledano · commit f35f108d86a5 · 2024-03-11T22:35:58.000+01:00
diff --git a/batch/phonebilling/README.md b/batch/phonebilling/README.md
@@ -17,3 +17,5 @@
 * business processing part
   * apply business logic 1 by 1    -- TODO: How to check --
 * checkpoints         -- TODO: How to check --
+* batch artifacts
+  * Check 'phonebilling.xml'
diff --git a/batch/phonebilling/src/main/webapp/WEB-INF/classes/META-INF/batch-jobs/phonebilling.xml b/batch/phonebilling/src/main/webapp/WEB-INF/classes/META-INF/batch-jobs/phonebilling.xml
@@ -5,27 +5,33 @@
         <property name="airtime_price" value="0.08"/>
         <property name="tax_rate" value="0.07"/>
     </properties>
+
+    <!-- Chunk-oriented step -->
     <step id="callrecords" next="bills">
+        <!-- next           define execution order of the steps -->
         <chunk checkpoint-policy="item" item-count="10">
             <reader ref="CallRecordReader"></reader>  <!-- input retrieval part -->
             <processor ref="CallRecordProcessor"></processor>       <!-- business processing part -->
             <writer ref="CallRecordWriter"></writer>        <!-- output writing part -->
         </chunk>
     </step>
+
+    <!-- Chunk-oriented step -->
     <step id="bills">
         <chunk checkpoint-policy="item" item-count="2">
             <reader ref="BillReader">
                 <properties>
                     <property name="firstItem" value="#{partitionPlan['firstItem']}"/>
                     <property name="numItems" value="#{partitionPlan['numItems']}"/>
                 </properties>
-            </reader>
-            <processor ref="BillProcessor"></processor>
-            <writer ref="BillWriter"></writer>
+            </reader>                       <!-- batch artifact -->
+            <processor ref="BillProcessor"></processor>        <!-- batch artifact -->
+            <writer ref="BillWriter"></writer>                 <!-- batch artifact -->
         </chunk>
         <partition>
             <mapper ref="BillPartitionMapper"/>
         </partition>
         <end on="COMPLETED"/>
+        <!-- end           define last step of the job -->
     </step>
 </job>
diff --git a/batch/simple/src/main/webapp/WEB-INF/classes/META-INF/batch-jobs/simple.xml b/batch/simple/src/main/webapp/WEB-INF/classes/META-INF/batch-jobs/simple.xml
@@ -5,15 +5,21 @@
         <property name="input_file" value="input.txt"/>
         <property name="output_file" value="output.txt"/>
     </properties>
+
+    <!-- Chunk-oriented step -->
     <step id="mychunk" next="mytask">
+        <!-- next           define execution order of the steps -->
         <chunk>
             <reader ref="MyReader"></reader>
             <processor ref="MyProcessor"></processor>
             <writer ref="MyWriter"></writer>
         </chunk>
     </step>
+
+    <!-- Task-oriented step -->
     <step id="mytask">
         <batchlet ref="MyBatchlet"></batchlet>
         <end on="COMPLETED"/>
+        <!-- end           define last step of the job -->
     </step>
 </job>
diff --git a/batch/webserverlog/README.md b/batch/webserverlog/README.md
@@ -0,0 +1,13 @@
+# Structure
+* 
+
+# How to run locally?
+* `mvn package`
+* set up a glassfish server
+  * [Example video1](https://www.youtube.com/watch?v=AJxBg90HM4s)
+  * [Example video2](https://www.youtube.com/watch?v=Z0fB4Mkmi3A)
+* run the glassfish server adding 'hello2.war'
+* Open in your browser 'localhost:8080' to check that it shows 'index.html'
+* TODO: What else?
+
+# Notes
diff --git a/batch/webserverlog/src/main/webapp/WEB-INF/classes/META-INF/batch-jobs/webserverlog.xml b/batch/webserverlog/src/main/webapp/WEB-INF/classes/META-INF/batch-jobs/webserverlog.xml
@@ -13,7 +13,10 @@
     <listeners>
         <listener ref="InfoJobListener"/>
     </listeners>
+
+    <!-- Chunk-oriented step -->
     <step id="mobilefilter" next="mobileanalyzer">
+        <!-- next           define execution order of the steps -->
         <listeners>
             <listener ref="InfoItemProcessListener"/>
         </listeners>
@@ -23,8 +26,11 @@
             <writer ref="LogFilteredLineWriter"></writer>
         </chunk>
     </step>
+
+    <!-- Task-oriented step -->
     <step id="mobileanalyzer">
         <batchlet ref="MobileBatchlet"></batchlet>
         <end on="COMPLETED"/>
+        <!-- end           define last step of the job -->
     </step>
 </job>
