Uses of Class
org.springframework.batch.core.StepExecution

Packages that use StepExecution

Package	Description
org.springframework.batch.core	Core domain context for Spring Batch covering jobs, steps, configuration and execution abstractions.
org.springframework.batch.core.explore	Interfaces and related classes to support meta data browsing.
org.springframework.batch.core.explore.support	Specific implementations of explorer concerns.
org.springframework.batch.core.job	Specific implementations of job concerns.
org.springframework.batch.core.job.flow	Flow related constructs including Flow interface, executors, and related exceptions
org.springframework.batch.core.job.flow.support	Basic implementations of flow constructs
org.springframework.batch.core.listener	Generic implementations of core batch listener interfaces.
org.springframework.batch.core.observability	This package contains APIs related to batch observability.
org.springframework.batch.core.partition	Interfaces for partitioning components.
org.springframework.batch.core.partition.support	Implementation of common partition components.
org.springframework.batch.core.repository	Interfaces and generic implementations of repository concerns.
org.springframework.batch.core.repository.dao	Specific implementations of dao concerns.
org.springframework.batch.core.repository.support	Specific implementations of repository concerns.
org.springframework.batch.core.resource
org.springframework.batch.core.scope.context	Implementation of the contexts for each of the custom bean scopes in Spring Batch (Job and Step).
org.springframework.batch.core.step	Specific implementations of step concerns.
org.springframework.batch.core.step.item	Specific implementations of step concerns for item-oriented approach.
org.springframework.batch.core.step.job	JobStep and related components.
org.springframework.batch.core.step.tasklet	Interfaces and generic implementations of tasklet concerns.
org.springframework.batch.integration.chunk	Components for remote chunking.
org.springframework.batch.integration.partition	Remote partitioning components.
org.springframework.batch.integration.step	Support classes related to steps when used with Spring Integration.
org.springframework.batch.test	Utility classes for batch job/step testing.

Uses of StepExecution in org.springframework.batch.core

Methods in org.springframework.batch.core that return StepExecution

Modifier and Type	Method	Description
StepExecution	JobExecution.createStepExecution(String stepName)	Register a step execution with the current job execution.
StepExecution	StepContribution.getStepExecution()	Public getter for the parent step execution of this contribution.

Methods in org.springframework.batch.core that return types with arguments of type StepExecution

Modifier and Type	Method	Description
Collection<StepExecution>	JobExecution.getStepExecutions()	Accessor for the step executions.

Methods in org.springframework.batch.core with parameters of type StepExecution

Modifier and Type	Method	Description
default ExitStatus	StepExecutionListener.afterStep(StepExecution stepExecution)	Give a listener a chance to modify the exit status from a step.
default void	StepExecutionListener.beforeStep(StepExecution stepExecution)	Initialize the state of the listener with the StepExecution from the current scope.
void	Step.execute(StepExecution stepExecution)	Process the step and assign progress and status meta information to the StepExecution provided.

Method parameters in org.springframework.batch.core with type arguments of type StepExecution

Modifier and Type	Method	Description
void	JobExecution.addStepExecutions(List<StepExecution> stepExecutions)	Add some step executions.

Constructors in org.springframework.batch.core with parameters of type StepExecution

Modifier	Constructor	Description
	StepContribution(StepExecution execution)

Uses of StepExecution in org.springframework.batch.core.explore

Methods in org.springframework.batch.core.explore that return StepExecution

Modifier and Type	Method	Description
StepExecution	JobExplorer.getStepExecution(Long jobExecutionId, Long stepExecutionId)	Retrieve a StepExecution by its ID and parent JobExecution ID.

Uses of StepExecution in org.springframework.batch.core.explore.support

Methods in org.springframework.batch.core.explore.support that return StepExecution

Modifier and Type	Method	Description
StepExecution	SimpleJobExplorer.getStepExecution(Long jobExecutionId, Long executionId)

Uses of StepExecution in org.springframework.batch.core.job

Methods in org.springframework.batch.core.job that return StepExecution

