Package org.springframework.batch.core.launch.support

Class SimpleJobOperator

java.lang.Object

org.springframework.batch.core.launch.support.TaskExecutorJobLauncher

org.springframework.batch.core.launch.support.SimpleJobOperator

All Implemented Interfaces:

JobLauncher, JobOperator, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

TaskExecutorJobOperator

@Deprecated(since="6.0",
            forRemoval=true)
public class SimpleJobOperator
extends TaskExecutorJobLauncher
implements JobOperator, org.springframework.beans.factory.InitializingBean

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.0 in favor of TaskExecutorJobOperator. Scheduled for removal in 6.2 or later.

Simple implementation of the JobOperator interface. the following dependencies are required:

• JobRepository
• JobRegistry

This class can be instantiated with a JobOperatorFactoryBean to create a transactional proxy around the job operator.

Since:

2.0

Author:

Dave Syer, Lucas Ward, Will Schipp, Mahmoud Ben Hassine, Andrey Litvitski, Yejeong Ham

See Also:

• JobOperatorFactoryBean

Field Summary

Fields

Modifier and Type	Field	Description
protected JobParametersConverter	jobParametersConverter	Deprecated, for removal: This API element is subject to removal in a future version.
protected JobRegistry	jobRegistry	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from class org.springframework.batch.core.launch.support.TaskExecutorJobLauncher

jobLaunchCount, jobRepository, meterRegistry, taskExecutor

Constructor Summary

Constructors

Constructor	Description
SimpleJobOperator()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
JobExecution	abandon(long jobExecutionId)	Deprecated, for removal: This API element is subject to removal in a future version.
JobExecution	abandon(JobExecution jobExecution)	Deprecated, for removal: This API element is subject to removal in a future version. Mark the JobExecution as ABANDONED.
void	afterPropertiesSet()	Deprecated, for removal: This API element is subject to removal in a future version. Check mandatory properties.
List<Long>	getExecutions(long instanceId)	Deprecated, for removal: This API element is subject to removal in a future version.
JobInstance	getJobInstance(String jobName, JobParameters jobParameters)	Deprecated, for removal: This API element is subject to removal in a future version.
List<Long>	getJobInstances(String jobName, int start, int count)	Deprecated, for removal: This API element is subject to removal in a future version.
Set<String>	getJobNames()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getParameters(long executionId)	Deprecated, for removal: This API element is subject to removal in a future version.
Set<Long>	getRunningExecutions(String jobName)	Deprecated, for removal: This API element is subject to removal in a future version.
Map<Long,String>	getStepExecutionSummaries(long executionId)	Deprecated, for removal: This API element is subject to removal in a future version.
String	getSummary(long executionId)	Deprecated, for removal: This API element is subject to removal in a future version.
JobExecution	recover(JobExecution jobExecution)	Deprecated, for removal: This API element is subject to removal in a future version. Marks the given JobExecution as FAILED when it is stuck in a STARTED state due to an abrupt shutdown or failure, in order to make it restartable.
Long	restart(long executionId)	Deprecated, for removal: This API element is subject to removal in a future version.
JobExecution	restart(JobExecution jobExecution)	Deprecated, for removal: This API element is subject to removal in a future version. Restart a failed or stopped JobExecution.
void	setJobParametersConverter(JobParametersConverter jobParametersConverter)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.0 with no replacement.
void	setJobRegistry(JobRegistry jobRegistry)	Deprecated, for removal: This API element is subject to removal in a future version. Public setter for the JobRegistry.
Long	start(String jobName, Properties parameters)	Deprecated, for removal: This API element is subject to removal in a future version.
JobExecution	start(Job job, JobParameters jobParameters)	Deprecated, for removal: This API element is subject to removal in a future version. Start a new instance of a job with the specified parameters.
Long	startNextInstance(String jobName)	Deprecated, for removal: This API element is subject to removal in a future version.
JobExecution	startNextInstance(Job job)	Deprecated, for removal: This API element is subject to removal in a future version. Launch the next in a sequence of JobInstance determined by the JobParametersIncrementer attached to the specified job.
boolean	stop(long executionId)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	stop(JobExecution jobExecution)	Deprecated, for removal: This API element is subject to removal in a future version. Send a stop signal to the supplied JobExecution.

Methods inherited from class org.springframework.batch.core.launch.support.TaskExecutorJobLauncher

run, setJobRepository, setMeterRegistry, setTaskExecutor

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.batch.core.launch.JobLauncher

run

Field Details

jobRegistry

