org.springframework.cloud.task.batch.handler

Class TaskJobLauncherCommandLineRunner

java.lang.Object

org.springframework.boot.autoconfigure.batch.JobLauncherCommandLineRunner

org.springframework.cloud.task.batch.handler.TaskJobLauncherCommandLineRunner

All Implemented Interfaces:

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

public class TaskJobLauncherCommandLineRunner
extends org.springframework.boot.autoconfigure.batch.JobLauncherCommandLineRunner

CommandLineRunner to launch Spring Batch jobs. Runs all jobs in the surrounding context by default and throws an exception upon the first job that returns an BatchStatus of FAILED if a TaskExecutor in the JobLauncher is not specified. If a TaskExecutor is specified in the JobLauncher then all Jobs are launched and an exception is thrown if one or more of the jobs has an BatchStatus of FAILED. TaskJobLauncherCommandLineRunner can also be used to launch a specific job by providing a jobName. The TaskJobLaunchercommandLineRunner takes the place of the JobLauncherCommandLineRunner when it is in use.

Since:

2.0.0

Author:

Glenn Renfro

Field Summary

Fields inherited from class org.springframework.boot.autoconfigure.batch.JobLauncherCommandLineRunner

DEFAULT_ORDER

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	execute(org.springframework.batch.core.Job job, org.springframework.batch.core.JobParameters jobParameters)
void	run(String... args)
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher publisher)

Methods inherited from class org.springframework.boot.autoconfigure.batch.JobLauncherCommandLineRunner

getOrder, launchJobFromProperties, setJobNames, setJobParametersConverter, setJobRegistry, setJobs, setOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskJobLauncherCommandLineRunner

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

Create a new TaskJobLauncherCommandLineRunner.

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

taskBatchProperties - the properties used to configure the taskBatchProperties.

Method Detail

setApplicationEventPublisher

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

Specified by:

setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware

Overrides:

setApplicationEventPublisher in class org.springframework.boot.autoconfigure.batch.JobLauncherCommandLineRunner

run

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

Specified by:

run in interface org.springframework.boot.CommandLineRunner

Overrides:

run in class org.springframework.boot.autoconfigure.batch.JobLauncherCommandLineRunner

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

Overrides:

execute in class org.springframework.boot.autoconfigure.batch.JobLauncherCommandLineRunner

Throws:

org.springframework.batch.core.repository.JobExecutionAlreadyRunningException

org.springframework.batch.core.repository.JobRestartException

org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException

org.springframework.batch.core.JobParametersInvalidException