Modifier and Type	Method	Description
protected final StepExecution	AbstractJob.handleStep(Step step, JobExecution execution)	Convenience method for subclasses to delegate the handling of a specific step in the context of the current JobExecution.
StepExecution	SimpleStepHandler.handleStep(Step step, JobExecution execution)
StepExecution	StepHandler.handleStep(Step step, JobExecution jobExecution)	Handle a step and return the execution for it.

Methods in org.springframework.batch.core.job with parameters of type StepExecution

Modifier and Type	Method	Description
protected boolean	SimpleStepHandler.shouldStart(StepExecution lastStepExecution, JobExecution jobExecution, Step step)	Given a step and configuration, return true if the step should start, false if it should not, and throw an exception if the job should finish.

Uses of StepExecution in org.springframework.batch.core.job.flow

Methods in org.springframework.batch.core.job.flow that return StepExecution

Modifier and Type	Method	Description
StepExecution	FlowExecutor.getStepExecution()
StepExecution	JobFlowExecutor.getStepExecution()

Methods in org.springframework.batch.core.job.flow with parameters of type StepExecution

Modifier and Type	Method	Description
FlowExecutionStatus	JobExecutionDecider.decide(JobExecution jobExecution, StepExecution stepExecution)	Strategy for branching an execution based on the state of an ongoing JobExecution.
protected void	FlowStep.doExecute(StepExecution stepExecution)	Delegate to the flow provided for the execution of the step.

Uses of StepExecution in org.springframework.batch.core.job.flow.support

Methods in org.springframework.batch.core.job.flow.support with parameters of type StepExecution

Modifier and Type	Method	Description
protected boolean	SimpleFlow.isFlowContinued(State state, FlowExecutionStatus status, StepExecution stepExecution)
protected State	SimpleFlow.nextState(String stateName, FlowExecutionStatus status, StepExecution stepExecution)

Uses of StepExecution in org.springframework.batch.core.listener

Methods in org.springframework.batch.core.listener with parameters of type StepExecution

Modifier and Type	Method	Description
ExitStatus	CompositeStepExecutionListener.afterStep(StepExecution stepExecution)	Call the registered listeners in reverse order, respecting and prioritizing those that implement Ordered.
ExitStatus	ExecutionContextPromotionListener.afterStep(StepExecution stepExecution)
ExitStatus	MulticasterBatchListener.afterStep(StepExecution stepExecution)
ExitStatus	StepExecutionListenerSupport.afterStep(StepExecution stepExecution)	Deprecated.
void	CompositeStepExecutionListener.beforeStep(StepExecution stepExecution)	Call the registered listeners in order, respecting and prioritizing those that implement Ordered.
void	JobParameterExecutionContextCopyListener.beforeStep(StepExecution stepExecution)	Copy attributes from the JobParameters to the Step ExecutionContext, if not already present.
void	MulticasterBatchListener.beforeStep(StepExecution stepExecution)
void	StepExecutionListenerSupport.beforeStep(StepExecution stepExecution)	Deprecated.

Uses of StepExecution in org.springframework.batch.core.observability

Methods in org.springframework.batch.core.observability that return StepExecution

Modifier and Type	Method	Description
StepExecution	BatchStepContext.getStepExecution()

Constructors in org.springframework.batch.core.observability with parameters of type StepExecution

Modifier	Constructor	Description
	BatchStepContext(StepExecution stepExecution)

Uses of StepExecution in org.springframework.batch.core.partition

Methods in org.springframework.batch.core.partition that return types with arguments of type StepExecution

Modifier and Type	Method	Description
Collection<StepExecution>	PartitionHandler.handle(StepExecutionSplitter stepSplitter, StepExecution stepExecution)	Main entry point for PartitionHandler interface.
Set<StepExecution>	StepExecutionSplitter.split(StepExecution stepExecution, int gridSize)	Partition the provided StepExecution into a set of parallel executable instances with the same parent JobExecution.

Methods in org.springframework.batch.core.partition with parameters of type StepExecution

Modifier and Type	Method	Description
Collection<StepExecution>	PartitionHandler.handle(StepExecutionSplitter stepSplitter, StepExecution stepExecution)	Main entry point for PartitionHandler interface.
Set<StepExecution>	StepExecutionSplitter.split(StepExecution stepExecution, int gridSize)	Partition the provided StepExecution into a set of parallel executable instances with the same parent JobExecution.

