org.springframework.orm.ibatis
Class SqlMapClientFactoryBean

java.lang.Object
  org.springframework.orm.ibatis.SqlMapClientFactoryBean

All Implemented Interfaces:

FactoryBean, InitializingBean

public class SqlMapClientFactoryBean

extends Object

implements FactoryBean, InitializingBean

FactoryBean that creates an iBATIS Database Layer SqlMapClient as singleton in the current bean factory, possibly for use with SqlMapClientTemplate.

Allows to specify a DataSource at the SqlMapClient level. This is preferable to per-DAO DataSource references, as it allows for lazy loading and avoids repeated DataSource references.

NOTE: The SqlMapClient/SqlMapSession API is the API of iBATIS SQL Maps 2. With SQL Maps 1.x, the SqlMap/MappedStatement API has to be used.

Since:

24.02.2004

Author:

Juergen Hoeller

See Also:

setConfigLocation(org.springframework.core.io.Resource), setDataSource(javax.sql.DataSource), SqlMapClientTemplate.setSqlMapClient(com.ibatis.sqlmap.client.SqlMapClient), JdbcAccessor.setDataSource(javax.sql.DataSource)

Constructor Summary

SqlMapClientFactoryBean()

Method Summary

void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
Object	getObject() Return an instance (possibly shared or independent) of the object managed by this factory.
Class	getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean	isSingleton() Is the bean managed by this factory a singleton or a prototype?
void	setConfigLocation(Resource configLocation) Set the location of the iBATIS SqlMapClient config file.
void	setDataSource(DataSource dataSource) Set the DataSource to be used by the SqlMapClient.
void	setSqlMapClientProperties(Properties sqlMapClientProperties) Set optional properties to be passed into the SqlMapClientBuilder.

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlMapClientFactoryBean

public SqlMapClientFactoryBean()

Method Detail

setConfigLocation

public void setConfigLocation(Resource configLocation)

Set the location of the iBATIS SqlMapClient config file. A typical value is "WEB-INF/sql-map-config.xml".

setSqlMapClientProperties

public void setSqlMapClientProperties(Properties sqlMapClientProperties)

Set optional properties to be passed into the SqlMapClientBuilder.

See Also:

SqlMapClientBuilder.buildSqlMapClient(java.io.Reader, java.util.Properties)

setDataSource

public void setDataSource(DataSource dataSource)

Set the DataSource to be used by the SqlMapClient. If specified, this will override corresponding settings in the SqlMapClient properties.

Specifying a DataSource for the SqlMapClient rather than for each individual DAO allows for lazy loading, for example when using PaginatedList results.

With a DataSource passed in here, you don't need to specify one for each DAO. Passing the SqlMapClient to the DAOs is enough, as it already carries a DataSource. Thus, it's recommended to specify the DataSource at this central location only.

Thanks to Brandon Goodin from the iBATIS team for the hint on how to make this work with Spring's integration strategy!

See Also:

SqlMapTransactionManager.getDataSource(), JdbcAccessor.setDataSource(javax.sql.DataSource), SqlMapClientTemplate.queryForPaginatedList(java.lang.String, java.lang.Object, int)

afterPropertiesSet

public void afterPropertiesSet()
                        throws IOException

Description copied from interface: InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

IOException

getObject

public Object getObject()

Description copied from interface: FactoryBean

Return an instance (possibly shared or independent) of the object managed by this factory. As with a BeanFactory, this allows support for both the Singleton and Prototype design pattern.

Specified by:

getObject in interface FactoryBean

Returns:

an instance of the bean (should never be null)

getObjectType

public Class getObjectType()

Description copied from interface: FactoryBean

Return the type of object that this FactoryBean creates, or null if not known in advance. This allows to check for specific types of beans without instantiating objects, for example on autowiring.

For a singleton, this should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

NOTE: Autowiring will simply ignore FactoryBeans that return null here. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Specified by:

getObjectType in interface FactoryBean

Returns:

the type of object that this FactoryBean creates, or null if not known at the time of the call

See Also:

ListableBeanFactory.getBeansOfType(java.lang.Class)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the bean managed by this factory a singleton or a prototype? That is, will getObject() always return the same object?

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

Specified by:

isSingleton in interface FactoryBean

Returns:

if this bean is a singleton