org.springframework.xd.dirt.plugins.job

Class DistributedJobLocator

java.lang.Object

org.springframework.xd.dirt.plugins.job.DistributedJobLocator

All Implemented Interfaces:

org.springframework.batch.core.configuration.JobLocator, org.springframework.batch.core.configuration.ListableJobLocator

public class DistributedJobLocator
extends java.lang.Object
implements org.springframework.batch.core.configuration.ListableJobLocator

Implementation of ListableJobLocator used by DistributedJobService. This class also provides support methods to work with batch jobs in a distributed environment.

Author:

Ilayaperumal Gopinathan, Andrew Eisenberg

Constructor Summary

Constructors

Constructor and Description
DistributedJobLocator()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addJob(java.lang.String name, boolean incrementable, boolean restartable) Store the job name , job parameterer incrementable and job restartable flags for the job when there is a registry update
protected void	addStepNames(java.lang.String jobName, java.util.Collection<java.lang.String> stepNames) Add the collection of step names into XD_JOB_REGISTRY_STEP_NAMES for a given job.
protected void	deleteAll() Delete all the registry and step name entries.
protected void	deleteJobRegistry(java.lang.String jobName) Delete the job entry from the registry table.
java.util.Collection<java.lang.String>	getAllRestartableJobs() Get all the deployed job names that can be restarted.
org.springframework.jdbc.core.JdbcOperations	getJdbcTemplate()
org.springframework.batch.core.Job	getJob(java.lang.String name) Get simple batch job representation for the given job name.
java.util.Collection<java.lang.String>	getJobNames() Get all the deployed job names.
java.util.List<java.lang.String>	getJobStepNames(java.lang.String jobName) Get all the steps' names of a given job name.
java.lang.Boolean	isIncrementable(java.lang.String jobName)
java.lang.Boolean	isRestartable(java.lang.String jobName)
void	setJdbcTemplate(org.springframework.jdbc.core.JdbcOperations jdbcTemplate)

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributedJobLocator

public DistributedJobLocator()

Method Detail

getJobNames

public java.util.Collection<java.lang.String> getJobNames()

Get all the deployed job names.

Specified by:

getJobNames in interface org.springframework.batch.core.configuration.ListableJobLocator

getAllRestartableJobs

public java.util.Collection<java.lang.String> getAllRestartableJobs()

Get all the deployed job names that can be restarted.

Returns:

collection of job names.

getJob

public org.springframework.batch.core.Job getJob(java.lang.String name)
                                          throws org.springframework.batch.core.launch.NoSuchJobException

Get simple batch job representation for the given job name.

Specified by:

getJob in interface org.springframework.batch.core.configuration.JobLocator

Parameters:

name - the job name

Returns:

Job a simple batch job consisting of its step names.

Throws:

org.springframework.batch.core.launch.NoSuchJobException

getJobStepNames

public java.util.List<java.lang.String> getJobStepNames(java.lang.String jobName)

Get all the steps' names of a given job name.

Parameters:

jobName -

Returns:

the list of step names.

addJob

protected void addJob(java.lang.String name,
          boolean incrementable,
          boolean restartable)

Store the job name , job parameterer incrementable and job restartable flags for the job when there is a registry update

Parameters:

name - the job name to add

incrementable - flag to specify if the job parameter is incrementable

restartable - flag to specify if the job is restartable

addStepNames

protected void addStepNames(java.lang.String jobName,
                java.util.Collection<java.lang.String> stepNames)

Add the collection of step names into XD_JOB_REGISTRY_STEP_NAMES for a given job.

Parameters:

jobName - the job name

stepNames - the collection of step names associated with this job

deleteJobRegistry

protected void deleteJobRegistry(java.lang.String jobName)

Delete the job entry from the registry table. This will delete job registry and the associated step names entries for the given job name.

Parameters:

jobName - the job name.

deleteAll

protected void deleteAll()

Delete all the registry and step name entries.

isIncrementable

public java.lang.Boolean isIncrementable(java.lang.String jobName)

Parameters:

jobName - the job name

Returns:

Boolean flag to specify if the job parameter can be incremented for the given job name.

isRestartable

public java.lang.Boolean isRestartable(java.lang.String jobName)

Parameters:

jobName - the job name

Returns:

Boolean flag to specify if the job can be restarted.

getJdbcTemplate

public org.springframework.jdbc.core.JdbcOperations getJdbcTemplate()

setJdbcTemplate

public void setJdbcTemplate(org.springframework.jdbc.core.JdbcOperations jdbcTemplate)