Spring/spring-batch
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

OPEN - issue BATCH-404: FactoryBeans for step configuration

Browse Source 
http://jira.springframework.org/browse/BATCH-404

Introduce DefaultStepFactory and reduce reliance on KitchenSink.
This commit is contained in:
dsyer
2008-03-02 11:42:10 +00:00
parent f879ca375e
commit df0c615ff8
18 changed files with 124 additions and 257 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
spring-batch-execution/src/main/java/org/springframework/batch/execution/listener/RepeatListenerItemReadListenerAdapter.java
View File

@@ -1,100 +0,0 @@
/*
* Copyright 2006-2007 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
*
* http://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.execution.listener;
import org.springframework.batch.core.domain.ItemReadListener;
import org.springframework.batch.repeat.RepeatContext;
import org.springframework.batch.repeat.RepeatListener;
import org.springframework.batch.repeat.synch.RepeatSynchronizationManager;
import org.springframework.util.ObjectUtils;
/**
* Adapts a {@link RepeatListener} to the {@link ItemReadListener} interface.
* The {@link RepeatListener} is assumed to be targeted at the chunk operations
* in a step, so after an item corresponds to the after method in
* {@link RepeatListener}.<br/>
*
* The open and close methods on the {@link RepeatListener} are also invoked.
* The open method is called on the first call to {@link #beforeRead()}, and
* the close is registered as a destruction callback in the
* {@link RepeatContext}.<br/>
*
* A {@link RepeatContext} is obtained as needed from the
* {@link RepeatSynchronizationManager}.
*
* @author Dave Syer
*
*/
public class RepeatListenerItemReadListenerAdapter implements ItemReadListener {
private RepeatListener delegate;
/**
* @param delegate
*/
public RepeatListenerItemReadListenerAdapter(RepeatListener delegate) {
super();
this.delegate = delegate;
}
/**
* Does nothing.
*
* @see org.springframework.batch.core.domain.ItemReadListener#afterRead(java.lang.Object)
*/
public void afterRead(Object item) {
// NO-OP
}
/**
* Calls the delegate {@link RepeatListener#before}. Also calls
* {@link RepeatListener#open} if it hasn't been called yet on this context.
*
* @see org.springframework.batch.core.domain.ItemReadListener#beforeRead()
*/
public void beforeRead() {
RepeatContext context = RepeatSynchronizationManager.getContext();
maybeOpen(context);
delegate.before(context);
}
/**
* @param context
*/
private void maybeOpen(final RepeatContext context) {
String identity = ObjectUtils.identityToString(delegate);
if (!context.hasAttribute(identity)) {
context.setAttribute(identity, Boolean.TRUE);
delegate.open(context);
context.registerDestructionCallback(identity, new Runnable() {
public void run() {
delegate.close(context);
}
});
}
}
/**
* Calls the delegate {@link RepeatListener#onError}.
*
* @see org.springframework.batch.core.domain.ItemReadListener#onReadError(java.lang.Exception)
*/
public void onReadError(Exception ex) {
delegate.onError(RepeatSynchronizationManager.getContext(), ex);
}
}

77
spring-batch-execution/src/main/java/org/springframework/batch/execution/listener/RepeatListenerItemWriteListenerAdapter.java
View File

@@ -1,77 +0,0 @@
/*
* Copyright 2006-2007 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
*
* http://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.execution.listener;
import org.springframework.batch.core.domain.ItemWriteListener;
import org.springframework.batch.repeat.ExitStatus;
import org.springframework.batch.repeat.RepeatContext;
import org.springframework.batch.repeat.RepeatListener;
import org.springframework.batch.repeat.synch.RepeatSynchronizationManager;
/**
* Adapts a {@link RepeatListener} to the {@link ItemWriteListener} interface.
* The {@link RepeatListener} is assumed to be targeted at the chunk operations
* in a step, so after an item corresponds to the after method in
* {@link RepeatListener}.<br/>
*
* A {@link RepeatContext} is obtained as needed from the
* {@link RepeatSynchronizationManager}.
*
* @author Dave Syer
*
*/
public class RepeatListenerItemWriteListenerAdapter implements ItemWriteListener {
private RepeatListener delegate;
/**
* @param delegate
*/
public RepeatListenerItemWriteListenerAdapter(RepeatListener delegate) {
super();
this.delegate = delegate;
}
/**
* Calls the delegate {@link RepeatListener#after} with
* {@link ExitStatus#CONTINUABLE}.
*
* @see org.springframework.batch.core.domain.ItemWriteListener#afterWrite()
*/
public void afterWrite() {
delegate.after(RepeatSynchronizationManager.getContext(), ExitStatus.CONTINUABLE);
}
/**
* Does nothing.
*
* @see org.springframework.batch.core.domain.ItemWriteListener#beforeWrite(java.lang.Object)
*/
public void beforeWrite(Object item) {
// NO-OP
}
/**
* Calls the delegate {@link RepeatListener#onError} ignoring the item.
*
* @see org.springframework.batch.core.domain.ItemWriteListener#onWriteError(java.lang.Exception,
* java.lang.Object)
*/
public void onWriteError(Exception ex, Object item) {
delegate.onError(RepeatSynchronizationManager.getContext(), ex);
}
}

