Restructure samples by feature

Author: fmbenhassine

spring-batch-samples/README.md

@@ -0,0 +1,16 @@
+## Reader Writer adapter Sample
+
+### About
+
+This sample shows the delegate pattern again, and also the
+`ItemReaderAdapter` which is used to adapt a POJO to the
+`ItemReader` interface.
+
+## Run the sample
+
+You can run the sample from the command line as following:
+
+```
+$>cd spring-batch-samples
+$>../mvnw -Dtest=DelegatingJobFunctionalTests#testLaunchJob test
+```

spring-batch-samples/src/main/java/org/springframework/batch/sample/adapter/readerwriter/README.md

@@ -0,0 +1,15 @@
+## Tasklet Adapter Sample
+
+### About
+
+This sample shows the delegate pattern again, to adapt an
+existing service to a `Tasklet`.
+
+## Run the sample
+
+You can run the sample from the command line as following:
+
+```
+$>cd spring-batch-samples
+$>../mvnw -Dtest=TaskletAdapterJobFunctionalTests#testLaunchJob test
+```

spring-batch-samples/src/main/java/org/springframework/batch/sample/adapter/tasklet/README.md

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2006-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.batch.sample.adapter.tasklet;
+
+import org.springframework.batch.core.scope.context.ChunkContext;
+
+public class Task {
+
+	public boolean doWork(ChunkContext chunkContext) {
+		chunkContext.getStepContext().getStepExecution().getJobExecution().getExecutionContext().put("done", "yes");
+		return true;
+	}
+
+}

spring-batch-samples/src/main/java/org/springframework/batch/sample/adapter/tasklet/Task.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.batch.sample.rabbitmq;
+package org.springframework.batch.sample.amqp;
 
 import javax.sql.DataSource;
 
@@ -29,7 +29,6 @@
 import org.springframework.batch.item.ItemWriter;
 import org.springframework.batch.item.amqp.builder.AmqpItemReaderBuilder;
 import org.springframework.batch.item.amqp.builder.AmqpItemWriterBuilder;
-import org.springframework.batch.sample.rabbitmq.processor.MessageProcessor;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;

spring-batch-samples/src/main/java/org/springframework/batch/sample/rabbitmq/AmqpJobConfiguration.java renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/amqp/AmqpJobConfiguration.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.springframework.batch.sample.rabbitmq.amqp;
+package org.springframework.batch.sample.amqp;
 
 import org.springframework.amqp.core.AmqpTemplate;
 import org.springframework.amqp.rabbit.core.RabbitTemplate;
