Package org.springframework.boot.autoconfigure.batch

Class JobLauncherApplicationRunner

java.lang.Object

org.springframework.boot.autoconfigure.batch.JobLauncherApplicationRunner

All Implemented Interfaces:

Aware, InitializingBean, ApplicationRunner, ApplicationEventPublisherAware, Ordered

public class JobLauncherApplicationRunner
extends Object
implements ApplicationRunner, InitializingBean, Ordered, ApplicationEventPublisherAware

ApplicationRunner to launch Spring Batch jobs. If a single job is found in the context, it will be executed by default. If multiple jobs are found, launch a specific job by providing a jobName.

Since:

2.3.0

Author:

Dave Syer, Jean-Pierre Bergamin, Mahmoud Ben Hassine, Stephane Nicoll, Akshay Dubey

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_ORDER	The default order for the command line runner.

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
JobLauncherApplicationRunner(org.springframework.batch.core.launch.JobLauncher jobLauncher, org.springframework.batch.core.explore.JobExplorer jobExplorer, org.springframework.batch.core.repository.JobRepository jobRepository)	Create a new JobLauncherApplicationRunner.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected void	execute(org.springframework.batch.core.Job job, org.springframework.batch.core.JobParameters jobParameters)
int	getOrder()
protected void	launchJobFromProperties(Properties properties)
void	run(String... args)
void	run(ApplicationArguments args)	Callback used to run the bean.
void	setApplicationEventPublisher(ApplicationEventPublisher publisher)
void	setJobName(String jobName)
void	setJobParametersConverter(org.springframework.batch.core.converter.JobParametersConverter converter)
void	setJobRegistry(org.springframework.batch.core.configuration.JobRegistry jobRegistry)
void	setJobs(Collection<org.springframework.batch.core.Job> jobs)
void	setOrder(int order)
void	validate()	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ORDER

public static final int DEFAULT_ORDER

The default order for the command line runner.

See Also:

• Constant Field Values

Constructor Details

JobLauncherApplicationRunner

public JobLauncherApplicationRunner(org.springframework.batch.core.launch.JobLauncher jobLauncher,
 org.springframework.batch.core.explore.JobExplorer jobExplorer,
 org.springframework.batch.core.repository.JobRepository jobRepository)

Create a new JobLauncherApplicationRunner.

Parameters:

jobLauncher - to launch jobs

jobExplorer - to check the job repository for previous executions

jobRepository - to check if a job instance exists with the given parameters when running a job

Method Details

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

validate

@Deprecated(since="3.0.10",
            forRemoval=true)
public void validate()

Deprecated, for removal: This API element is subject to removal in a future version.

setOrder

public void setOrder(int order)

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher publisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

setJobRegistry

@Autowired(required=false)
public void setJobRegistry(org.springframework.batch.core.configuration.JobRegistry jobRegistry)

setJobName

public void setJobName(String jobName)

setJobParametersConverter

@Autowired(required=false)
public void setJobParametersConverter(org.springframework.batch.core.converter.JobParametersConverter converter)

setJobs

@Autowired(required=false)
public void setJobs(Collection<org.springframework.batch.core.Job> jobs)

run

public void run(ApplicationArguments args)
         throws Exception

Description copied from interface: ApplicationRunner

Callback used to run the bean.

Specified by:

run in interface ApplicationRunner

Parameters:

args - incoming application arguments

Throws:

Exception - on error

run

public void run(String... args)
         throws org.springframework.batch.core.JobExecutionException

Throws:

org.springframework.batch.core.JobExecutionException

launchJobFromProperties

protected void launchJobFromProperties(Properties properties)
                                throws org.springframework.batch.core.JobExecutionException

Throws:

org.springframework.batch.core.JobExecutionException

execute

protected void execute(org.springframework.batch.core.Job job,
 org.springframework.batch.core.JobParameters jobParameters)
                throws org.springframework.batch.core.repository.JobExecutionAlreadyRunningException,
org.springframework.batch.core.repository.JobRestartException,
org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException,
org.springframework.batch.core.JobParametersInvalidException

Throws:

org.springframework.batch.core.repository.JobExecutionAlreadyRunningException

org.springframework.batch.core.repository.JobRestartException

org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException

org.springframework.batch.core.JobParametersInvalidException