org.springframework.batch.admin.service

Class SimpleJobService

java.lang.Object

org.springframework.batch.admin.service.SimpleJobService

All Implemented Interfaces:

JobService, org.springframework.beans.factory.DisposableBean

public class SimpleJobService
extends java.lang.Object
implements JobService, org.springframework.beans.factory.DisposableBean

Implementation of JobService that delegates most of its work to other off-the-shelf components.

Author:

Dave Syer, Michael Minella

Constructor Summary

Constructors

Constructor and Description

SimpleJobService(SearchableJobInstanceDao jobInstanceDao, SearchableJobExecutionDao jobExecutionDao, SearchableStepExecutionDao stepExecutionDao, org.springframework.batch.core.repository.JobRepository jobRepository, org.springframework.batch.core.launch.JobLauncher jobLauncher, org.springframework.batch.core.configuration.ListableJobLocator jobLocator, org.springframework.batch.core.repository.dao.ExecutionContextDao executionContextDao)

Method Summary

Modifier and Type	Method and Description
org.springframework.batch.core.JobExecution	abandon(java.lang.Long jobExecutionId) Mark the JobExecution as ABANDONED.
int	countJobExecutions() Count the maximum number of executions that could be returned by JobService.listJobExecutions(int, int).
int	countJobExecutionsForJob(java.lang.String name) Count the job executions in the repository for a job.
int	countJobInstances(java.lang.String name) Count the number of job instances in the repository for a given job name.
int	countJobs() Count the total number of jobs that can be returned by JobService.listJobs(int, int).
int	countStepExecutionsForStep(java.lang.String jobName, java.lang.String stepName) Count the step executions in the repository for a given step name (or pattern).
void	destroy() Stop all the active jobs and wait for them (up to a time out) to finish processing.
org.springframework.batch.core.JobExecution	getJobExecution(java.lang.Long jobExecutionId) Get a JobExecution by id.
java.util.Collection<org.springframework.batch.core.JobExecution>	getJobExecutionsForJobInstance(java.lang.String name, java.lang.Long jobInstanceId) Get all the job executions for a given job instance.
org.springframework.batch.core.JobInstance	getJobInstance(long jobInstanceId) Get a job instance by id.
org.springframework.batch.core.JobParameters	getLastJobParameters(java.lang.String jobName) Get the last JobParameters used to execute a job successfully.
org.springframework.batch.core.StepExecution	getStepExecution(java.lang.Long jobExecutionId, java.lang.Long stepExecutionId) Locate a StepExecution from its id and that of its parent JobExecution.
java.util.Collection<org.springframework.batch.core.StepExecution>	getStepExecutions(java.lang.Long jobExecutionId) Get the step executions for a given job execution (by id).
java.util.Collection<java.lang.String>	getStepNamesForJob(java.lang.String jobName) Get the names of the steps in a job (or a historical list of recent execution names if the Job is not launchable).
boolean	isIncrementable(java.lang.String jobName) Check if a job has a JobParametersIncrementer.
boolean	isLaunchable(java.lang.String jobName) Convenience method to determine if a job is available for launching.
org.springframework.batch.core.JobExecution	launch(java.lang.String jobName, org.springframework.batch.core.JobParameters jobParameters) Launch a job with the parameters provided.
java.util.Collection<org.springframework.batch.core.JobExecution>	listJobExecutions(int start, int count) List the job executions in descending order of creation (usually close to execution order).
java.util.Collection<org.springframework.batch.core.JobExecution>	listJobExecutionsForJob(java.lang.String jobName, int start, int count) List the job executions for a job in descending order of creation (usually close to execution order).
java.util.Collection<org.springframework.batch.core.JobInstance>	listJobInstances(java.lang.String jobName, int start, int count) List the job instances in descending order of creation (usually close to order of execution).
java.util.Collection<java.lang.String>	listJobs(int start, int count) Query the job names in the system, either launchable or not.
java.util.Collection<org.springframework.batch.core.StepExecution>	listStepExecutionsForStep(java.lang.String jobName, java.lang.String stepName, int start, int count) List the step executions for a step in descending order of creation (usually close to execution order).
void	removeInactiveExecutions() Check all the active executions and see if they are still actually running.
org.springframework.batch.core.JobExecution	restart(java.lang.Long jobExecutionId) Launch a job with the parameters provided.
void	setShutdownTimeout(int shutdownTimeout) Timeout for shutdown waiting for jobs to finish processing.
org.springframework.batch.core.JobExecution	stop(java.lang.Long jobExecutionId) Send a signal to a job execution to stop processing.
int	stopAll() Send a stop signal to all running job executions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleJobService

public SimpleJobService(SearchableJobInstanceDao jobInstanceDao,
                        SearchableJobExecutionDao jobExecutionDao,
                        SearchableStepExecutionDao stepExecutionDao,
                        org.springframework.batch.core.repository.JobRepository jobRepository,
                        org.springframework.batch.core.launch.JobLauncher jobLauncher,
                        org.springframework.batch.core.configuration.ListableJobLocator jobLocator,
                        org.springframework.batch.core.repository.dao.ExecutionContextDao executionContextDao)

Method Detail

setShutdownTimeout

public void setShutdownTimeout(int shutdownTimeout)

Timeout for shutdown waiting for jobs to finish processing.

Parameters:

shutdownTimeout - in milliseconds (default 60 secs)

getStepExecutions

public java.util.Collection<org.springframework.batch.core.StepExecution> getStepExecutions(java.lang.Long jobExecutionId)
                                                                                     throws org.springframework.batch.core.launch.NoSuchJobExecutionException

Description copied from interface: JobService

Get the step executions for a given job execution (by id).

Specified by:

getStepExecutions in interface JobService

Parameters:

jobExecutionId - the parent job execution id

Returns:

the step executions for the job execution

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException

isLaunchable

public boolean isLaunchable(java.lang.String jobName)

Description copied from interface: JobService

Convenience method to determine if a job is available for launching. Job names returned from JobService.listJobs(int, int) might be in the repository, but not be launchable if the host application has no configuration for them.

Specified by:

isLaunchable in interface JobService

Parameters:

jobName - the name of the job

Returns:

true if the job is available for launching

isIncrementable

public boolean isIncrementable(java.lang.String jobName)

Description copied from interface: JobService

Check if a job has a JobParametersIncrementer.

Specified by:

isIncrementable in interface JobService

Parameters:

jobName - the job name

Returns:

true if the job exists and has an incrementer

restart

public org.springframework.batch.core.JobExecution restart(java.lang.Long jobExecutionId)
                                                    throws org.springframework.batch.core.launch.NoSuchJobExecutionException,
                                                           org.springframework.batch.core.repository.JobExecutionAlreadyRunningException,
                                                           org.springframework.batch.core.repository.JobRestartException,
                                                           org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException,
                                                           org.springframework.batch.core.launch.NoSuchJobException,
                                                           org.springframework.batch.core.JobParametersInvalidException

Description copied from interface: JobService

Launch a job with the parameters provided.

Specified by:

restart in interface JobService

Parameters:

jobExecutionId - the job execution to restart

Returns:

the resulting JobExecution if successful

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException

org.springframework.batch.core.repository.JobExecutionAlreadyRunningException

org.springframework.batch.core.repository.JobRestartException

org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException

org.springframework.batch.core.launch.NoSuchJobException

org.springframework.batch.core.JobParametersInvalidException

launch

public org.springframework.batch.core.JobExecution launch(java.lang.String jobName,
                                                          org.springframework.batch.core.JobParameters jobParameters)
                                                   throws org.springframework.batch.core.launch.NoSuchJobException,
                                                          org.springframework.batch.core.repository.JobExecutionAlreadyRunningException,
                                                          org.springframework.batch.core.repository.JobRestartException,
                                                          org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException,
                                                          org.springframework.batch.core.JobParametersInvalidException

Description copied from interface: JobService

Launch a job with the parameters provided. If an instance with the parameters provided has already failed (and is not abandoned) it will be restarted.

Specified by:

launch in interface JobService

Parameters:

jobName - the job name

jobParameters - the JobParameters

Returns:

the resulting JobExecution if successful

Throws:

org.springframework.batch.core.launch.NoSuchJobException

org.springframework.batch.core.repository.JobExecutionAlreadyRunningException

org.springframework.batch.core.repository.JobRestartException

org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException

org.springframework.batch.core.JobParametersInvalidException

getLastJobParameters

public org.springframework.batch.core.JobParameters getLastJobParameters(java.lang.String jobName)
                                                                  throws org.springframework.batch.core.launch.NoSuchJobException

Description copied from interface: JobService

Get the last JobParameters used to execute a job successfully.

Specified by:

getLastJobParameters in interface JobService

Parameters:

jobName - the name of the job

Returns:

the last parameters used to execute this job or empty if there are none

Throws:

org.springframework.batch.core.launch.NoSuchJobException

listJobExecutions

public java.util.Collection<org.springframework.batch.core.JobExecution> listJobExecutions(int start,
                                                                                           int count)

Description copied from interface: JobService

