Class JobLauncherApplicationRunner

java.lang.Object
org.springframework.boot.batch.autoconfigure.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:
4.0.0
Author:
Dave Syer, Jean-Pierre Bergamin, Mahmoud Ben Hassine, Stephane Nicoll, Akshay Dubey

  • Field Details

    • DEFAULT_ORDER

      public static final int DEFAULT_ORDER
      The default order for the command line runner.
      See Also:

  • Constructor Details

    • JobLauncherApplicationRunner

      public JobLauncherApplicationRunner(org.springframework.batch.core.launch.JobOperator jobOperator)
      Create a new JobLauncherApplicationRunner.
      Parameters:
      jobOperator - to launch jobs

  • Method Details

    • afterPropertiesSet

      public void afterPropertiesSet()
      Specified by:
      afterPropertiesSet in interface InitializingBean

    • 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.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.job.JobExecutionException
      Throws:
      org.springframework.batch.core.job.JobExecutionException

    • launchJobFromProperties

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

    • execute

      protected void execute(org.springframework.batch.core.job.Job job, org.springframework.batch.core.job.parameters.JobParameters jobParameters) throws org.springframework.batch.core.launch.JobExecutionAlreadyRunningException, org.springframework.batch.core.launch.JobRestartException, org.springframework.batch.core.launch.JobInstanceAlreadyCompleteException, org.springframework.batch.core.job.parameters.InvalidJobParametersException
      Throws:
      org.springframework.batch.core.launch.JobExecutionAlreadyRunningException
      org.springframework.batch.core.launch.JobRestartException
      org.springframework.batch.core.launch.JobInstanceAlreadyCompleteException
      org.springframework.batch.core.job.parameters.InvalidJobParametersException