接口 JobOperator

方法详细资料

• getExecutions

  java.util.List<java.lang.Long> getExecutions​(long instanceId)
                                        throws NoSuchJobInstanceException

  List the JobExecutions associated with a particular JobInstance, in reverse order of creation (and therefore usually of execution).

  参数:

  instanceId - the id of a JobInstance

  返回:

  the id values of all the JobExecutions associated with this instance

  抛出:

  NoSuchJobInstanceException - if the JobInstance associated with the instanceId cannot be found.

• getJobInstances

  java.util.List<java.lang.Long> getJobInstances​(java.lang.String jobName,
                                                 int start,
                                                 int count)
                                          throws NoSuchJobException

  List the JobInstances for a given job name, in reverse order of creation (and therefore usually of first execution).

  参数:

  jobName - the job name that all the instances have

  start - the start index of the instances

  count - the maximum number of values to return

  返回:

  the id values of the JobInstances

  抛出:

  NoSuchJobException - is thrown if no JobInstances for the jobName exist.

• getRunningExecutions

  java.util.Set<java.lang.Long> getRunningExecutions​(java.lang.String jobName)
                                              throws NoSuchJobException

  Get the id values of all the running JobExecutions with the given job name.

  参数:

  jobName - the name of the job to search under

  返回:

  the id values of the running JobExecution instances

  抛出:

  NoSuchJobException - if there are no JobExecutions with that job name

• getParameters

  java.lang.String getParameters​(long executionId)
                          throws NoSuchJobExecutionException

  Get the JobParameters as an easily readable String.

  参数:

  executionId - the id of an existing JobExecution

  返回:

  the job parameters that were used to launch the associated instance

  抛出:

  NoSuchJobExecutionException - if the id was not associated with any JobExecution

• start

  java.lang.Long start​(java.lang.String jobName,
                       java.lang.String parameters)
                throws NoSuchJobException,
                       JobInstanceAlreadyExistsException,
                       JobParametersInvalidException

  Start a new instance of a job with the parameters specified.

  参数:

  jobName - the name of the Job to launch

  parameters - the parameters to launch it with (comma or newline separated name=value pairs)

  返回:

  the id of the JobExecution that is launched

  抛出:

  NoSuchJobException - if there is no Job with the specified name

  JobInstanceAlreadyExistsException - if a job instance with this name and parameters already exists

  JobParametersInvalidException - thrown if any of the job parameters are invalid.

• restart

  java.lang.Long restart​(long executionId)
                  throws JobInstanceAlreadyCompleteException,
                         NoSuchJobExecutionException,
                         NoSuchJobException,
                         JobRestartException,
                         JobParametersInvalidException

  Restart a failed or stopped JobExecution. Fails with an exception if the id provided does not exist or corresponds to a JobInstance that in normal circumstances already completed successfully.

  参数:

  executionId - the id of a failed or stopped JobExecution

  返回:

  the id of the JobExecution that was started

  抛出:

  JobInstanceAlreadyCompleteException - if the job was already successfully completed

  NoSuchJobExecutionException - if the id was not associated with any JobExecution

  NoSuchJobException - if the JobExecution was found, but its corresponding Job is no longer available for launching

  JobRestartException - if there is a non-specific error with the restart (e.g. corrupt or inconsistent restart data)

  JobParametersInvalidException - if the parameters are not valid for this job

• startNextInstance

  java.lang.Long startNextInstance​(java.lang.String jobName)
                            throws NoSuchJobException,
                                   JobParametersNotFoundException,
                                   JobRestartException,
                                   JobExecutionAlreadyRunningException,
                                   JobInstanceAlreadyCompleteException,
                                   UnexpectedJobExecutionException,
                                   JobParametersInvalidException

  Launch the next in a sequence of JobInstance determined by the JobParametersIncrementer attached to the specified job. If the previous instance is still in a failed state, this method should still create a new instance and run it with different parameters (as long as the JobParametersIncrementer is working).
  
  The last three exception described below should be extremely unlikely, but cannot be ruled out entirely. It points to some other thread or process trying to use this method (or a similar one) at the same time.

  参数:

  jobName - the name of the job to launch

  返回:

  the JobExecution id of the execution created when the job is launched

  抛出:

  NoSuchJobException - if there is no such job definition available

  JobParametersNotFoundException - if the parameters cannot be found

  JobParametersInvalidException - thrown if some of the job parameters are invalid.

  UnexpectedJobExecutionException - if an unexpected condition arises

  JobRestartException - thrown if a job is restarted illegally.

  JobExecutionAlreadyRunningException - thrown if attempting to restart a job that is already executing.

  JobInstanceAlreadyCompleteException - thrown if attempting to restart a completed job.

• stop

  boolean stop​(long executionId)
        throws NoSuchJobExecutionException,
               JobExecutionNotRunningException

  Send a stop signal to the JobExecution with the supplied id. The signal is successfully sent if this method returns true, but that doesn't mean that the job has stopped. The only way to be sure of that is to poll the job execution status.

  参数:

  executionId - the id of a running JobExecution

  返回:

  true if the message was successfully sent (does not guarantee that the job has stopped)

  抛出:

  NoSuchJobExecutionException - if there is no JobExecution with the id supplied

  JobExecutionNotRunningException - if the JobExecution is not running (so cannot be stopped)

• getSummary

  java.lang.String getSummary​(long executionId)
                       throws NoSuchJobExecutionException

  Summarise the JobExecution with the supplied id, giving details of status, start and end times etc.

  参数:

  executionId - the id of an existing JobExecution

  返回:

  a String summarising the state of the job execution

  抛出:

  NoSuchJobExecutionException - if there is no JobExecution with the supplied id

• getStepExecutionSummaries

  java.util.Map<java.lang.Long,​java.lang.String> getStepExecutionSummaries​(long executionId)
                                                                          throws NoSuchJobExecutionException

  Summarise the StepExecution instances belonging to the JobExecution with the supplied id, giving details of status, start and end times etc.

  参数:

  executionId - the id of an existing JobExecution

  返回:

  a map of step execution id to String summarising the state of the execution

  抛出:

  NoSuchJobExecutionException - if there is no JobExecution with the supplied id

• getJobNames

  java.util.Set<java.lang.String> getJobNames()

  List the available job names that can be launched with start(String, String).

  返回:

  a set of job names

• abandon

  JobExecution abandon​(long jobExecutionId)
                throws NoSuchJobExecutionException,
                       JobExecutionAlreadyRunningException

  Mark the JobExecution as ABANDONED. If a stop signal is ignored because the process died this is the best way to mark a job as finished with (as opposed to STOPPED). An abandoned job execution cannot be restarted by the framework.

  参数:

  jobExecutionId - the job execution id to abort

  返回:

  the JobExecution that was aborted

  抛出:

  NoSuchJobExecutionException - thrown if there is no job execution for the jobExecutionId.

  JobExecutionAlreadyRunningException - if the job is running (it should be stopped first)