List the job executions in descending order of creation (usually close to execution order).

Specified by:

listJobExecutions in interface JobService

Parameters:

start - the index of the first execution to return

count - the maximum number of executions

Returns:

a collection of JobExecution

countJobExecutions

public int countJobExecutions()

Description copied from interface: JobService

Count the maximum number of executions that could be returned by JobService.listJobExecutions(int, int).

Specified by:

countJobExecutions in interface JobService

Returns:

the number of job executions in the job repository

listJobs

public java.util.Collection<java.lang.String> listJobs(int start,
                                                       int count)

Description copied from interface: JobService

Query the job names in the system, either launchable or not. If not launchable, then there must be a history of the job having been launched previously in the JobRepository.

Specified by:

listJobs in interface JobService

Parameters:

start - the start index of the job names to return

count - the maximum number of job names to return

Returns:

a collection of job names

countJobs

public int countJobs()

Description copied from interface: JobService

Count the total number of jobs that can be returned by JobService.listJobs(int, int).

Specified by:

countJobs in interface JobService

Returns:

the total number of jobs

stopAll

public int stopAll()

Description copied from interface: JobService

Send a stop signal to all running job executions.

Specified by:

stopAll in interface JobService

Returns:

the number of executions affected

stop

public org.springframework.batch.core.JobExecution stop(java.lang.Long jobExecutionId)
                                                 throws org.springframework.batch.core.launch.NoSuchJobExecutionException,
                                                        org.springframework.batch.core.launch.JobExecutionNotRunningException

Description copied from interface: JobService

Send a signal to a job execution to stop processing. This method does not guarantee that the processing will stop, only that the signal will be delivered. It is up to the individual Job and Step implementations to ensure that the signal is obeyed. In particular, if users provide a custom Tasklet to a Step it must check the signal in the JobExecution itself.

Specified by:

stop in interface JobService

Parameters:

jobExecutionId - the job execution id to stop

Returns:

the JobExecution that was stopped

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException

org.springframework.batch.core.launch.JobExecutionNotRunningException

abandon

public org.springframework.batch.core.JobExecution abandon(java.lang.Long jobExecutionId)
                                                    throws org.springframework.batch.core.launch.NoSuchJobExecutionException,
                                                           org.springframework.batch.core.repository.JobExecutionAlreadyRunningException

Description copied from interface: JobService

Mark the JobExecution as ABANDONED. If a stop signal is ignored because the process died this is the best way to mark a job as finished with (as opposed to STOPPED). An abandoned job execution can be restarted, but a stopping one cannot.

Specified by:

abandon in interface JobService

Parameters:

jobExecutionId - the job execution id to abort

Returns:

the JobExecution that was aborted

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException

org.springframework.batch.core.repository.JobExecutionAlreadyRunningException - if the job is running (it should be stopped first)

countJobExecutionsForJob

public int countJobExecutionsForJob(java.lang.String name)
                             throws org.springframework.batch.core.launch.NoSuchJobException

Description copied from interface: JobService

Count the job executions in the repository for a job.

Specified by:

countJobExecutionsForJob in interface JobService

Parameters:

name - the job name

Returns:

the number of executions

Throws:

org.springframework.batch.core.launch.NoSuchJobException

countJobInstances

public int countJobInstances(java.lang.String name)
                      throws org.springframework.batch.core.launch.NoSuchJobException

Description copied from interface: JobService

Count the number of job instances in the repository for a given job name.

Specified by:

countJobInstances in interface JobService

Parameters:

name - the name of the job

Returns:

the number of job instances available

Throws:

org.springframework.batch.core.launch.NoSuchJobException

getJobExecution

public org.springframework.batch.core.JobExecution getJobExecution(java.lang.Long jobExecutionId)
                                                            throws org.springframework.batch.core.launch.NoSuchJobExecutionException

Description copied from interface: JobService

Get a JobExecution by id.

Specified by:

getJobExecution in interface JobService

Parameters:

jobExecutionId - the job execution id

Returns:

the JobExecution

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException

getJobExecutionsForJobInstance

public java.util.Collection<org.springframework.batch.core.JobExecution> getJobExecutionsForJobInstance(java.lang.String name,
                                                                                                        java.lang.Long jobInstanceId)
                                                                                                 throws org.springframework.batch.core.launch.NoSuchJobException

Description copied from interface: JobService

Get all the job executions for a given job instance. On a sunny day there would be only one. If there have been failures and restarts there may be many, and they will be listed in reverse order of primary key.

Specified by:

getJobExecutionsForJobInstance in interface JobService

Parameters:

name - the name of the job

