org.springframework.batch.core.configuration.support
Class ClassPathXmlJobRegistry

java.lang.Object
  org.springframework.batch.core.configuration.support.ClassPathXmlJobRegistry

All Implemented Interfaces:

JobLocator, JobRegistry, ListableJobRegistry, InitializingBean, ApplicationContextAware

public class ClassPathXmlJobRegistry
extends Object
implements ListableJobRegistry, ApplicationContextAware, InitializingBean

Implementation of the ListableJobRegistry interface that assumes all Jobs will be loaded from ClassPathXml resources.

Since:

2.0

Author:

Lucas Ward, Dave Syer

Constructor Summary

ClassPathXmlJobRegistry()

Method Summary

void	afterPropertiesSet()
Job	getJob(String name) Locates a Job at runtime.
Collection<String>	getJobNames() Provides the currently registered job names.
void	register(JobFactory jobFactory) Registers a Job at runtime.
void	setApplicationContext(ApplicationContext applicationContext)
void	setJobPaths(Resource[] jobPaths)
void	unregister(String jobName) Unregisters a previously registered Job.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPathXmlJobRegistry

public ClassPathXmlJobRegistry()

Method Detail

setJobPaths

public void setJobPaths(Resource[] jobPaths)

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

getJob

public Job getJob(String name)
           throws NoSuchJobException

Description copied from interface: JobLocator

Locates a Job at runtime.

Specified by:

getJob in interface JobLocator

Parameters:

name - the name of the Job which should be unique

Returns:

a Job identified by the given name

Throws:

NoSuchJobException - if the required configuration can not be found.

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

getJobNames

public Collection<String> getJobNames()

Description copied from interface: ListableJobRegistry

Provides the currently registered job names. The return value is unmodifiable and disconnected from the underlying registry storage.

Specified by:

getJobNames in interface ListableJobRegistry

Returns:

a collection of String. Empty if none are registered.

register

public void register(JobFactory jobFactory)
              throws DuplicateJobException

Description copied from interface: JobRegistry

Registers a Job at runtime.

Specified by:

register in interface JobRegistry

Parameters:

jobFactory - the Job to be registered

Throws:

DuplicateJobException - if a factory with the same job name has already been registered.

unregister

public void unregister(String jobName)

Description copied from interface: JobRegistry

Unregisters a previously registered Job. If it was not previously registered there is no error.

Specified by:

unregister in interface JobRegistry

Parameters:

jobName - the Job to unregister.