类 AbstractJob

字段详细资料

• logger

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

构造器详细资料

• AbstractJob

  public AbstractJob()

  Default constructor.

• AbstractJob

  public AbstractJob​(java.lang.String name)

  Convenience constructor to immediately add name (which is mandatory but not final).

  参数:

  name - name of the job

方法详细资料

• setJobParametersValidator

  public void setJobParametersValidator​(JobParametersValidator jobParametersValidator)

  A validator for job parameters. Defaults to a vanilla DefaultJobParametersValidator.

  参数:

  jobParametersValidator - a validator instance

• afterPropertiesSet

  public void afterPropertiesSet()
                          throws java.lang.Exception

  Assert mandatory properties: JobRepository.

  指定者:

  afterPropertiesSet 在接口中 org.springframework.beans.factory.InitializingBean

  抛出:

  java.lang.Exception

  另请参阅:

  InitializingBean.afterPropertiesSet()

• setBeanName

  public void setBeanName​(java.lang.String name)

  Set the name property if it is not already set. Because of the order of the callbacks in a Spring container the name property will be set first if it is present. Care is needed with bean definition inheritance - if a parent bean has a name, then its children need an explicit name as well, otherwise they will not be unique.

  指定者:

  setBeanName 在接口中 org.springframework.beans.factory.BeanNameAware

  另请参阅:

  BeanNameAware.setBeanName(java.lang.String)

• setName

  public void setName​(java.lang.String name)

  Set the name property. Always overrides the default value if this object is a Spring bean.

  参数:

  name - the name to be associated with the job.

  另请参阅:

  setBeanName(java.lang.String)

• getName

  public java.lang.String getName()

  指定者:

  getName 在接口中 Job

• getStep

  public abstract Step getStep​(java.lang.String stepName)

  Retrieve the step with the given name. If there is no Step with the given name, then return null.

  指定者:

  getStep 在接口中 StepLocator

  参数:

  stepName - name of the step

  返回:

  the Step

• getStepNames

  public abstract java.util.Collection<java.lang.String> getStepNames()

  Retrieve the step names.

  指定者:

  getStepNames 在接口中 StepLocator

  返回:

  the step names

• getJobParametersValidator

  public JobParametersValidator getJobParametersValidator()

  从接口复制的说明: Job
  A validator for the job parameters of a JobExecution. Clients of a Job may need to validate the parameters for a launch, before or during the execution.

  指定者:

  getJobParametersValidator 在接口中 Job

  返回:

  a validator that can be used to check parameter values (never null)

• setRestartable

  public void setRestartable​(boolean restartable)

  Boolean flag to prevent categorically a job from restarting, even if it has failed previously.

  参数:

  restartable - the value of the flag to set (default true)

• isRestartable

  public boolean isRestartable()

  从接口复制的说明: Job
  Flag to indicate if this job can be restarted, at least in principle.

  指定者:

  isRestartable 在接口中 Job

  返回:

  true if this job can be restarted after a failure

  另请参阅:

  Job.isRestartable()

• setJobParametersIncrementer

  public void setJobParametersIncrementer​(JobParametersIncrementer jobParametersIncrementer)

  Public setter for the JobParametersIncrementer.

  参数:

  jobParametersIncrementer - the JobParametersIncrementer to set

• getJobParametersIncrementer

  @Nullable
  public JobParametersIncrementer getJobParametersIncrementer()

  从接口复制的说明: Job
  If clients need to generate new parameters for the next execution in a sequence they can use this incrementer. The return value may be null, in the case that this job does not have a natural sequence.

  指定者:

  getJobParametersIncrementer 在接口中 Job

  返回:

  in incrementer to be used for creating new parameters

• setJobExecutionListeners

  public void setJobExecutionListeners​(JobExecutionListener[] listeners)

  Public setter for injecting JobExecutionListeners. They will all be given the listener callbacks at the appropriate point in the job.

  参数:

  listeners - the listeners to set.

• registerJobExecutionListener

  public void registerJobExecutionListener​(JobExecutionListener listener)

  Register a single listener for the JobExecutionListener callbacks.

  参数:

  listener - a JobExecutionListener

• setJobRepository

  public void setJobRepository​(JobRepository jobRepository)

  Public setter for the JobRepository that is needed to manage the state of the batch meta domain (jobs, steps, executions) during the life of a job.

  参数:

  jobRepository - repository to use during the job execution

• getJobRepository

  protected JobRepository getJobRepository()

  Convenience method for subclasses to access the job repository.

  返回:

  the jobRepository

• doExecute

  protected abstract void doExecute​(JobExecution execution)
                             throws JobExecutionException

  Extension point for subclasses allowing them to concentrate on processing logic and ignore listeners and repository calls. Implementations usually are concerned with the ordering of steps, and delegate actual step processing to handleStep(Step, JobExecution).

  参数:

  execution - the current JobExecution

  抛出:

  JobExecutionException - to signal a fatal batch framework error (not a business or validation exception)

• execute

  public final void execute​(JobExecution execution)

  Run the specified job, handling all listener and repository calls, and delegating the actual processing to doExecute(JobExecution).

  指定者:

  execute 在接口中 Job

  参数:

  execution - a JobExecution

  抛出:

  StartLimitExceededException - if start limit of one of the steps was exceeded

  另请参阅:

  Job.execute(JobExecution)

• handleStep

  protected final StepExecution handleStep​(Step step,
                                           JobExecution execution)
                                    throws JobInterruptedException,
                                           JobRestartException,
                                           StartLimitExceededException

  Convenience method for subclasses to delegate the handling of a specific step in the context of the current JobExecution. Clients of this method do not need access to the JobRepository, nor do they need to worry about populating the execution context on a restart, nor detecting the interrupted state (in job or step execution).

  参数:

  step - the Step to execute

  execution - the current JobExecution

  返回:

  the StepExecution corresponding to this step

  抛出:

  JobInterruptedException - if the JobExecution has been interrupted, and in particular if BatchStatus.ABANDONED or BatchStatus.STOPPING is detected

  StartLimitExceededException - if the start limit has been exceeded for this step

  JobRestartException - if the job is in an inconsistent state from an earlier failure

• getDefaultExitStatusForFailure

  protected ExitStatus getDefaultExitStatusForFailure​(java.lang.Throwable ex,
                                                      JobExecution execution)

  Default mapping from throwable to ExitStatus.

  参数:

  ex - the cause of the failure

  execution - the JobExecution instance.

  返回:

  an ExitStatus

• toString

  public java.lang.String toString()

  覆盖:

  toString 在类中 java.lang.Object