jobInstanceId - the id of the job instance

Returns:

all the job executions

Throws:

org.springframework.batch.core.launch.NoSuchJobException

getStepExecution

public org.springframework.batch.core.StepExecution getStepExecution(java.lang.Long jobExecutionId,
                                                                     java.lang.Long stepExecutionId)
                                                              throws org.springframework.batch.core.launch.NoSuchJobExecutionException,
                                                                     NoSuchStepExecutionException

Description copied from interface: JobService

Locate a StepExecution from its id and that of its parent JobExecution.

Specified by:

getStepExecution in interface JobService

Parameters:

jobExecutionId - the job execution id

stepExecutionId - the step execution id

Returns:

the StepExecution

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException

NoSuchStepExecutionException

listJobExecutionsForJob

public java.util.Collection<org.springframework.batch.core.JobExecution> listJobExecutionsForJob(java.lang.String jobName,
                                                                                                 int start,
                                                                                                 int count)
                                                                                          throws org.springframework.batch.core.launch.NoSuchJobException

Description copied from interface: JobService

List the job executions for a job in descending order of creation (usually close to execution order).

Specified by:

listJobExecutionsForJob in interface JobService

Parameters:

jobName - the job name

start - the start index of the first job execution

count - the maximum number of executions to return

Returns:

a collection of JobExecution

Throws:

org.springframework.batch.core.launch.NoSuchJobException

listStepExecutionsForStep

public java.util.Collection<org.springframework.batch.core.StepExecution> listStepExecutionsForStep(java.lang.String jobName,
                                                                                                    java.lang.String stepName,
                                                                                                    int start,
                                                                                                    int count)
                                                                                             throws org.springframework.batch.core.step.NoSuchStepException

Description copied from interface: JobService

List the step executions for a step in descending order of creation (usually close to execution order).

Specified by:

listStepExecutionsForStep in interface JobService

Parameters:

jobName - the name of the job associated with the step (or a pattern with wildcards)

stepName - the step name (or a pattern with wildcards)

start - the start index of the first execution

count - the maximum number of executions to return

Returns:

a collection of StepExecution

Throws:

org.springframework.batch.core.step.NoSuchStepException

countStepExecutionsForStep

public int countStepExecutionsForStep(java.lang.String jobName,
                                      java.lang.String stepName)
                               throws org.springframework.batch.core.step.NoSuchStepException

Description copied from interface: JobService

Count the step executions in the repository for a given step name (or pattern).

Specified by:

countStepExecutionsForStep in interface JobService

Parameters:

jobName - the job name (or a pattern with wildcards)

stepName - the step name (or a pattern with wildcards)

Returns:

the number of executions

Throws:

org.springframework.batch.core.step.NoSuchStepException

getJobInstance

public org.springframework.batch.core.JobInstance getJobInstance(long jobInstanceId)
                                                          throws org.springframework.batch.core.launch.NoSuchJobInstanceException

Description copied from interface: JobService

Get a job instance by id.

Specified by:

getJobInstance in interface JobService

Parameters:

jobInstanceId - the id of the instance

Returns:

a job instance

Throws:

org.springframework.batch.core.launch.NoSuchJobInstanceException

listJobInstances

public java.util.Collection<org.springframework.batch.core.JobInstance> listJobInstances(java.lang.String jobName,
                                                                                         int start,
                                                                                         int count)
                                                                                  throws org.springframework.batch.core.launch.NoSuchJobException

Description copied from interface: JobService

List the job instances in descending order of creation (usually close to order of execution).

Specified by:

listJobInstances in interface JobService

Parameters:

jobName - the name of the job

start - the index of the first to return

count - the maximum number of instances to return

Returns:

a collection of job instances

Throws:

org.springframework.batch.core.launch.NoSuchJobException

getStepNamesForJob

public java.util.Collection<java.lang.String> getStepNamesForJob(java.lang.String jobName)
                                                          throws org.springframework.batch.core.launch.NoSuchJobException

Description copied from interface: JobService

Get the names of the steps in a job (or a historical list of recent execution names if the Job is not launchable).

Specified by:

getStepNamesForJob in interface JobService

Parameters:

jobName - the name of the job

Throws:

org.springframework.batch.core.launch.NoSuchJobException - if the job name cannot be located

destroy

public void destroy()
             throws java.lang.Exception

Stop all the active jobs and wait for them (up to a time out) to finish processing.

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

java.lang.Exception

removeInactiveExecutions

@Scheduled(fixedDelay=60000L)
public void removeInactiveExecutions()

Check all the active executions and see if they are still actually running. Remove the ones that have completed.