protected JobRegistry jobRegistry

Deprecated, for removal: This API element is subject to removal in a future version.

jobParametersConverter

protected JobParametersConverter jobParametersConverter

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Details

SimpleJobOperator

public SimpleJobOperator()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Deprecated, for removal: This API element is subject to removal in a future version.

Check mandatory properties.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Overrides:

afterPropertiesSet in class TaskExecutorJobLauncher

Throws:

Exception

See Also:

• InitializingBean.afterPropertiesSet()

setJobParametersConverter

@Deprecated(since="6.0",
            forRemoval=true)
public void setJobParametersConverter(JobParametersConverter jobParametersConverter)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.0 with no replacement. Scheduled for removal in 6.2 or later.

Public setter for the JobParametersConverter.

Parameters:

jobParametersConverter - the JobParametersConverter to set

setJobRegistry

public void setJobRegistry(JobRegistry jobRegistry)

Deprecated, for removal: This API element is subject to removal in a future version.

Public setter for the JobRegistry.

Parameters:

jobRegistry - the JobRegistry to set

start

@Deprecated(since="6.0",
            forRemoval=true)
public Long start(String jobName,
 Properties parameters)
           throws NoSuchJobException,
JobInstanceAlreadyExistsException,
JobParametersInvalidException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

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

Specified by:

start in interface JobOperator

Parameters:

jobName - the name of the Job to launch

parameters - the parameters to launch it with

Returns:

the id of the JobExecution that is launched

Throws:

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.

start

public JobExecution start(Job job,
 JobParameters jobParameters)
                   throws NoSuchJobException,
JobInstanceAlreadyCompleteException,
JobExecutionAlreadyRunningException,
JobRestartException,
JobParametersInvalidException

Deprecated, for removal: This API element is subject to removal in a future version.

Start a new instance of a job with the specified parameters. If the job defines a JobParametersIncrementer, then the incrementer will be used to calculate the next parameters in the sequence and the provided parameters will be ignored.

Specified by:

start in interface JobOperator

Parameters:

job - the Job to start

jobParameters - the JobParameters to start the job with

Returns:

the JobExecution that was started

Throws:

NoSuchJobException - if the given Job is not registered

JobParametersInvalidException - thrown if any of the job parameters are

JobExecutionAlreadyRunningException - if the JobInstance identified by the properties already has an execution running. invalid.

JobRestartException - if the execution would be a re-start, but a re-start is either not allowed or not needed.

JobInstanceAlreadyCompleteException - if the job has been run before with the same parameters and completed successfully

IllegalArgumentException - if the job or job parameters are null.

restart

@Deprecated(since="6.0",
            forRemoval=true)
public Long restart(long executionId)
             throws JobInstanceAlreadyCompleteException,
NoSuchJobExecutionException,
NoSuchJobException,
JobRestartException,
JobParametersInvalidException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

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.

Specified by:

restart in interface JobOperator

Parameters:

executionId - the id of a failed or stopped JobExecution

Returns:

the id of the JobExecution that was started

Throws:

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

restart

public JobExecution restart(JobExecution jobExecution)
                     throws JobInstanceAlreadyCompleteException,
NoSuchJobExecutionException,
NoSuchJobException,
JobRestartException,
JobParametersInvalidException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

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

Specified by:

restart in interface JobOperator

Parameters:

jobExecution - the failed or stopped JobExecution to restart

Returns:

the JobExecution that was started

Throws:

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

@Deprecated(since="6.0",
            forRemoval=true)
public Long startNextInstance(String jobName)
                       throws NoSuchJobException,
UnexpectedJobExecutionException,
JobParametersInvalidException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

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.

Specified by:

startNextInstance in interface JobOperator

Parameters:

jobName - the name of the job to launch

Returns:

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

Throws:

NoSuchJobException - if there is no such job definition available

UnexpectedJobExecutionException - if an unexpected condition arises

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

startNextInstance

public JobExecution startNextInstance(Job job)
                               throws UnexpectedJobExecutionException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

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.

Specified by:

startNextInstance in interface JobOperator

Parameters:

job - the job to launch

Returns:

the JobExecution created when the job is launched

Throws:

UnexpectedJobExecutionException - if an unexpected condition arises

stop

@Deprecated(since="6.0",
            forRemoval=true)
public boolean stop(long executionId)
             throws NoSuchJobExecutionException,
JobExecutionNotRunningException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

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.

Specified by:

stop in interface JobOperator

Parameters:

executionId - the id of a running JobExecution

Returns:

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

Throws:

