cloud.altemista.fwk.core.batch

Interface BatchService

public interface BatchService

Main interface for the batch module.

Author:

NTT DATA

Method Summary

Modifier and Type	Method and Description
javax.batch.runtime.JobExecution	abandon(long executionId) Marks the job execution as abandoned.
int	countJobInstances(String jobName) Count the number of job instances in the repository for a given job name.
int	countJobs() Count the number of currently registered job names
List<javax.batch.runtime.JobExecution>	getExecutions(long instanceId) List the job executions associated with a particular job instance.
List<BatchParameter<?>>	getParameters(long executionId) Get the job parameters used by a particular job execution
List<javax.batch.runtime.JobExecution>	getRunningExecutions(String jobname) List the running job executions for a given job name.
boolean	isLaunchable(String jobName) Convenience method to determine if a job is available for launching
boolean	isLaunchableNextInstance(String jobName) Convenience method to determine if a job is available for launching as a sequence of instances.
Long	launch(String jobName, BatchParameter<?>... parameters) Launch a job with the parameters provided.
Long	launchNextInstance(String jobName) Launch the next in a sequence of instances.
List<Long>	listJobInstances(String jobName, int start, int count) List a page of job instances for a given job name.
List<String>	listJobs(int start, int count) List a page of currently registered job names
Long	restart(long executionId) Restarts a stopped job execution.
boolean	stop(long executionId) Send a stop signal to a running job execution

Method Detail

countJobs

int countJobs()

Count the number of currently registered job names

Returns:

the number of currently registered job names

listJobs

List<String> listJobs(int start,
                      int count)

List a page of currently registered job names

Parameters:

start - the start index of the instances to return

count - the maximum number of instances to return

Returns:

the registered job names up to a maximum of count values

isLaunchable

boolean isLaunchable(String jobName)

Convenience method to determine if a job is available for launching

Parameters:

jobName - the name of the job

Returns:

true if the job is available for launching

launch

Long launch(String jobName,
            BatchParameter<?>... parameters)

Launch a job with the parameters provided. If an instance with the parameters provided has already failed (and is not abandoned) it will be restarted.

Parameters:

jobName - the name of the job

parameters - the BatchParameter

Returns:

the resulting execution ID if successful

isLaunchableNextInstance

boolean isLaunchableNextInstance(String jobName)

Convenience method to determine if a job is available for launching as a sequence of instances.

Parameters:

jobName - the name of the job

Returns:

true if the job is available for launching as a sequence of instances

launchNextInstance

Long launchNextInstance(String jobName)

Launch the next in a sequence of instances.

Parameters:

jobName - the name of the job

Returns:

the resulting execution ID if successful

countJobInstances

int countJobInstances(String jobName)

Count the number of job instances in the repository for a given job name.

Parameters:

jobName - the name of the job

Returns:

the number of currently registered job instances

listJobInstances

List<Long> listJobInstances(String jobName,
                            int start,
                            int count)

List a page of job instances for a given job name.

Parameters:

jobName - the name of the job

start - the start index of the instances to return

count - the maximum number of instances to return

Returns:

the registered job instances up to a maximum of count values

getExecutions

List<javax.batch.runtime.JobExecution> getExecutions(long instanceId)

List the job executions associated with a particular job instance.

Parameters:

instanceId - the id of the job instance

Returns:

the job executions associated with the job instance

getRunningExecutions

List<javax.batch.runtime.JobExecution> getRunningExecutions(String jobname)

List the running job executions for a given job name.

Parameters:

jobname - the name of the job

Returns:

the running job executions for the given job name

getParameters

List<BatchParameter<?>> getParameters(long executionId)

Get the job parameters used by a particular job execution

Parameters:

executionId - the id of the job execution

Returns:

the job parameters used by the job execution

stop

boolean stop(long executionId)

Send a stop signal to a running job execution

Parameters:

executionId - the id of the job execution

Returns:

true if the message was successfully sent; false otherwise, or if the job execution did not exist or was not running

restart

Long restart(long executionId)

Restarts a stopped job execution.

Parameters:

executionId - the if of the job execution

Returns:

the resulting execution ID if successful; false otherwise, or if the job execution did not exist or was not stopped

abandon

javax.batch.runtime.JobExecution abandon(long executionId)

Marks the job execution as abandoned.

Parameters:

executionId - the if of the job execution

Returns:

the job execution that was aborted, or null if the job execution was not stopped first