Class TaskletStep
java.lang.Object
org.springframework.batch.core.step.AbstractStep
org.springframework.batch.core.step.tasklet.TaskletStep
- All Implemented Interfaces:
Step
,org.springframework.beans.factory.Aware
,org.springframework.beans.factory.BeanNameAware
,org.springframework.beans.factory.InitializingBean
Simple implementation of executing the step as a call to a
Clients can use interceptors in the step operations to intercept or listen to the iteration on a step-wide basis, for instance to get a callback when the step is complete. Those that want callbacks at the level of an individual tasks, can specify interceptors for the chunk operations.
Tasklet
, possibly
repeated, and each call surrounded by a transaction. The structure is therefore that of
a loop with transaction boundary inside the loop. The loop is controlled by the step
operations ( setStepOperations(RepeatOperations)
).Clients can use interceptors in the step operations to intercept or listen to the iteration on a step-wide basis, for instance to get a callback when the step is complete. Those that want callbacks at the level of an individual tasks, can specify interceptors for the chunk operations.
- Author:
- Dave Syer, Lucas Ward, Ben Hale, Robert Kasanicky, Michael Minella, Will Schipp, Mahmoud Ben Hassine
-
Field Summary
FieldsFields inherited from interface org.springframework.batch.core.Step
STEP_TYPE_KEY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
protected void
close
(ExecutionContext ctx) Extension point for subclasses to provide callbacks to their collaborators at the end of a step (right at the end of the finally block), to close or release resources.protected Semaphore
Extension point mainly for test purposes so that the behaviour of the lock can be manipulated to simulate various pathologies.protected void
doExecute
(StepExecution stepExecution) Process the step and update its context so that progress can be monitored by the caller.retrieve the tasklet - helper method for JobOperatorprotected void
open
(ExecutionContext ctx) Extension point for subclasses to provide callbacks to their collaborators at the beginning of a step, to open or acquire resources.void
registerChunkListener
(ChunkListener listener) Register a chunk listener for callbacks at the appropriate stages in a step execution.void
registerStream
(ItemStream stream) Register a singleItemStream
for callbacks to the stream interface.void
setChunkListeners
(ChunkListener[] listeners) Register each of the objects as listeners.void
setInterruptionPolicy
(StepInterruptionPolicy interruptionPolicy) Setter for theStepInterruptionPolicy
.void
setStepOperations
(RepeatOperations stepOperations) TheRepeatOperations
to use for the outer loop of the batch processing.void
setStreams
(ItemStream[] streams) Register each of the streams for callbacks at the appropriate time in the step.void
setTasklet
(Tasklet tasklet) Public setter for theTasklet
.void
setTransactionAttribute
(org.springframework.transaction.interceptor.TransactionAttribute transactionAttribute) Public setter for theTransactionAttribute
.void
setTransactionManager
(org.springframework.transaction.PlatformTransactionManager transactionManager) Public setter for thePlatformTransactionManager
.Methods inherited from class org.springframework.batch.core.step.AbstractStep
doExecutionRegistration, doExecutionRelease, execute, getCompositeListener, getJobRepository, getName, getStartLimit, isAllowStartIfComplete, registerStepExecutionListener, setAllowStartIfComplete, setBeanName, setJobRepository, setMeterRegistry, setName, setObservationConvention, setObservationRegistry, setStartLimit, setStepExecutionListeners, toString
-
Field Details
-
TASKLET_TYPE_KEY
- See Also:
-
-
Constructor Details
-
TaskletStep
public TaskletStep()Default constructor. -
TaskletStep
- Parameters:
name
- the name for theTaskletStep
-
-
Method Details
-
afterPropertiesSet
- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Overrides:
afterPropertiesSet
in classAbstractStep
- Throws:
Exception
-
setTransactionManager
public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager) Public setter for thePlatformTransactionManager
.- Parameters:
transactionManager
- the transaction manager to set
-
setTransactionAttribute
public void setTransactionAttribute(org.springframework.transaction.interceptor.TransactionAttribute transactionAttribute) Public setter for theTransactionAttribute
.- Parameters:
transactionAttribute
- theTransactionAttribute
to set
-
setTasklet
Public setter for theTasklet
.- Parameters:
tasklet
- theTasklet
to set
-
registerChunkListener
Register a chunk listener for callbacks at the appropriate stages in a step execution.- Parameters:
listener
- aChunkListener
-
setChunkListeners
Register each of the objects as listeners.- Parameters:
listeners
- an array of listener objects of known types.
-
setStreams
Register each of the streams for callbacks at the appropriate time in the step. TheItemReader
andItemWriter
are automatically registered, but it doesn't hurt to also register them here. Injected dependencies of the reader and writer are not automatically registered, so if you implementItemWriter
using delegation to another object which itself is aItemStream
, you need to register the delegate here.- Parameters:
streams
- an array ofItemStream
objects.
-
registerStream
Register a singleItemStream
for callbacks to the stream interface.- Parameters:
stream
- instance ofItemStream
-
setStepOperations
TheRepeatOperations
to use for the outer loop of the batch processing. Should be set up by the caller through a factory. Defaults to a plainRepeatTemplate
.- Parameters:
stepOperations
- aRepeatOperations
instance.
-
setInterruptionPolicy
Setter for theStepInterruptionPolicy
. The policy is used to check whether an external request has been made to interrupt the job execution.- Parameters:
interruptionPolicy
- aStepInterruptionPolicy
-
doExecute
Process the step and update its context so that progress can be monitored by the caller. The step is broken down into chunks, each one executing in a transaction. The step and its execution and execution context are all given an up to dateBatchStatus
, and theJobRepository
is used to store the result. Various reporting information are also added to the current context governing the step execution, which would normally be available to the caller through the step'sExecutionContext
.- Specified by:
doExecute
in classAbstractStep
- Parameters:
stepExecution
- the current step context- Throws:
JobInterruptedException
- if the step or a chunk is interruptedRuntimeException
- if there is an exception during a chunk executionException
- checked exception thrown by implementation
-
createSemaphore
Extension point mainly for test purposes so that the behaviour of the lock can be manipulated to simulate various pathologies.- Returns:
- a semaphore for locking access to the JobRepository
-
close
Description copied from class:AbstractStep
Extension point for subclasses to provide callbacks to their collaborators at the end of a step (right at the end of the finally block), to close or release resources. Does nothing by default.- Overrides:
close
in classAbstractStep
- Parameters:
ctx
- theExecutionContext
to use- Throws:
Exception
- checked exception thrown by implementation
-
open
Description copied from class:AbstractStep
Extension point for subclasses to provide callbacks to their collaborators at the beginning of a step, to open or acquire resources. Does nothing by default.- Overrides:
open
in classAbstractStep
- Parameters:
ctx
- theExecutionContext
to use- Throws:
Exception
- checked exception thrown by implementation
-
getTasklet
retrieve the tasklet - helper method for JobOperator- Returns:
- the
Tasklet
instance being executed within this step
-