Uses of StepExecution in org.springframework.batch.core.partition.support

Methods in org.springframework.batch.core.partition.support that return types with arguments of type StepExecution

Modifier and Type	Method	Description
protected FutureTask<StepExecution>	TaskExecutorPartitionHandler.createTask(Step step, StepExecution stepExecution)	Creates the task executing the given step in the context of the given execution.
protected abstract Set<StepExecution>	AbstractPartitionHandler.doHandle(StepExecution managerStepExecution, Set<StepExecution> partitionStepExecutions)	Executes the specified StepExecution instances and returns an updated view of them.
protected Set<StepExecution>	TaskExecutorPartitionHandler.doHandle(StepExecution managerStepExecution, Set<StepExecution> partitionStepExecutions)
Collection<StepExecution>	AbstractPartitionHandler.handle(StepExecutionSplitter stepSplitter, StepExecution managerStepExecution)
Set<StepExecution>	SimpleStepExecutionSplitter.split(StepExecution stepExecution, int gridSize)

Methods in org.springframework.batch.core.partition.support with parameters of type StepExecution

Modifier and Type	Method	Description
void	DefaultStepExecutionAggregator.aggregate(StepExecution result, Collection<StepExecution> executions)	Aggregates the input executions into the result StepExecution.
void	RemoteStepExecutionAggregator.aggregate(StepExecution result, Collection<StepExecution> executions)	Aggregates the input executions into the result StepExecution delegating to the delegate aggregator once the input has been refreshed from the JobExplorer.
void	StepExecutionAggregator.aggregate(StepExecution result, Collection<StepExecution> executions)	Take the inputs and aggregate, putting the aggregates into the result.
protected FutureTask<StepExecution>	TaskExecutorPartitionHandler.createTask(Step step, StepExecution stepExecution)	Creates the task executing the given step in the context of the given execution.
protected void	PartitionStep.doExecute(StepExecution stepExecution)	Delegate execution to the PartitionHandler provided.
protected abstract Set<StepExecution>	AbstractPartitionHandler.doHandle(StepExecution managerStepExecution, Set<StepExecution> partitionStepExecutions)	Executes the specified StepExecution instances and returns an updated view of them.
protected Set<StepExecution>	TaskExecutorPartitionHandler.doHandle(StepExecution managerStepExecution, Set<StepExecution> partitionStepExecutions)
Collection<StepExecution>	AbstractPartitionHandler.handle(StepExecutionSplitter stepSplitter, StepExecution managerStepExecution)
protected boolean	SimpleStepExecutionSplitter.isStartable(StepExecution stepExecution, ExecutionContext context)	Check if a step execution is startable.
Set<StepExecution>	SimpleStepExecutionSplitter.split(StepExecution stepExecution, int gridSize)

Method parameters in org.springframework.batch.core.partition.support with type arguments of type StepExecution

Modifier and Type	Method	Description
void	DefaultStepExecutionAggregator.aggregate(StepExecution result, Collection<StepExecution> executions)	Aggregates the input executions into the result StepExecution.
void	RemoteStepExecutionAggregator.aggregate(StepExecution result, Collection<StepExecution> executions)	Aggregates the input executions into the result StepExecution delegating to the delegate aggregator once the input has been refreshed from the JobExplorer.
void	StepExecutionAggregator.aggregate(StepExecution result, Collection<StepExecution> executions)	Take the inputs and aggregate, putting the aggregates into the result.
protected abstract Set<StepExecution>	AbstractPartitionHandler.doHandle(StepExecution managerStepExecution, Set<StepExecution> partitionStepExecutions)	Executes the specified StepExecution instances and returns an updated view of them.
protected Set<StepExecution>	TaskExecutorPartitionHandler.doHandle(StepExecution managerStepExecution, Set<StepExecution> partitionStepExecutions)

Uses of StepExecution in org.springframework.batch.core.repository

Methods in org.springframework.batch.core.repository that return StepExecution

Modifier and Type	Method	Description
StepExecution	JobRepository.getLastStepExecution(JobInstance jobInstance, String stepName)

Methods in org.springframework.batch.core.repository with parameters of type StepExecution

