org.jberet.operations

Class AbstractJobOperator

java.lang.Object

org.jberet.operations.AbstractJobOperator

All Implemented Interfaces:

javax.batch.operations.JobOperator

Direct Known Subclasses:

JobOperatorImpl

public abstract class AbstractJobOperator
extends Object
implements javax.batch.operations.JobOperator

An abstract implementation of a JobOperator. Subclasses should generally delegate to the super methods of this abstraction.

Author:

Cheng Fang - Initial API and implementation, James R. Perkins

Constructor Summary

Constructors

Constructor and Description
AbstractJobOperator()

Method Summary

Modifier and Type	Method and Description
void	abandon(long executionId)
abstract BatchEnvironment	getBatchEnvironment() Returns the batch environment that should be used for this JobOperator.
javax.batch.runtime.JobExecution	getJobExecution(long executionId)
protected JobExecutionImpl	getJobExecutionImpl(long executionId) Returns the job execution implementation found in the job repository.
List<javax.batch.runtime.JobExecution>	getJobExecutions(javax.batch.runtime.JobInstance instance)
javax.batch.runtime.JobInstance	getJobInstance(long executionId)
int	getJobInstanceCount(String jobName)
List<javax.batch.runtime.JobInstance>	getJobInstances(String jobName, int start, int count)
Set<String>	getJobNames()
JobRepository	getJobRepository() This is equivalent to getBatchEnvironment().getJobRepository().
Properties	getParameters(long executionId)
List<Long>	getRunningExecutions(String jobName)
List<javax.batch.runtime.StepExecution>	getStepExecutions(long jobExecutionId)
long	restart(long executionId, Properties restartParameters)
long	restart(long executionId, Properties restartParameters, String user) Restarts a stopped or failed job with the specified user.
long	start(Job jobDefined, Properties jobParameters) Starts a pre-configured Job instance, with job parameters.
long	start(Job jobDefined, Properties jobParameters, String user) Starts a pre-configured Job instance, with job parameters and sets the user on the execution
long	start(String jobXMLName, Properties jobParameters)
long	start(String jobXMLName, Properties jobParameters, String user) Creates a new job instance and starts the first execution of that instance.
void	stop(long executionId)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJobOperator

public AbstractJobOperator()

Method Detail

getBatchEnvironment

public abstract BatchEnvironment getBatchEnvironment()

Returns the batch environment that should be used for this JobOperator. Implementations should never return null.

Returns:

the batch environment

getJobRepository

public JobRepository getJobRepository()

This is equivalent to getBatchEnvironment().getJobRepository().

Returns:

the job repository that belongs to the batch environment

start

public long start(String jobXMLName,
                  Properties jobParameters)
           throws javax.batch.operations.JobStartException,
                  javax.batch.operations.JobSecurityException

Specified by:

start in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.JobStartException

javax.batch.operations.JobSecurityException

start

public long start(String jobXMLName,
                  Properties jobParameters,
                  String user)
           throws javax.batch.operations.JobStartException,
                  javax.batch.operations.JobSecurityException

Creates a new job instance and starts the first execution of that instance.

Parameters:

jobXMLName - specifies the name of the job XML describing the job

jobParameters - specifies the keyword/value pairs for attribute substitution in the Job XML

user - the user to associate with the job execution

Returns:

executionId for the job execution.

Throws:

javax.batch.operations.JobStartException - if the job failed to start

javax.batch.operations.JobSecurityException - if there is a security issue with starting the job

See Also:

start(String, Properties)

start

public long start(Job jobDefined,
                  Properties jobParameters)
           throws javax.batch.operations.JobStartException,
                  javax.batch.operations.JobSecurityException

Starts a pre-configured Job instance, with job parameters.

Parameters:

jobDefined - a pre-configured job

jobParameters - job parameters for the current job execution

Returns:

job execution id as a long number

Throws:

javax.batch.operations.JobStartException - if failed to start the job

javax.batch.operations.JobSecurityException - if failed to start the job due to security permission

Since:

1.2.0

See Also:

JobBuilder

start

public long start(Job jobDefined,
                  Properties jobParameters,
                  String user)
           throws javax.batch.operations.JobStartException,
                  javax.batch.operations.JobSecurityException

Starts a pre-configured Job instance, with job parameters and sets the user on the execution

Parameters:

jobDefined - a pre-configured job

jobParameters - job parameters for the current job execution

user - the user to associate with the job execution

Returns:

job execution id as a long number

Throws:

javax.batch.operations.JobStartException - if failed to start the job

javax.batch.operations.JobSecurityException - if failed to start the job due to security permission

Since:

1.2.2

See Also:

JobBuilder

stop

public void stop(long executionId)
          throws javax.batch.operations.NoSuchJobExecutionException,
                 javax.batch.operations.JobExecutionNotRunningException,
                 javax.batch.operations.JobSecurityException

Specified by:

stop in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobExecutionException

javax.batch.operations.JobExecutionNotRunningException

javax.batch.operations.JobSecurityException