45
spring-batch-execution/src/main/java/org/springframework/batch/execution/step/support/DefaultStepFactoryBean.java Normal file
View File

@@ -0,0 +1,45 @@
/*
* Copyright 2006-2007 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
*
* http://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.execution.step.support;
import org.springframework.batch.execution.step.ItemOrientedStep;
/**
* Adds listeners to {@link SimpleStepFactoryBean}.
*
* @author Dave Syer
*
*/
public class DefaultStepFactoryBean extends SimpleStepFactoryBean {
private Object[] listeners = new Object[0];
/**
* @param listeners
*/
public void setListeners(Object[] listeners) {
this.listeners = listeners;
}
/**
* @param step
*
*/
protected void applyConfiguration(ItemOrientedStep step) {
super.applyConfiguration(step);
step.setListeners(listeners);
}
}

32
spring-batch-execution/src/main/java/org/springframework/batch/execution/step/support/KitchenSinkStepFactoryBean.java
View File

@@ -16,16 +16,18 @@
package org.springframework.batch.execution.step.support;
import org.springframework.batch.core.domain.ItemSkipPolicy;
import org.springframework.batch.core.domain.Step;
import org.springframework.batch.execution.step.ItemOrientedStep;
import org.springframework.batch.item.ItemKeyGenerator;
import org.springframework.batch.repeat.RepeatOperations;
import org.springframework.batch.repeat.exception.handler.ExceptionHandler;
import org.springframework.batch.repeat.policy.SimpleCompletionPolicy;
import org.springframework.batch.repeat.support.RepeatTemplate;
import org.springframework.batch.repeat.support.TaskExecutorRepeatTemplate;
import org.springframework.batch.retry.RetryPolicy;
import org.springframework.batch.retry.callback.ItemReaderRetryCallback;
import org.springframework.batch.retry.policy.ItemReaderRetryPolicy;
import org.springframework.batch.retry.support.RetryTemplate;
import org.springframework.core.task.TaskExecutor;
/**
* @author Dave Syer
@@ -39,9 +41,9 @@ public class KitchenSinkStepFactoryBean extends AbstractStepFactoryBean {
private ItemSkipPolicy itemSkipPolicy = new NeverSkipItemSkipPolicy();
private RepeatOperations stepOperations = new RepeatTemplate();
private TaskExecutor taskExecutor;
private RetryPolicy retryPolicy = null;
private RetryPolicy retryPolicy;
private ExceptionHandler exceptionHandler;
@@ -71,11 +73,13 @@ public class KitchenSinkStepFactoryBean extends AbstractStepFactoryBean {
}
/**
* Public setter for the RepeatOperations.
* @param stepOperations the stepOperations to set
* Public setter for the {@link TaskExecutor}. If this is set, then it will
* be used to execute the chunk processing inside the {@link Step}.
*
* @param taskExecutor the taskExecutor to set
*/
public void setStepOperations(RepeatOperations stepOperations) {
this.stepOperations = stepOperations;
public void setTaskExecutor(TaskExecutor taskExecutor) {
this.taskExecutor = taskExecutor;
}
/**
@@ -111,9 +115,9 @@ public class KitchenSinkStepFactoryBean extends AbstractStepFactoryBean {
*
*/
protected void applyConfiguration(ItemOrientedStep step) {
super.applyConfiguration(step);
step.setListeners(listeners);
step.setItemSkipPolicy(itemSkipPolicy);
@@ -133,7 +137,15 @@ public class KitchenSinkStepFactoryBean extends AbstractStepFactoryBean {
step.setChunkOperations(chunkOperations);
}
if (exceptionHandler != null && stepOperations instanceof RepeatTemplate) {
RepeatTemplate stepOperations = new RepeatTemplate();
if (taskExecutor != null) {
TaskExecutorRepeatTemplate repeatTemplate = new TaskExecutorRepeatTemplate();
repeatTemplate.setTaskExecutor(taskExecutor);
stepOperations = repeatTemplate;
}
if (exceptionHandler != null) {
((RepeatTemplate) stepOperations).setExceptionHandler(exceptionHandler);
step.setStepOperations(stepOperations);
}

13
spring-batch-execution/src/main/java/org/springframework/batch/execution/step/support/ListenerMulticaster.java
View File

@@ -25,15 +25,11 @@ import org.springframework.batch.execution.listener.CompositeChunkListener;
import org.springframework.batch.execution.listener.CompositeItemReadListener;
import org.springframework.batch.execution.listener.CompositeItemWriteListener;
import org.springframework.batch.execution.listener.CompositeStepListener;
import org.springframework.batch.execution.listener.RepeatListenerItemReadListenerAdapter;
import org.springframework.batch.execution.listener.RepeatListenerItemWriteListenerAdapter;
import org.springframework.batch.item.ExecutionContext;
import org.springframework.batch.item.ItemStream;
import org.springframework.batch.item.exception.StreamException;
import org.springframework.batch.item.stream.CompositeItemStream;
import org.springframework.batch.repeat.ExitStatus;
import org.springframework.batch.repeat.RepeatListener;
import org.springframework.batch.repeat.listener.CompositeRepeatListener;
/**
* @author Dave Syer
@@ -52,15 +48,11 @@ public class ListenerMulticaster implements ItemStream, StepListener, ChunkListe
private CompositeItemWriteListener itemWriteListener = new CompositeItemWriteListener();
private CompositeRepeatListener repeatListener = new CompositeRepeatListener();
/**
* Initialise the listener instance.
*/
public ListenerMulticaster() {
super();
itemWriteListener.register(new RepeatListenerItemWriteListenerAdapter(repeatListener));
itemReadListener.register(new RepeatListenerItemReadListenerAdapter(repeatListener));
}
/**
@@ -79,7 +71,7 @@ public class ListenerMulticaster implements ItemStream, StepListener, ChunkListe
/**
* Register the listener for callbacks on the appropriate interfaces
* implemented. Any {@link BatchListener} can be provided, or an
* {@link ItemStream}. Other types will be ignored.
* {@link ItemStream}. Other types will be ignored.
*/
public void register(Object listener) {
if (listener instanceof StepListener) {
@@ -97,9 +89,6 @@ public class ListenerMulticaster implements ItemStream, StepListener, ChunkListe
if (listener instanceof ItemWriteListener) {
this.itemWriteListener.register((ItemWriteListener) listener);
}
if (listener instanceof RepeatListener) {
this.repeatListener.register((RepeatListener) listener);
}
}
/**

2
spring-batch-execution/src/test/resources/org/springframework/batch/execution/configuration/test-context.xml
View File

@@ -20,7 +20,7 @@
<bean id="test-job"
class="org.springframework.batch.execution.job.JobSupport">
<property name="steps">
<bean id="step1" class="org.springframework.batch.execution.step.support.KitchenSinkStepFactoryBean">
<bean id="step1" class="org.springframework.batch.execution.step.support.SimpleStepFactoryBean">
<property name="itemReader" ref="itemReader" />
<property name="itemWriter" ref="itemWriter" />
<property name="jobRepository" ref="jobRepository" />

2
spring-batch-samples/src/main/resources/jobs/beanWrapperMapperSampleJob.xml
View File

@@ -12,7 +12,7 @@
<bean id="beanWrapperMapperJob" parent="simpleJob">
<property name="steps">
<list>
<bean id="step1" parent="simpleStep">
<bean id="step1" parent="defaultStep">
<property name="listeners" ref="fileInputTemplate" />
<property name="itemReader">
<bean

2
spring-batch-samples/src/main/resources/jobs/compositeProcessorSampleJob.xml
View File

@@ -11,7 +11,7 @@
<bean id="compositeProcessorJob" parent="simpleJob">
<property name="steps">
<bean id="step1" parent="simpleStep">
<bean id="step1" parent="defaultStep">
<property name="listeners" ref="fileInputTemplate" />
<property name="itemReader">
<bean

2
spring-batch-samples/src/main/resources/jobs/fixedLengthImportJob.xml
View File

@@ -11,7 +11,7 @@
<bean id="fixedLengthImportJob" parent="simpleJob">
<property name="steps">
<bean id="step1" parent="simpleStep">
<bean id="step1" parent="defaultStep">
<property name="listeners" ref="fileInputTemplate" />
<property name="itemReader">
<bean

11
spring-batch-samples/src/main/resources/jobs/hibernateJob.xml
View File

@@ -15,11 +15,20 @@
<!-- set restartable=false so that this job can be used by more than one test -->
<property name="restartable" value="false" />
<property name="steps">
<bean id="step1" parent="simpleStep">
<bean id="step1" parent="defaultStep"
class="org.springframework.batch.execution.step.support.KitchenSinkStepFactoryBean">
<property name="itemReader" ref="hibernateItemReader" />
<property name="itemWriter" ref="hibernateOutputSource" />
<property name="commitInterval" value="3" />
<property name="exceptionHandler">
<bean
class="org.springframework.batch.repeat.exception.handler.SimpleLimitExceptionHandler">
<property name="limit" value="5" />
<property name="useParent" value="true" />
</bean>
</property>
<property name="itemSkipPolicy">
<bean
class="org.springframework.batch.execution.step.support.AlwaysSkipItemSkipPolicy" />

2
spring-batch-samples/src/main/resources/jobs/multilineJob.xml
View File

@@ -9,7 +9,7 @@
<bean id="multilineJob" parent="simpleJob">
<property name="steps">
<bean id="step1" parent="simpleStep">
<bean id="step1" parent="defaultStep">
<property name="listeners" ref="fileItemReader"/>
<property name="itemReader">
<bean

2
spring-batch-samples/src/main/resources/jobs/multilineOrderJob.xml
View File

@@ -13,7 +13,7 @@
<bean id="multilineOrderJob" parent="simpleJob">
<property name="steps">
<bean id="step1" parent="simpleStep">
<bean id="step1" parent="defaultStep">
<property name="listeners">
<list>
<ref bean="orderWriter" />

21
spring-batch-samples/src/main/resources/jobs/parallelJob.xml
View File

@@ -8,14 +8,14 @@
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.0.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.0.xsd">
<bean id="parallelJob" parent="simpleJob">
<property name="steps">
<list>
<bean id="staging" parent="simpleStep">
<property name="commitInterval" value="2" />
<property name="startLimit" value="100" />
<property name="listeners" ref="fileInputTemplate"/>
<bean id="staging" parent="defaultStep">
<property name="commitInterval" value="2" />
<property name="startLimit" value="100" />
<property name="listeners" ref="fileInputTemplate" />
<property name="itemReader">
<bean
class="org.springframework.batch.item.reader.ValidatingItemReader">
@@ -41,15 +41,10 @@
</bean>
</property>
</bean>
<bean id="loading" parent="simpleStep">
<property name="stepOperations">
<bean id="loading" parent="simpleStep" class="org.springframework.batch.execution.step.support.KitchenSinkStepFactoryBean">
<property name="taskExecutor">
<bean
class="org.springframework.batch.repeat.support.TaskExecutorRepeatTemplate">
<property name="taskExecutor">
<bean
class="org.springframework.core.task.SimpleAsyncTaskExecutor" />
</property>
</bean>
class="org.springframework.core.task.SimpleAsyncTaskExecutor" />
</property>
<property name="itemReader">
<bean

7
spring-batch-samples/src/main/resources/jobs/restartSample.xml
View File

@@ -11,7 +11,7 @@
<bean id="restartSampleJob" parent="simpleJob">
<property name="steps">
<bean id="step1" parent="simpleStep">
<bean id="step1" parent="defaultStep">
<property name="listeners" ref="fileItemReader"/>
<property name="itemReader">
<bean
@@ -28,11 +28,6 @@
</bean>
</property>
<property name="commitInterval" value="2" />
<property name="exceptionHandler">
<bean class="org.springframework.batch.repeat.exception.handler.SimpleLimitExceptionHandler">
<property name="limit" value="0"/>
</bean>
</property>
</bean>
</property>
</bean>

22
spring-batch-samples/src/main/resources/jobs/retrySample.xml
View File

@@ -8,19 +8,26 @@
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.0.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.0.xsd">
<bean id="retrySample" parent="simpleJob">
<property name="steps">
<bean id="step1" parent="simpleStep">
<property name="itemReader" ref="itemGenerator" />
<property name="itemWriter" ref="itemWriter" />
<property name="retryPolicy">
<bean id="step1" parent="simpleStep"
class="org.springframework.batch.execution.step.support.KitchenSinkStepFactoryBean">
<property name="itemReader" ref="itemGenerator" />
<property name="itemWriter" ref="itemWriter" />
<property name="retryPolicy">
<bean
class="org.springframework.batch.retry.policy.SimpleRetryPolicy">
<property name="maxAttempts" value="3" />
<property name="retryableExceptionClasses" value="java.lang.Exception" />
<property name="retryableExceptionClasses"
value="java.lang.Exception" />
</bean>
</property>
<property name="exceptionHandler">
<bean
class="org.springframework.batch.repeat.exception.handler.SimpleLimitExceptionHandler"
p:limit="5" />
</property>
</bean>
</property>
</bean>
@@ -30,7 +37,8 @@
<property name="limit" value="10" />
</bean>
<bean id="itemGenerator" parent="testGenerator" autowire-candidate="false"/>
<bean id="itemGenerator" parent="testGenerator"
autowire-candidate="false" />
<bean id="itemWriter"
class="org.springframework.batch.sample.item.writer.RetrySampleItemWriter" />

12
spring-batch-samples/src/main/resources/jobs/rollbackJob.xml
View File

@@ -7,21 +7,19 @@
http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-2.0.xsd">
<import resource="tradeJobIo.xml" />
<!--import resource="tradeJobAop.xml" /-->
<bean id="tradeJob" parent="simpleJob">
<property name="steps">
<list>
<bean id="step1" parent="simpleStep">
<property name="retryPolicy">
<bean
class="org.springframework.batch.retry.policy.SimpleRetryPolicy" />
</property>
<bean id="step1" parent="simpleStep"
class="org.springframework.batch.execution.step.support.KitchenSinkStepFactoryBean">
<property name="exceptionHandler">
<bean
class="org.springframework.batch.repeat.exception.handler.SimpleLimitExceptionHandler" p:limit="5"/>
class="org.springframework.batch.repeat.exception.handler.SimpleLimitExceptionHandler"
p:limit="5" />
</property>
<property name="listeners" ref="fileInputTemplate" />
<property name="itemReader">

2
spring-batch-samples/src/main/resources/jobs/tradeJob.xml
View File

@@ -13,7 +13,7 @@
<bean id="tradeJob" parent="simpleJob">
<property name="steps">
<list>
<bean id="step1" parent="simpleStep">
<bean id="step1" parent="defaultStep">
<property name="listeners" ref="fileInputTemplate" />
<property name="itemReader">
<bean

27
spring-batch-samples/src/main/resources/simple-container-definition.xml
View File

@@ -67,9 +67,9 @@
</bean>
<bean id="mapJobInstanceDao" lazy-init="true"
class="org.springframework.batch.execution.repository.dao.MapJobInstanceDao" />
<bean id="mapJobExecutionDao" lazy-init="true"
class="org.springframework.batch.execution.repository.dao.MapJobInstanceDao" />
<bean id="mapJobExecutionDao" lazy-init="true"
class="org.springframework.batch.execution.repository.dao.MapJobExecutionDao" />
<bean id="mapStepExecutionDao" lazy-init="true"
@@ -95,25 +95,18 @@
</bean>
<bean id="simpleStep"
class="org.springframework.batch.execution.step.support.KitchenSinkStepFactoryBean"
class="org.springframework.batch.execution.step.support.SimpleStepFactoryBean"
abstract="true">
<property name="transactionManager" ref="transactionManager" />
<property name="jobRepository" ref="jobRepository" />
<property name="startLimit" value="100"/>
<property name="exceptionHandler">
<bean
class="org.springframework.batch.repeat.exception.handler.SimpleLimitExceptionHandler">
<property name="limit" value="5" />
<property name="useParent" value="true" />
</bean>
</property>
<property name="startLimit" value="100" />
<property name="commitInterval" value="1" />
</bean>
<bean id="defaultStep" parent="simpleStep"
class="org.springframework.batch.execution.step.support.DefaultStepFactoryBean"
abstract="true" />
<bean id="customEditorConfigurer"
class="org.springframework.beans.factory.config.CustomEditorConfigurer">
<property name="customEditors">
@@ -161,7 +154,7 @@
<aop:after
pointcut="execution( * org.springframework.batch..Step+.execute(..))"
method="after" />
<aop:after-throwing throwing="t"
<aop:after-throwing throwing="t"
pointcut="execution( * org.springframework.batch..Step+.execute(..))"
method="onError" />
</aop:aspect>