Modifier and Type	Method	Description
void	JobRepository.add(StepExecution stepExecution)	Save the StepExecution and its ExecutionContext.
default void	JobRepository.deleteStepExecution(StepExecution stepExecution)	Delete the step execution along with its execution context.
void	JobRepository.update(StepExecution stepExecution)	Update the StepExecution (but not its ExecutionContext).
void	JobRepository.updateExecutionContext(StepExecution stepExecution)	Persist the updated ExecutionContexts of the given StepExecution.

Method parameters in org.springframework.batch.core.repository with type arguments of type StepExecution

Modifier and Type	Method	Description
void	JobRepository.addAll(Collection<StepExecution> stepExecutions)	Save a collection of StepExecutions and each ExecutionContext.

Uses of StepExecution in org.springframework.batch.core.repository.dao

Methods in org.springframework.batch.core.repository.dao that return StepExecution

Modifier and Type	Method	Description
StepExecution	JdbcStepExecutionDao.getLastStepExecution(JobInstance jobInstance, String stepName)
default StepExecution	StepExecutionDao.getLastStepExecution(JobInstance jobInstance, String stepName)	Retrieve the last StepExecution for a given JobInstance ordered by creation time and then id.
StepExecution	JdbcStepExecutionDao.getStepExecution(JobExecution jobExecution, Long stepExecutionId)
StepExecution	StepExecutionDao.getStepExecution(JobExecution jobExecution, Long stepExecutionId)	Retrieve a StepExecution from its id.

Methods in org.springframework.batch.core.repository.dao with parameters of type StepExecution

Modifier and Type	Method	Description
default void	ExecutionContextDao.deleteExecutionContext(StepExecution stepExecution)	Delete the execution context of the given StepExecution.
void	JdbcExecutionContextDao.deleteExecutionContext(StepExecution stepExecution)	Delete the execution context of the given StepExecution.
void	JdbcStepExecutionDao.deleteStepExecution(StepExecution stepExecution)	Delete the given step execution.
default void	StepExecutionDao.deleteStepExecution(StepExecution stepExecution)	Delete the given step execution.
ExecutionContext	ExecutionContextDao.getExecutionContext(StepExecution stepExecution)
ExecutionContext	JdbcExecutionContextDao.getExecutionContext(StepExecution stepExecution)
void	ExecutionContextDao.saveExecutionContext(StepExecution stepExecution)	Persist the execution context associated with the given stepExecution, persistent entry for the context should not exist yet.
void	JdbcExecutionContextDao.saveExecutionContext(StepExecution stepExecution)
void	JdbcStepExecutionDao.saveStepExecution(StepExecution stepExecution)	Save a StepExecution.
void	StepExecutionDao.saveStepExecution(StepExecution stepExecution)	Save the given StepExecution.
void	ExecutionContextDao.updateExecutionContext(StepExecution stepExecution)	Persist the updates of execution context associated with the given stepExecution.
void	JdbcExecutionContextDao.updateExecutionContext(StepExecution stepExecution)
void	JdbcStepExecutionDao.updateStepExecution(StepExecution stepExecution)
void	StepExecutionDao.updateStepExecution(StepExecution stepExecution)	Update the given StepExecution

Method parameters in org.springframework.batch.core.repository.dao with type arguments of type StepExecution

Modifier and Type	Method	Description
void	ExecutionContextDao.saveExecutionContexts(Collection<StepExecution> stepExecutions)	Persist the execution context associated with each stepExecution in a given collection, persistent entry for the context should not exist yet.
void	JdbcExecutionContextDao.saveExecutionContexts(Collection<StepExecution> stepExecutions)
void	JdbcStepExecutionDao.saveStepExecutions(Collection<StepExecution> stepExecutions)	Batch insert StepExecutions
void	StepExecutionDao.saveStepExecutions(Collection<StepExecution> stepExecutions)	Save the given collection of StepExecution as a batch.

Uses of StepExecution in org.springframework.batch.core.repository.support

Methods in org.springframework.batch.core.repository.support that return StepExecution

Modifier and Type	Method	Description
StepExecution	SimpleJobRepository.getLastStepExecution(JobInstance jobInstance, String stepName)