getJobNames

public Set<String> getJobNames()
                        throws javax.batch.operations.JobSecurityException

Specified by:

getJobNames in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.JobSecurityException

getJobInstanceCount

public int getJobInstanceCount(String jobName)
                        throws javax.batch.operations.NoSuchJobException,
                               javax.batch.operations.JobSecurityException

Specified by:

getJobInstanceCount in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobException

javax.batch.operations.JobSecurityException

getJobInstances

public List<javax.batch.runtime.JobInstance> getJobInstances(String jobName,
                                                             int start,
                                                             int count)
                                                      throws javax.batch.operations.NoSuchJobException,
                                                             javax.batch.operations.JobSecurityException

Specified by:

getJobInstances in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobException

javax.batch.operations.JobSecurityException

getRunningExecutions

public List<Long> getRunningExecutions(String jobName)
                                throws javax.batch.operations.NoSuchJobException,
                                       javax.batch.operations.JobSecurityException

Specified by:

getRunningExecutions in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobException

javax.batch.operations.JobSecurityException

getParameters

public Properties getParameters(long executionId)
                         throws javax.batch.operations.NoSuchJobExecutionException,
                                javax.batch.operations.JobSecurityException

Specified by:

getParameters in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobExecutionException

javax.batch.operations.JobSecurityException

restart

public long restart(long executionId,
                    Properties restartParameters)
             throws javax.batch.operations.JobExecutionAlreadyCompleteException,
                    javax.batch.operations.NoSuchJobExecutionException,
                    javax.batch.operations.JobExecutionNotMostRecentException,
                    javax.batch.operations.JobRestartException,
                    javax.batch.operations.JobSecurityException

Specified by:

restart in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.JobExecutionAlreadyCompleteException

javax.batch.operations.NoSuchJobExecutionException

javax.batch.operations.JobExecutionNotMostRecentException

javax.batch.operations.JobRestartException

javax.batch.operations.JobSecurityException

restart

public long restart(long executionId,
                    Properties restartParameters,
                    String user)
             throws javax.batch.operations.JobExecutionAlreadyCompleteException,
                    javax.batch.operations.NoSuchJobExecutionException,
                    javax.batch.operations.JobExecutionNotMostRecentException,
                    javax.batch.operations.JobRestartException,
                    javax.batch.operations.JobSecurityException

Restarts a stopped or failed job with the specified user.

Parameters:

executionId - the execution id used for the restart, this must be the most recent execution

restartParameters - the new properties used for the restart

user - the user to associate with the job execution

Returns:

the new execution id

Throws:

javax.batch.operations.JobExecutionAlreadyCompleteException - if the job was already completed

javax.batch.operations.NoSuchJobExecutionException - the job does not exist

javax.batch.operations.JobExecutionNotMostRecentException - if the execution id is not the most recent execution

javax.batch.operations.JobRestartException - of the job failed to restart

javax.batch.operations.JobSecurityException - if failed to start the job due to security permission

abandon

public void abandon(long executionId)
             throws javax.batch.operations.NoSuchJobExecutionException,
                    javax.batch.operations.JobExecutionIsRunningException,
                    javax.batch.operations.JobSecurityException

Specified by:

abandon in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobExecutionException

javax.batch.operations.JobExecutionIsRunningException

javax.batch.operations.JobSecurityException

getJobInstance

public javax.batch.runtime.JobInstance getJobInstance(long executionId)
                                               throws javax.batch.operations.NoSuchJobExecutionException,
                                                      javax.batch.operations.JobSecurityException

Specified by:

getJobInstance in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobExecutionException

javax.batch.operations.JobSecurityException

getJobExecutions

public List<javax.batch.runtime.JobExecution> getJobExecutions(javax.batch.runtime.JobInstance instance)
                                                        throws javax.batch.operations.NoSuchJobInstanceException,
                                                               javax.batch.operations.JobSecurityException

Specified by:

getJobExecutions in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobInstanceException

javax.batch.operations.JobSecurityException

getJobExecution

public javax.batch.runtime.JobExecution getJobExecution(long executionId)
                                                 throws javax.batch.operations.NoSuchJobExecutionException,
                                                        javax.batch.operations.JobSecurityException

Specified by:

getJobExecution in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobExecutionException

javax.batch.operations.JobSecurityException

getStepExecutions

public List<javax.batch.runtime.StepExecution> getStepExecutions(long jobExecutionId)
                                                          throws javax.batch.operations.NoSuchJobExecutionException,
                                                                 javax.batch.operations.JobSecurityException

Specified by:

getStepExecutions in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobExecutionException

javax.batch.operations.JobSecurityException

getJobExecutionImpl

protected JobExecutionImpl getJobExecutionImpl(long executionId)
                                        throws javax.batch.operations.NoSuchJobExecutionException

Returns the job execution implementation found in the job repository.

Parameters:

executionId - the execution id

Returns:

the job execution implementation

Throws:

javax.batch.operations.NoSuchJobExecutionException - if the job was not found in the repository