Package org.springframework.batch.core.explore.support

Class JobExplorerFactoryBean

java.lang.Object

org.springframework.batch.core.explore.support.AbstractJobExplorerFactoryBean

org.springframework.batch.core.explore.support.JobExplorerFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.FactoryBean<JobExplorer>, org.springframework.beans.factory.InitializingBean

public class JobExplorerFactoryBean
extends AbstractJobExplorerFactoryBean
implements org.springframework.beans.factory.InitializingBean

A FactoryBean that automates the creation of a SimpleJobExplorer by using JDBC DAO implementations. Requires the user to describe what kind of database they use.

Since:

2.0

Author:

Dave Syer, Mahmoud Ben Hassine

Field Summary

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
JobExplorerFactoryBean()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected ExecutionContextDao	createExecutionContextDao()	Creates an execution context instance data access object (DAO).
protected JobExecutionDao	createJobExecutionDao()	Creates a job execution data access object (DAO).
protected JobInstanceDao	createJobInstanceDao()	Creates a job instance data access object (DAO).
protected StepExecutionDao	createStepExecutionDao()	Creates a step execution data access object (DAO).
void	setCharset(Charset charset)	Sets the Charset to use when deserializing the execution context.
void	setConversionService(org.springframework.core.convert.support.ConfigurableConversionService conversionService)	Set the conversion service to use in the job explorer.
void	setDataSource(DataSource dataSource)	Sets the data source.
void	setJdbcOperations(org.springframework.jdbc.core.JdbcOperations jdbcOperations)	Public setter for the JdbcOperations.
void	setJobKeyGenerator(JobKeyGenerator jobKeyGenerator)	* Sets the generator for creating the key used in identifying unique {link JobInstance} objects
void	setLobHandler(org.springframework.jdbc.support.lob.LobHandler lobHandler)	The lob handler to use when saving ExecutionContext instances.
void	setSerializer(ExecutionContextSerializer serializer)	A custom implementation of ExecutionContextSerializer.
void	setTablePrefix(String tablePrefix)	Sets the table prefix for all the batch metadata tables.

Methods inherited from class org.springframework.batch.core.explore.support.AbstractJobExplorerFactoryBean

getObject, getObjectType, getTransactionManager, isSingleton, setTransactionAttributeSource, setTransactionManager

Methods inherited from class java.lang.Object

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

Constructor Details

JobExplorerFactoryBean

public JobExplorerFactoryBean()

Method Details

setSerializer

public void setSerializer(ExecutionContextSerializer serializer)

A custom implementation of ExecutionContextSerializer. The default, if not injected, is the DefaultExecutionContextSerializer.

Parameters:

serializer - The serializer used to serialize or deserialize an ExecutionContext.

See Also:

• ExecutionContextSerializer

setDataSource

public void setDataSource(DataSource dataSource)

Sets the data source.

Public setter for the DataSource.

Parameters:

dataSource - A DataSource.

setJdbcOperations

public void setJdbcOperations(org.springframework.jdbc.core.JdbcOperations jdbcOperations)

Public setter for the JdbcOperations. If this property is not explicitly set, a new JdbcTemplate is created, by default, for the configured DataSource.

Parameters:

jdbcOperations - a JdbcOperations

setTablePrefix

public void setTablePrefix(String tablePrefix)

Sets the table prefix for all the batch metadata tables.

Parameters:

tablePrefix - The table prefix for the batch metadata tables.

setJobKeyGenerator

public void setJobKeyGenerator(JobKeyGenerator jobKeyGenerator)

* Sets the generator for creating the key used in identifying unique {link JobInstance} objects

Parameters:

jobKeyGenerator - a JobKeyGenerator

Since:

5.1

setLobHandler

public void setLobHandler(org.springframework.jdbc.support.lob.LobHandler lobHandler)

The lob handler to use when saving ExecutionContext instances. Defaults to null, which works for most databases.

Parameters:

lobHandler - Large object handler for saving an ExecutionContext.

setCharset

public void setCharset(@NonNull
 Charset charset)

Sets the Charset to use when deserializing the execution context. Defaults to "UTF-8". Must not be null.

Parameters:

charset - The character set to use when deserializing the execution context.

Since:

5.0

See Also:

• JdbcExecutionContextDao.setCharset(Charset)

setConversionService

public void setConversionService(@NonNull
 org.springframework.core.convert.support.ConfigurableConversionService conversionService)

Set the conversion service to use in the job explorer. This service is used to convert job parameters from String literal to typed values and vice versa.

Parameters:

conversionService - the conversion service to use

Since:

5.0

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Overrides:

afterPropertiesSet in class AbstractJobExplorerFactoryBean

Throws:

Exception

createExecutionContextDao

protected ExecutionContextDao createExecutionContextDao()
                                                 throws Exception

Description copied from class: AbstractJobExplorerFactoryBean

Creates an execution context instance data access object (DAO).

Specified by:

createExecutionContextDao in class AbstractJobExplorerFactoryBean

Returns:

fully configured ExecutionContextDao implementation.

Throws:

Exception - thrown if error occurs during ExecutionContextDao creation.

createJobInstanceDao

protected JobInstanceDao createJobInstanceDao()
                                       throws Exception

Description copied from class: AbstractJobExplorerFactoryBean

Creates a job instance data access object (DAO).

Specified by:

createJobInstanceDao in class AbstractJobExplorerFactoryBean

Returns:

a fully configured JobInstanceDao implementation.

Throws:

Exception - thrown if error occurs during JobInstanceDao creation.

createJobExecutionDao

protected JobExecutionDao createJobExecutionDao()
                                         throws Exception

Description copied from class: AbstractJobExplorerFactoryBean

Creates a job execution data access object (DAO).

Specified by:

createJobExecutionDao in class AbstractJobExplorerFactoryBean

Returns:

a fully configured JobExecutionDao implementation.

Throws:

Exception - thrown if error occurs during JobExecutionDao creation.

createStepExecutionDao

protected StepExecutionDao createStepExecutionDao()
                                           throws Exception

Description copied from class: AbstractJobExplorerFactoryBean

Creates a step execution data access object (DAO).

Specified by:

createStepExecutionDao in class AbstractJobExplorerFactoryBean

Returns:

a fully configured StepExecutionDao implementation.

Throws:

Exception - thrown if error occurs during StepExecutionDao creation.