org.springframework.boot.autoconfigure.batch

Class JobLauncherCommandLineRunner

java.lang.Object

org.springframework.boot.autoconfigure.batch.JobLauncherCommandLineRunner

All Implemented Interfaces:

org.springframework.beans.factory.Aware, CommandLineRunner, org.springframework.context.ApplicationEventPublisherAware, org.springframework.core.Ordered

public class JobLauncherCommandLineRunner
extends Object
implements CommandLineRunner, org.springframework.core.Ordered, org.springframework.context.ApplicationEventPublisherAware

CommandLineRunner to launch Spring Batch jobs. Runs all jobs in the surrounding context by default. Can also be used to launch a specific job by providing a jobName

Since:

1.0.0

Author:

Dave Syer, Jean-Pierre Bergamin, Mahmoud Ben Hassine

Field Summary

Fields

Modifier and Type	Field and Description
static 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 and Description
JobLauncherCommandLineRunner(org.springframework.batch.core.launch.JobLauncher jobLauncher, org.springframework.batch.core.explore.JobExplorer jobExplorer) Deprecated. since 2.0.7 in favor of JobLauncherCommandLineRunner(JobLauncher, JobExplorer, JobRepository). A job repository is required to check if a job instance exists with the given parameters when running a job (which is not possible with the job explorer).
JobLauncherCommandLineRunner(org.springframework.batch.core.launch.JobLauncher jobLauncher, org.springframework.batch.core.explore.JobExplorer jobExplorer, org.springframework.batch.core.repository.JobRepository jobRepository) Create a new JobLauncherCommandLineRunner.

Method Summary

Modifier and Type	Method and Description
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) Callback used to run the bean.
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher publisher)
void	setJobNames(String jobNames)
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)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ORDER

public static final int DEFAULT_ORDER

The default order for the command line runner.

See Also:

Constant Field Values

Constructor Detail

JobLauncherCommandLineRunner

@Deprecated
public JobLauncherCommandLineRunner(org.springframework.batch.core.launch.JobLauncher jobLauncher,
                                                org.springframework.batch.core.explore.JobExplorer jobExplorer)

Deprecated. since 2.0.7 in favor of JobLauncherCommandLineRunner(JobLauncher, JobExplorer, JobRepository). A job repository is required to check if a job instance exists with the given parameters when running a job (which is not possible with the job explorer).

Create a new JobLauncherCommandLineRunner.

Parameters:

jobLauncher - to launch jobs

jobExplorer - to check the job repository for previous executions

JobLauncherCommandLineRunner

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

Create a new JobLauncherCommandLineRunner.

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 Detail

setOrder

public void setOrder(int order)

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setApplicationEventPublisher

public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher publisher)

Specified by:

setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware

setJobRegistry

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

setJobNames

public void setJobNames(String jobNames)

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(String... args)
         throws org.springframework.batch.core.JobExecutionException

Description copied from interface: CommandLineRunner

Callback used to run the bean.

Specified by:

run in interface CommandLineRunner

Parameters:

args - incoming main method arguments

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,
                       org.springframework.batch.core.launch.JobParametersNotFoundException

Throws:

org.springframework.batch.core.repository.JobExecutionAlreadyRunningException

org.springframework.batch.core.repository.JobRestartException

org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException

org.springframework.batch.core.JobParametersInvalidException

org.springframework.batch.core.launch.JobParametersNotFoundException