NoSuchJobExecutionException - if there is no JobExecution with the id supplied

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

stop

public boolean stop(JobExecution jobExecution)
             throws JobExecutionNotRunningException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

Send a stop signal to the supplied JobExecution. 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.

Specified by:

stop in interface JobOperator

Parameters:

jobExecution - the running JobExecution

Returns:

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

Throws:

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

abandon

@Deprecated(since="6.0",
            forRemoval=true)
public JobExecution abandon(long jobExecutionId)
                     throws NoSuchJobExecutionException,
JobExecutionAlreadyRunningException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

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.

Specified by:

abandon in interface JobOperator

Parameters:

jobExecutionId - the job execution id to abort

Returns:

the JobExecution that was aborted

Throws:

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

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

abandon

public JobExecution abandon(JobExecution jobExecution)
                     throws JobExecutionAlreadyRunningException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

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.

Specified by:

abandon in interface JobOperator

Parameters:

jobExecution - the job execution to abort

Returns:

the JobExecution that was aborted

Throws:

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

recover

public JobExecution recover(JobExecution jobExecution)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

Marks the given JobExecution as FAILED when it is stuck in a STARTED state due to an abrupt shutdown or failure, in order to make it restartable. This operation makes a previously non-restartable execution eligible for restart by updating its execution context with the flag recovered=true.

Specified by:

recover in interface JobOperator

Parameters:

jobExecution - the JobExecution to recover

Returns:

the JobExecution after it has been marked as recovered

getJobNames

@Deprecated(since="6.0",
            forRemoval=true)
public Set<String> getJobNames()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

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

Specified by:

getJobNames in interface JobOperator

Returns:

a set of job names

getExecutions

@Deprecated(since="6.0",
            forRemoval=true)
public List<Long> getExecutions(long instanceId)
                         throws NoSuchJobInstanceException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

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

Specified by:

getExecutions in interface JobOperator

Parameters:

instanceId - the id of a JobInstance

Returns:

the id values of all the JobExecutions associated with this instance

Throws:

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

getJobInstances

@Deprecated(since="6.0",
            forRemoval=true)
public List<Long> getJobInstances(String jobName,
 int start,
 int count)
                           throws NoSuchJobException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

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

Specified by:

getJobInstances in interface JobOperator

Parameters:

jobName - the job name that all the instances have

start - the start index of the instances

count - the maximum number of values to return

Returns:

the id values of the JobInstances

Throws:

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

getJobInstance

@Nullable
@Deprecated(since="6.0",
            forRemoval=true)
public JobInstance getJobInstance(String jobName,
 JobParameters jobParameters)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getJobInstance in interface JobOperator

Parameters:

jobName - String name of the job.

jobParameters - JobParameters parameters for the job instance.

Returns:

the JobInstance with the given name and parameters, or null.

getParameters

@Deprecated(since="6.0",
            forRemoval=true)
public String getParameters(long executionId)
                     throws NoSuchJobExecutionException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

Get the JobParameters as a human readable String (new line separated key=value pairs).

Specified by:

getParameters in interface JobOperator

Parameters:

executionId - the id of an existing JobExecution

Returns:

the job parameters that were used to launch the associated instance

Throws:

NoSuchJobExecutionException - if the id was not associated with any JobExecution

getRunningExecutions

@Deprecated(since="6.0",
            forRemoval=true)
public Set<Long> getRunningExecutions(String jobName)
                               throws NoSuchJobException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

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

Specified by:

getRunningExecutions in interface JobOperator

Parameters:

jobName - the name of the job to search under

Returns:

the id values of the running JobExecution instances

Throws:

NoSuchJobException - if there are no JobExecutions with that job name

getStepExecutionSummaries

@Deprecated(since="6.0",
            forRemoval=true)
public Map<Long,String> getStepExecutionSummaries(long executionId)
                                           throws NoSuchJobExecutionException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

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

Specified by:

getStepExecutionSummaries in interface JobOperator

Parameters:

executionId - the id of an existing JobExecution

Returns:

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

Throws:

NoSuchJobExecutionException - if there is no JobExecution with the supplied id

getSummary

@Deprecated(since="6.0",
            forRemoval=true)
public String getSummary(long executionId)
                  throws NoSuchJobExecutionException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: JobOperator

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

Specified by:

getSummary in interface JobOperator

Parameters:

executionId - the id of an existing JobExecution

Returns:

a String summarising the state of the job execution

Throws:

NoSuchJobExecutionException - if there is no JobExecution with the supplied id