Package org.springframework.batch.core.job.builder

Class JobBuilderHelper<B extends JobBuilderHelper<B>>

java.lang.Object
org.springframework.batch.core.job.builder.JobBuilderHelper<B>
Direct Known Subclasses:
FlowJobBuilder, JobBuilder, SimpleJobBuilder
public abstract class JobBuilderHelper<B extends JobBuilderHelper<B>> extends Object
A base class and utility for other job builders providing access to common properties like job repository.
Since:
2.2
Author:
Dave Syer, Mahmoud Ben Hassine, Taeik Lim

  • Field Details

    • logger

      protected final org.apache.commons.logging.Log logger

  • Constructor Details

    • JobBuilderHelper

      @Deprecated(since="5.1", forRemoval=true) public JobBuilderHelper(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use JobBuilderHelper(String, JobRepository)
      Create a new JobBuilderHelper.
      Parameters:
      name - the job name

    • JobBuilderHelper

      public JobBuilderHelper(String name, JobRepository jobRepository)
      Create a new JobBuilderHelper.
      Parameters:
      name - the job name
      jobRepository - the job repository
      Since:
      5.1

    • JobBuilderHelper

      protected JobBuilderHelper(JobBuilderHelper<?> parent)
      Create a new builder initialized with any properties in the parent. The parent is copied, so it can be re-used.
      Parameters:
      parent - a parent helper containing common step properties

  • Method Details

    • validator

      public B validator(JobParametersValidator jobParametersValidator)
      Add a job parameters validator.
      Parameters:
      jobParametersValidator - a job parameters validator
      Returns:
      this to enable fluent chaining

    • incrementer

      public B incrementer(JobParametersIncrementer jobParametersIncrementer)
      Add a job parameters incrementer.
      Parameters:
      jobParametersIncrementer - a job parameters incrementer
      Returns:
      this to enable fluent chaining

    • repository

      @Deprecated(since="5.1", forRemoval=true) public B repository(JobRepository jobRepository)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use JobBuilderHelper(String, JobRepository)
      Sets the job repository for the job.
      Parameters:
      jobRepository - the job repository (mandatory)
      Returns:
      this to enable fluent chaining

    • observationConvention

      public B observationConvention(BatchJobObservationConvention observationConvention)
      Sets the job observation convention.
      Parameters:
      observationConvention - the job observation convention (optional)
      Returns:
      this to enable fluent chaining
      Since:
      5.1

    • observationRegistry

      public B observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)
      Sets the observation registry for the job.
      Parameters:
      observationRegistry - the observation registry (optional)
      Returns:
      this to enable fluent chaining

    • meterRegistry

      public B meterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry)
      Sets the meter registry for the job.
      Parameters:
      meterRegistry - the meter registry (optional)
      Returns:
      this to enable fluent chaining

    • listener

      public B listener(Object listener)
      Registers objects using the annotation based listener configuration.
      Parameters:
      listener - the object that has a method configured with listener annotation
      Returns:
      this for fluent chaining

    • listener

      public B listener(JobExecutionListener listener)
      Register a job execution listener.
      Parameters:
      listener - a job execution listener
      Returns:
      this to enable fluent chaining

    • preventRestart

      public B preventRestart()
      Set a flag to prevent restart an execution of this job even if it has failed.
      Returns:
      this to enable fluent chaining

    • getName

      protected String getName()

    • getJobRepository

      protected JobRepository getJobRepository()

    • isRestartable

      protected boolean isRestartable()

    • enhance

      protected void enhance(AbstractJob job)