Package | Description |
---|---|
org.springframework.batch.core |
Core domain context for Spring Batch covering jobs, steps,
configuration and execution abstractions.
|
org.springframework.batch.core.configuration.support |
Specific implementations of configuration concerns.
|
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 | |
org.springframework.batch.core.launch |
Interfaces and simple implementations of launch concerns.
|
org.springframework.batch.core.launch.support |
Support classes for use in bootstrap and launch implementations or configurations.
|
org.springframework.batch.core.listener |
Generic implementations of core batch listener interfaces.
|
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.sample.loop | |
org.springframework.batch.test |
Modifier and Type | Method and Description |
---|---|
JobExecution |
StepExecution.getJobExecution()
Accessor for the execution context information of the enclosing job.
|
Modifier and Type | Method and Description |
---|---|
void |
JobExecutionListener.afterJob(JobExecution jobExecution)
Callback after completion of a job.
|
void |
JobExecutionListener.beforeJob(JobExecution jobExecution)
Callback before a job executes.
|
void |
Job.execute(JobExecution execution)
Run the
JobExecution and update the meta information like status
and statistics as necessary. |
Constructor and Description |
---|
StepExecution(String stepName,
JobExecution jobExecution)
Constructor that substitutes in null for the execution id
|
StepExecution(String stepName,
JobExecution jobExecution,
Long id)
Constructor with mandatory properties.
|
Modifier and Type | Method and Description |
---|---|
void |
GroupAwareJob.execute(JobExecution execution) |
Modifier and Type | Method and Description |
---|---|
JobExecution |
JobExplorer.getJobExecution(Long executionId)
Retrieve a
JobExecution by its id. |
Modifier and Type | Method and Description |
---|---|
Set<JobExecution> |
JobExplorer.findRunningJobExecutions(String jobName)
Retrieve running job executions.
|
List<JobExecution> |
JobExplorer.getJobExecutions(JobInstance jobInstance)
Retrieve job executions by their job instance.
|
Modifier and Type | Method and Description |
---|---|
JobExecution |
SimpleJobExplorer.getJobExecution(Long executionId) |
Modifier and Type | Method and Description |
---|---|
Set<JobExecution> |
SimpleJobExplorer.findRunningJobExecutions(String jobName) |
List<JobExecution> |
SimpleJobExplorer.getJobExecutions(JobInstance jobInstance) |
Modifier and Type | Method and Description |
---|---|
protected void |
SimpleJob.doExecute(JobExecution execution)
Handler of steps sequentially as provided, checking each one for success
before moving to the next.
|
protected abstract void |
AbstractJob.doExecute(JobExecution execution)
Extension point for subclasses allowing them to concentrate on processing
logic and ignore listeners and repository calls.
|
void |
AbstractJob.execute(JobExecution execution)
Run the specified job, handling all listener and repository calls, and
delegating the actual processing to
AbstractJob.doExecute(JobExecution) . |
StepExecution |
StepHandler.handleStep(Step step,
JobExecution jobExecution)
Handle a step and return the execution for it.
|
StepExecution |
SimpleStepHandler.handleStep(Step step,
JobExecution execution) |
protected 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 . |
Modifier and Type | Method and Description |
---|---|
JobExecution |
JobFlowExecutor.getJobExecution() |
JobExecution |
FlowExecutor.getJobExecution() |
Modifier and Type | Method and Description |
---|---|
FlowExecutionStatus |
JobExecutionDecider.decide(JobExecution jobExecution,
StepExecution stepExecution)
Strategy for branching an execution based on the state of an ongoing
JobExecution . |
protected void |
FlowJob.doExecute(JobExecution execution) |
Constructor and Description |
---|
JobFlowExecutor(JobRepository jobRepository,
StepHandler stepHandler,
JobExecution execution) |
Modifier and Type | Method and Description |
---|---|
JobExecution |
JobOperator.abandon(long jobExecutionId)
Mark the
JobExecution as ABANDONED. |
JobExecution |
JobLauncher.run(Job job,
JobParameters jobParameters)
Start a job execution for the given
Job and JobParameters
. |
Modifier and Type | Method and Description |
---|---|
JobExecution |
SimpleJobOperator.abandon(long jobExecutionId) |
JobExecution |
SimpleJobLauncher.run(Job job,
JobParameters jobParameters)
Run the provided job with the given
JobParameters . |
Modifier and Type | Method and Description |
---|---|
void |
JobExecutionListenerSupport.afterJob(JobExecution jobExecution) |
void |
CompositeJobExecutionListener.afterJob(JobExecution jobExecution)
Call the registered listeners in reverse order, respecting and
prioritising those that implement
Ordered . |
void |
JobExecutionListenerSupport.beforeJob(JobExecution jobExecution) |
void |
CompositeJobExecutionListener.beforeJob(JobExecution jobExecution)
Call the registered listeners in order, respecting and prioritising those
that implement
Ordered . |
Modifier and Type | Method and Description |
---|---|
JobExecution |
JobRepository.createJobExecution(String jobName,
JobParameters jobParameters)
|
JobExecution |
JobRepository.getLastJobExecution(String jobName,
JobParameters jobParameters) |
Modifier and Type | Method and Description |
---|---|
void |
JobRepository.update(JobExecution jobExecution)
Update the
JobExecution (but not its ExecutionContext ). |
void |
JobRepository.updateExecutionContext(JobExecution jobExecution)
Persist the updated
ExecutionContext of the given
JobExecution . |
Modifier and Type | Method and Description |
---|---|
JobExecution |
MapJobExecutionDao.getJobExecution(Long executionId) |
JobExecution |
JobExecutionDao.getJobExecution(Long executionId) |
JobExecution |
JdbcJobExecutionDao.getJobExecution(Long executionId) |
JobExecution |
MapJobExecutionDao.getLastJobExecution(JobInstance jobInstance) |
JobExecution |
JobExecutionDao.getLastJobExecution(JobInstance jobInstance)
Find the last
JobExecution to have been created for a given
JobInstance . |
JobExecution |
JdbcJobExecutionDao.getLastJobExecution(JobInstance jobInstance) |
Modifier and Type | Method and Description |
---|---|
List<JobExecution> |
MapJobExecutionDao.findJobExecutions(JobInstance jobInstance) |
List<JobExecution> |
JobExecutionDao.findJobExecutions(JobInstance jobInstance)
Return all
JobExecution for given JobInstance , sorted
backwards by creation order (so the first element is the most recent). |
List<JobExecution> |
JdbcJobExecutionDao.findJobExecutions(JobInstance job) |
Set<JobExecution> |
MapJobExecutionDao.findRunningJobExecutions(String jobName) |
Set<JobExecution> |
JobExecutionDao.findRunningJobExecutions(String jobName) |
Set<JobExecution> |
JdbcJobExecutionDao.findRunningJobExecutions(String jobName) |
Modifier and Type | Method and Description |
---|---|
void |
StepExecutionDao.addStepExecutions(JobExecution jobExecution)
Retrieve all the
StepExecution for the parent JobExecution . |
void |
MapStepExecutionDao.addStepExecutions(JobExecution jobExecution) |
void |
JdbcStepExecutionDao.addStepExecutions(JobExecution jobExecution) |
ExecutionContext |
MapExecutionContextDao.getExecutionContext(JobExecution jobExecution) |
ExecutionContext |
JdbcExecutionContextDao.getExecutionContext(JobExecution jobExecution) |
ExecutionContext |
ExecutionContextDao.getExecutionContext(JobExecution jobExecution) |
JobInstance |
MapJobInstanceDao.getJobInstance(JobExecution jobExecution) |
JobInstance |
JobInstanceDao.getJobInstance(JobExecution jobExecution)
Fetch the JobInstance for the provided JobExecution.
|
JobInstance |
JdbcJobInstanceDao.getJobInstance(JobExecution jobExecution) |
StepExecution |
StepExecutionDao.getStepExecution(JobExecution jobExecution,
Long stepExecutionId)
Retrieve a
StepExecution from its id. |
StepExecution |
MapStepExecutionDao.getStepExecution(JobExecution jobExecution,
Long stepExecutionId) |
StepExecution |
JdbcStepExecutionDao.getStepExecution(JobExecution jobExecution,
Long stepExecutionId) |
void |
MapExecutionContextDao.saveExecutionContext(JobExecution jobExecution) |
void |
JdbcExecutionContextDao.saveExecutionContext(JobExecution jobExecution) |
void |
ExecutionContextDao.saveExecutionContext(JobExecution jobExecution)
Persist the execution context associated with the given jobExecution,
persistent entry for the context should not exist yet.
|
void |
MapJobExecutionDao.saveJobExecution(JobExecution jobExecution) |
void |
JobExecutionDao.saveJobExecution(JobExecution jobExecution)
Save a new JobExecution.
|
void |
JdbcJobExecutionDao.saveJobExecution(JobExecution jobExecution)
SQL implementation using Sequences via the Spring incrementer
abstraction.
|
void |
MapJobExecutionDao.synchronizeStatus(JobExecution jobExecution) |
void |
JobExecutionDao.synchronizeStatus(JobExecution jobExecution)
Because it may be possible that the status of a JobExecution is updated
while running, the following method will synchronize only the status and
version fields.
|
void |
JdbcJobExecutionDao.synchronizeStatus(JobExecution jobExecution) |
void |
MapExecutionContextDao.updateExecutionContext(JobExecution jobExecution) |
void |
JdbcExecutionContextDao.updateExecutionContext(JobExecution jobExecution) |
void |
ExecutionContextDao.updateExecutionContext(JobExecution jobExecution)
Persist the updates of execution context associated with the given
jobExecution.
|
void |
MapJobExecutionDao.updateJobExecution(JobExecution jobExecution) |
void |
JobExecutionDao.updateJobExecution(JobExecution jobExecution)
Update and existing JobExecution.
|
void |
JdbcJobExecutionDao.updateJobExecution(JobExecution jobExecution)
Update given JobExecution using a SQL UPDATE statement.
|
Modifier and Type | Method and Description |
---|---|
JobExecution |
SimpleJobRepository.createJobExecution(String jobName,
JobParameters jobParameters) |
JobExecution |
SimpleJobRepository.getLastJobExecution(String jobName,
JobParameters jobParameters) |
Modifier and Type | Method and Description |
---|---|
void |
SimpleJobRepository.update(JobExecution jobExecution) |
void |
SimpleJobRepository.updateExecutionContext(JobExecution jobExecution) |
Modifier and Type | Method and Description |
---|---|
FlowExecutionStatus |
LimitDecider.decide(JobExecution jobExecution,
StepExecution stepExecution) |
Modifier and Type | Method and Description |
---|---|
static JobExecution |
MetaDataInstanceFactory.createJobExecution()
Create a
JobExecution with default parameters. |
static JobExecution |
MetaDataInstanceFactory.createJobExecution(Long executionId)
Create a
JobExecution with the parameters provided. |
static JobExecution |
MetaDataInstanceFactory.createJobExecution(String jobName,
Long instanceId,
Long executionId)
Create a
JobExecution with the parameters provided. |
static JobExecution |
MetaDataInstanceFactory.createJobExecution(String jobName,
Long instanceId,
Long executionId,
JobParameters jobParameters)
Create a
JobExecution with the parameters provided. |
static JobExecution |
MetaDataInstanceFactory.createJobExecution(String jobName,
Long instanceId,
Long executionId,
String jobParameters)
Create a
JobExecution with the parameters provided. |
static JobExecution |
MetaDataInstanceFactory.createJobExecutionWithStepExecutions(Long executionId,
Collection<String> stepNames)
Create a
JobExecution with the parameters provided with attached
step executions. |
JobExecution |
JobLauncherTestUtils.launchJob()
Launch the entire job, including all steps.
|
protected JobExecution |
AbstractJobTests.launchJob()
Deprecated.
Launch the entire job, including all steps.
|
JobExecution |
JobLauncherTestUtils.launchJob(JobParameters jobParameters)
Launch the entire job, including all steps
|
protected JobExecution |
AbstractJobTests.launchJob(JobParameters jobParameters)
Deprecated.
Launch the entire job, including all steps
|
JobExecution |
StepRunner.launchStep(Step step)
Launch just the specified step as its own job.
|
JobExecution |
StepRunner.launchStep(Step step,
ExecutionContext jobExecutionContext)
Launch just the specified step as its own job.
|
JobExecution |
StepRunner.launchStep(Step step,
JobParameters jobParameters)
Launch just the specified step as its own job.
|
JobExecution |
StepRunner.launchStep(Step step,
JobParameters jobParameters,
ExecutionContext jobExecutionContext)
Launch just the specified step as its own job.
|
JobExecution |
JobLauncherTestUtils.launchStep(String stepName)
Launch just the specified step in the job.
|
JobExecution |
AbstractJobTests.launchStep(String stepName)
Deprecated.
Launch just the specified step in the job.
|
JobExecution |
JobLauncherTestUtils.launchStep(String stepName,
ExecutionContext jobExecutionContext)
Launch just the specified step in the job.
|
JobExecution |
AbstractJobTests.launchStep(String stepName,
ExecutionContext jobExecutionContext)
Deprecated.
Launch just the specified step in the job.
|
JobExecution |
JobLauncherTestUtils.launchStep(String stepName,
JobParameters jobParameters)
Launch just the specified step in the job.
|
JobExecution |
AbstractJobTests.launchStep(String stepName,
JobParameters jobParameters)
Deprecated.
Launch just the specified step in the job.
|
JobExecution |
JobLauncherTestUtils.launchStep(String stepName,
JobParameters jobParameters,
ExecutionContext jobExecutionContext)
Launch just the specified step in the job.
|
JobExecution |
AbstractJobTests.launchStep(String stepName,
JobParameters jobParameters,
ExecutionContext jobExecutionContext)
Deprecated.
Launch just the specified step in the job.
|
Modifier and Type | Method and Description |
---|---|
List<JobExecution> |
JobRepositoryTestUtils.createJobExecutions(int count)
Use the
JobRepository to create some JobExecution
instances each with a single step execution. |
List<JobExecution> |
JobRepositoryTestUtils.createJobExecutions(String jobName,
String[] stepNames,
int count)
Use the
JobRepository to create some JobExecution
instances each with the given job name and each having step executions
with the given step names. |
Modifier and Type | Method and Description |
---|---|
static StepExecution |
MetaDataInstanceFactory.createStepExecution(JobExecution jobExecution,
String stepName,
Long executionId)
Create a
StepExecution with the parameters provided. |
static <T> T |
ExecutionContextTestUtils.getValueFromJob(JobExecution jobExecution,
String key) |
static <T> T |
ExecutionContextTestUtils.getValueFromStepInJob(JobExecution jobExecution,
String stepName,
String key) |
Modifier and Type | Method and Description |
---|---|
void |
JobRepositoryTestUtils.removeJobExecutions(Collection<JobExecution> list)
Remove the
JobExecution instances, and all associated
JobInstance and StepExecution instances from the standard
RDBMS locations used by Spring Batch. |
Copyright © 2014 Pivotal. All rights reserved.