Methods in org.springframework.batch.core.repository.support with parameters of type StepExecution

Modifier and Type	Method	Description
void	SimpleJobRepository.add(StepExecution stepExecution)
void	SimpleJobRepository.deleteStepExecution(StepExecution stepExecution)
void	SimpleJobRepository.update(StepExecution stepExecution)
void	SimpleJobRepository.updateExecutionContext(StepExecution stepExecution)

Method parameters in org.springframework.batch.core.repository.support with type arguments of type StepExecution

Modifier and Type	Method	Description
void	SimpleJobRepository.addAll(Collection<StepExecution> stepExecutions)

Uses of StepExecution in org.springframework.batch.core.resource

Methods in org.springframework.batch.core.resource with parameters of type StepExecution

Modifier and Type	Method	Description
void	StepExecutionSimpleCompletionPolicy.beforeStep(StepExecution stepExecution)	Set up a SimpleCompletionPolicy with a commit interval taken from the JobParameters.

Uses of StepExecution in org.springframework.batch.core.scope.context

Methods in org.springframework.batch.core.scope.context that return StepExecution

Modifier and Type	Method	Description
StepExecution	StepContext.getStepExecution()	The current StepExecution that is active in this context.

Methods in org.springframework.batch.core.scope.context with parameters of type StepExecution

Modifier and Type	Method	Description
void	StepScopeManager.execute(Step step, StepExecution stepExecution)
static StepContext	StepSynchronizationManager.register(StepExecution stepExecution)	Register a context with the current thread - always put a matching StepSynchronizationManager.close() call in a finally block to ensure that the correct context is available in the enclosing block.

Constructors in org.springframework.batch.core.scope.context with parameters of type StepExecution

Modifier	Constructor	Description
	StepContext(StepExecution stepExecution)	Create a new instance of StepContext for this StepExecution.
	StepContextRepeatCallback(StepExecution stepExecution)

Uses of StepExecution in org.springframework.batch.core.step

Methods in org.springframework.batch.core.step with parameters of type StepExecution

Modifier and Type	Method	Description
ExitStatus	NoWorkFoundStepExecutionListener.afterStep(StepExecution stepExecution)
void	StepInterruptionPolicy.checkInterrupted(StepExecution stepExecution)	Has the job been interrupted? If so then throw a JobInterruptedException.
void	ThreadStepInterruptionPolicy.checkInterrupted(StepExecution stepExecution)	Returns if the current job lifecycle has been interrupted by checking if the current thread is interrupted.
protected abstract void	AbstractStep.doExecute(StepExecution stepExecution)	Extension point for subclasses to execute business logic.
protected void	AbstractStep.doExecutionRegistration(StepExecution stepExecution)	Registers the StepExecution for property resolution via StepScope
final void	AbstractStep.execute(StepExecution stepExecution)	Template method for step execution logic - calls abstract methods for resource initialization ( AbstractStep.open(ExecutionContext)), execution logic (AbstractStep.doExecute(StepExecution)) and resource closing ( AbstractStep.close(ExecutionContext)).

Uses of StepExecution in org.springframework.batch.core.step.item

Methods in org.springframework.batch.core.step.item with parameters of type StepExecution

Modifier and Type	Method	Description
protected void	SimpleChunkProcessor.stopTimer(io.micrometer.core.instrument.Timer.Sample sample, StepExecution stepExecution, String metricName, String status, String description)

Uses of StepExecution in org.springframework.batch.core.step.job

Methods in org.springframework.batch.core.step.job with parameters of type StepExecution

Modifier and Type	Method	Description
protected void	JobStep.doExecute(StepExecution stepExecution)	Execute the job provided by delegating to the JobLauncher to prevent duplicate executions.
JobParameters	DefaultJobParametersExtractor.getJobParameters(Job job, StepExecution stepExecution)
JobParameters	JobParametersExtractor.getJobParameters(Job job, StepExecution stepExecution)	Extract job parameters from the step execution, for example from the execution context or other properties.

Uses of StepExecution in org.springframework.batch.core.step.tasklet

Methods in org.springframework.batch.core.step.tasklet with parameters of type StepExecution