@@ -34,8 +34,8 @@ private AmqpMessageProducer() {
 
 	private static final int SEND_MESSAGE_COUNT = 10;
 
-	private static final String[] BEAN_CONFIG = { "classpath:/META-INF/spring/jobs/messaging/rabbitmq-beans.xml",
-			"classpath:/META-INF/spring/config-beans.xml" };
+	private static final String[] BEAN_CONFIG = {
+			"classpath:org/springframework/batch/sample/amqp/job/rabbitmq-beans.xml" };
 
 	public static void main(String[] args) {
 		ApplicationContext applicationContext = new ClassPathXmlApplicationContext(BEAN_CONFIG);

spring-batch-samples/src/main/java/org/springframework/batch/sample/rabbitmq/amqp/AmqpMessageProducer.java renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/amqp/AmqpMessageProducer.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.springframework.batch.sample.rabbitmq.processor;
+package org.springframework.batch.sample.amqp;
 
 import org.springframework.batch.item.ItemProcessor;
 import org.springframework.lang.Nullable;

spring-batch-samples/src/main/java/org/springframework/batch/sample/rabbitmq/processor/MessageProcessor.java renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/amqp/MessageProcessor.java

@@ -19,6 +19,6 @@ You can run the sample from the command line as following:
 ```
 cd spring-batch-samples
 # Launch the test using the XML configuration
-../mvnw -Dtest=AMQPJobFunctionalTests#testLaunchJobWithXmlConfig test
+../mvnw -Dtest=AmqpJobFunctionalTests#testLaunchJobWithXmlConfig test
 # Launch the test using the Java configuration
-../mvnw -Dtest=AMQPJobFunctionalTests#testLaunchJobWithJavaConfig test
+../mvnw -Dtest=AmqpJobFunctionalTests#testLaunchJobWithJavaConfig test

spring-batch-samples/src/main/java/org/springframework/batch/sample/rabbitmq/README.md renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/amqp/README.md

@@ -0,0 +1,28 @@
+## BeanWrapperMapper Sample
+
+### About
+
+This sample shows the use of automatic mapping from fields in a file
+to a domain object.  The `Trade` and `Person` objects needed
+by the job are created from the Spring configuration using prototype
+beans, and then their properties are set using the
+`BeanWrapperFieldSetMapper`, which sets properties of the
+prototype according to the field names in the file.
+
+Nested property paths are resolved in the same way as normal Spring
+binding occurs, but with a little extra leeway in terms of spelling
+and capitalisation.  Thus for instance, the `Trade` object has a
+property called `customer` (lower case), but the file has been
+configured to have a column name `CUSTOMER` (upper case), and
+the mapper will accept the values happily.  Underscores instead of
+camel-casing (e.g. `CREDIT_CARD` instead of `creditCard`)
+also work.
+
+### Run the sample
+
+You can run the sample from the command line as following:
+
+```
+$>cd spring-batch-samples
+$>../mvnw -Dtest=BeanWrapperMapperSampleJobFunctionalTests#testJobLaunch test
+```

spring-batch-samples/src/main/java/org/springframework/batch/sample/beanwrapper/README.md

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.batch.sample.remotechunking;
+package org.springframework.batch.sample.chunking;
 
 import javax.sql.DataSource;
 

spring-batch-samples/src/main/java/org/springframework/batch/sample/remotechunking/DataSourceConfiguration.java renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/chunking/DataSourceConfiguration.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.springframework.batch.sample.remotechunking;
+package org.springframework.batch.sample.chunking;
 
 import java.util.Arrays;
 
@@ -51,7 +51,7 @@
 @EnableBatchProcessing
 @EnableBatchIntegration
 @EnableIntegration
-@PropertySource("classpath:remote-chunking.properties")
+@PropertySource("classpath:org/springframework/batch/sample/chunking/remote-chunking.properties")
 @Import(DataSourceConfiguration.class)
 public class ManagerConfiguration {
 

spring-batch-samples/src/main/java/org/springframework/batch/sample/remotechunking/ManagerConfiguration.java renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/chunking/ManagerConfiguration.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.springframework.batch.sample.remotechunking;
+package org.springframework.batch.sample.chunking;
 
 import jakarta.jms.JMSException;
 import org.apache.activemq.artemis.jms.client.ActiveMQConnectionFactory;
@@ -50,7 +50,7 @@
 @EnableBatchProcessing
 @EnableBatchIntegration
 @EnableIntegration
-@PropertySource("classpath:remote-chunking.properties")
+@PropertySource("classpath:org/springframework/batch/sample/chunking/remote-chunking.properties")
 @Import(DataSourceConfiguration.class)
 public class WorkerConfiguration {
 

spring-batch-samples/src/main/java/org/springframework/batch/sample/remotechunking/WorkerConfiguration.java renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/chunking/WorkerConfiguration.java

@@ -14,10 +14,11 @@
  * limitations under the License.
  */
 
-package org.springframework.batch.sample.jmx;
+package org.springframework.batch.sample.common;
 
 import org.aspectj.lang.JoinPoint;
 import org.springframework.batch.core.StepExecution;
+import org.springframework.batch.sample.misc.jmx.SimpleMessageApplicationEvent;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.ApplicationEventPublisherAware;
 

spring-batch-samples/src/test/java/org/springframework/batch/sample/common/ErrorLogTasklet.java renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/common/ErrorLogTasklet.java

@@ -0,0 +1,24 @@
+## Composite ItemWriter Sample
+
+### About
+
+This shows a common use case using a composite pattern, composing
+instances of other framework readers or writers.  It is also quite
+common for business-specific readers or writers to wrap
+off-the-shelf components in a similar way.
+
+In this job the composite pattern is used just to make duplicate
+copies of the output data.  The delegates for the
+`CompositeItemWriter` have to be separately registered as
+streams in the `Step` where they are used, in order for the step
+to be restartable.  This is a common feature of all delegate
+patterns.
+
+### Run the sample
+
+You can run the sample from the command line as following:
+
+```
+$>cd spring-batch-samples
+$>../mvnw -Dtest=CompositeItemWriterSampleFunctionalTests#testJobLaunch test
+```

spring-batch-samples/src/test/java/org/springframework/batch/sample/common/SkipCheckingDecider.java renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/common/SkipCheckingDecider.java

@@ -19,7 +19,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import org.springframework.batch.sample.domain.order.Address;
+import org.springframework.batch.sample.file.patternmatching.Address;
 
 public class Person {
 

spring-batch-samples/src/test/java/org/springframework/batch/sample/common/SkipCheckingListener.java renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/common/SkipCheckingListener.java

@@ -19,7 +19,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import org.springframework.batch.sample.domain.order.Address;
+import org.springframework.batch.sample.file.patternmatching.Address;
 
 /**
  * Custom class that contains logic that would normally be be contained in

spring-batch-samples/src/main/java/org/springframework/batch/sample/jmx/StepExecutionApplicationEventAdvice.java renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/common/StepExecutionApplicationEventAdvice.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.springframework.batch.sample.domain.multiline;
+package org.springframework.batch.sample.file.multilineaggregate;
 
 /**
  * A wrapper type for an item that is used by {@link AggregateItemReader} to identify the

spring-batch-samples/src/main/java/org/springframework/batch/sample/compositewriter/README.md

@@ -1,5 +1,5 @@
 /*
- * Copyright 2006-2022 the original author or authors.
+ * Copyright 2006-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.springframework.batch.sample.domain.multiline;
+package org.springframework.batch.sample.file.multilineaggregate;
 
 import org.springframework.batch.item.file.mapping.FieldSetMapper;
 import org.springframework.batch.item.file.transform.FieldSet;

spring-batch-samples/src/main/java/org/springframework/batch/sample/domain/person/Person.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.batch.sample.domain.multiline;
+package org.springframework.batch.sample.file.multilineaggregate;
 
 import java.util.ArrayList;
 import java.util.List;

spring-batch-samples/src/main/java/org/springframework/batch/sample/domain/person/PersonService.java

@@ -0,0 +1,46 @@
+## Multiline Aggregate Sample
+
+### About
+
+The goal of this sample is to show some common tricks with multiline
+records in file input jobs.
+
+The input file in this case consists of two groups of trades
+delimited by special lines in a file (BEGIN and END):
+
+```
+BEGIN
+UK21341EAH4597898.34customer1
+UK21341EAH4611218.12customer2
+END
+BEGIN
+UK21341EAH4724512.78customer2
+UK21341EAH4810809.25customer3
+UK21341EAH4985423.39customer4
+END
+```
+
+The goal of the job is to operate on the two groups, so the item
+type is naturally `List<Trade`>.  To get these items delivered
+from an item reader we employ two components from Spring Batch: the
+`AggregateItemReader` and the
+`PrefixMatchingCompositeLineTokenizer`.  The latter is
+responsible for recognising the difference between the trade data
+and the delimiter records.  The former is responsible for
+aggregating the trades from each group into a `List` and handing
+out the list from its `read()` method.  To help these components
+perform their responsibilities we also provide some business
+knowledge about the data in the form of a `FieldSetMapper`
+(`TradeFieldSetMapper`).  The `TradeFieldSetMapper` checks
+its input for the delimiter fields (BEGIN, END) and if it detects
+them, returns the special tokens that `AggregateItemReader`
+needs.  Otherwise it maps the input into a `Trade` object.
+
+### Run the sample
+
+You can run the sample from the command line as following:
+
+```
+$>cd spring-batch-samples
+$>../mvnw -Dtest=MultilineAggregateJobFunctionalTests#testJobLaunch test
+```

spring-batch-samples/src/test/java/org/springframework/batch/sample/domain/trade/internal/ItemTrackingTradeItemWriter.java renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/domain/trade/internal/ItemTrackingTradeItemWriter.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.batch.sample.domain.order;
+package org.springframework.batch.sample.file.patternmatching;
 
 public class Address {
 

spring-batch-samples/src/main/java/org/springframework/batch/sample/domain/multiline/AggregateItem.java renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/file/multilineaggregate/AggregateItem.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.batch.sample.domain.order;
+package org.springframework.batch.sample.file.patternmatching;
 
 public class BillingInfo {
 

spring-batch-samples/src/main/java/org/springframework/batch/sample/domain/multiline/AggregateItemFieldSetMapper.java renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/file/multilineaggregate/AggregateItemFieldSetMapper.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.batch.sample.domain.order;
+package org.springframework.batch.sample.file.patternmatching;
 
 public class Customer {
 

spring-batch-samples/src/main/java/org/springframework/batch/sample/domain/multiline/AggregateItemReader.java renamed to spring-batch-samples/src/main/java/org/springframework/batch/sample/file/multilineaggregate/AggregateItemReader.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.batch.sample.domain.order;
+package org.springframework.batch.sample.file.patternmatching;
 
 import java.math.BigDecimal;
 

spring-batch-samples/src/main/java/org/springframework/batch/sample/file/multilineaggregate/README.md

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.batch.sample.domain.order;
+package org.springframework.batch.sample.file.patternmatching;
 
 import java.math.BigDecimal;
 import java.util.Date;