Modifier and Type	Method	Description
void	SystemCommandTasklet.beforeStep(StepExecution stepExecution)	Get a reference to StepExecution for interrupt checks during system command execution.
protected void	TaskletStep.doExecute(StepExecution stepExecution)	Process the step and update its context so that progress can be monitored by the caller.

Uses of StepExecution in org.springframework.batch.integration.chunk

Methods in org.springframework.batch.integration.chunk with parameters of type StepExecution

Modifier and Type	Method	Description
ExitStatus	ChunkMessageChannelItemWriter.afterStep(StepExecution stepExecution)
void	ChunkMessageChannelItemWriter.beforeStep(StepExecution stepExecution)
void	ChunkMessageChannelItemWriter.LocalState.setStepExecution(StepExecution stepExecution)

Uses of StepExecution in org.springframework.batch.integration.partition

Methods in org.springframework.batch.integration.partition that return StepExecution

Modifier and Type	Method	Description
StepExecution	StepExecutionRequestHandler.handle(StepExecutionRequest request)

Methods in org.springframework.batch.integration.partition that return types with arguments of type StepExecution

Modifier and Type	Method	Description
protected Set<StepExecution>	MessageChannelPartitionHandler.doHandle(StepExecution managerStepExecution, Set<StepExecution> partitionStepExecutions)	Sends StepExecutionRequest objects to the request channel of the MessagingTemplate, and then receives the result back as a list of StepExecution on a reply channel.

Methods in org.springframework.batch.integration.partition with parameters of type StepExecution

Modifier and Type	Method	Description
protected Set<StepExecution>	MessageChannelPartitionHandler.doHandle(StepExecution managerStepExecution, Set<StepExecution> partitionStepExecutions)	Sends StepExecutionRequest objects to the request channel of the MessagingTemplate, and then receives the result back as a list of StepExecution on a reply channel.

Method parameters in org.springframework.batch.integration.partition with type arguments of type StepExecution

Modifier and Type	Method	Description
protected Set<StepExecution>	MessageChannelPartitionHandler.doHandle(StepExecution managerStepExecution, Set<StepExecution> partitionStepExecutions)	Sends StepExecutionRequest objects to the request channel of the MessagingTemplate, and then receives the result back as a list of StepExecution on a reply channel.

Uses of StepExecution in org.springframework.batch.integration.step

Methods in org.springframework.batch.integration.step with parameters of type StepExecution

Modifier and Type	Method	Description
protected void	DelegateStep.doExecute(StepExecution stepExecution)	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of StepExecution in org.springframework.batch.test

Methods in org.springframework.batch.test that return StepExecution

Modifier and Type	Method	Description
static StepExecution	MetaDataInstanceFactory.createStepExecution()	Create a StepExecution with default parameters.
static StepExecution	MetaDataInstanceFactory.createStepExecution(String stepName, Long executionId)	Create a StepExecution with the parameters provided.
static StepExecution	MetaDataInstanceFactory.createStepExecution(JobExecution jobExecution, String stepName, Long executionId)	Create a StepExecution with the parameters provided.
static StepExecution	MetaDataInstanceFactory.createStepExecution(JobParameters jobParameters)	Create a StepExecution and all its parent entities with default values, but using the JobParameters provided.
static StepExecution	MetaDataInstanceFactory.createStepExecution(JobParameters jobParameters, ExecutionContext executionContext)	Create a StepExecution and all its parent entities with default values, but using the ExecutionContext and JobParameters provided.
static StepExecution	MetaDataInstanceFactory.createStepExecution(ExecutionContext executionContext)	Create a StepExecution and all its parent entities with default values, but using the ExecutionContext provided.
protected StepExecution	StepScopeTestExecutionListener.getStepExecution(org.springframework.test.context.TestContext testContext)	Discover a StepExecution as a field in the test case or create one if none is available.

Methods in org.springframework.batch.test with parameters of type StepExecution

Modifier and Type	Method	Description
static <T> T	StepScopeTestUtils.doInStepScope(StepExecution stepExecution, Callable<T> callable)
static <T> T	ExecutionContextTestUtils.getValueFromStep(StepExecution stepExecution, String key)