public class SqlMapClientFactoryBean
extends java.lang.Object
implements org.springframework.beans.factory.FactoryBean<com.ibatis.sqlmap.client.SqlMapClient>, org.springframework.beans.factory.InitializingBean
FactoryBean
that creates an
iBATIS SqlMapClient
. This is the usual
way to set up a shared iBATIS SqlMapClient in a Spring application context;
the SqlMapClient can then be passed to iBATIS-based DAOs via dependency
injection.
Either DataSourceTransactionManager
or JtaTransactionManager
can be
used for transaction demarcation in combination with a SqlMapClient,
with JTA only necessary for transactions which span multiple databases.
Allows for specifying 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 in every DAO.
Note: As of Spring 2.5.5, this class (finally) requires iBATIS 2.3 or higher. The new "mappingLocations" feature requires iBATIS 2.3.2.
setConfigLocation(org.springframework.core.io.Resource)
,
setDataSource(javax.sql.DataSource)
,
SqlMapClientTemplate.setSqlMapClient(com.ibatis.sqlmap.client.SqlMapClient)
,
JdbcAccessor.setDataSource(javax.sql.DataSource)
Constructor and Description |
---|
SqlMapClientFactoryBean() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet() |
protected void |
applyTransactionConfig(com.ibatis.sqlmap.client.SqlMapClient sqlMapClient,
com.ibatis.sqlmap.engine.transaction.TransactionConfig transactionConfig)
Apply the given iBATIS TransactionConfig to the SqlMapClient.
|
protected com.ibatis.sqlmap.client.SqlMapClient |
buildSqlMapClient(org.springframework.core.io.Resource[] configLocations,
org.springframework.core.io.Resource[] mappingLocations,
java.util.Properties properties)
Build a SqlMapClient instance based on the given standard configuration.
|
static org.springframework.jdbc.support.lob.LobHandler |
getConfigTimeLobHandler()
Return the LobHandler for the currently configured iBATIS SqlMapClient,
to be used by TypeHandler implementations like ClobStringTypeHandler.
|
com.ibatis.sqlmap.client.SqlMapClient |
getObject() |
java.lang.Class<? extends com.ibatis.sqlmap.client.SqlMapClient> |
getObjectType() |
boolean |
isSingleton() |
void |
setConfigLocation(org.springframework.core.io.Resource configLocation)
Set the location of the iBATIS SqlMapClient config file.
|
void |
setConfigLocations(org.springframework.core.io.Resource[] configLocations)
Set multiple locations of iBATIS SqlMapClient config files that
are going to be merged into one unified configuration at runtime.
|
void |
setDataSource(javax.sql.DataSource dataSource)
Set the DataSource to be used by iBATIS SQL Maps.
|
void |
setLobHandler(org.springframework.jdbc.support.lob.LobHandler lobHandler)
Set the LobHandler to be used by the SqlMapClient.
|
void |
setMappingLocations(org.springframework.core.io.Resource[] mappingLocations)
Set locations of iBATIS sql-map mapping files that are going to be
merged into the SqlMapClient configuration at runtime.
|
void |
setSqlMapClientProperties(java.util.Properties sqlMapClientProperties)
Set optional properties to be passed into the SqlMapClientBuilder, as
alternative to a
<properties> tag in the sql-map-config.xml
file. |
void |
setTransactionConfigClass(java.lang.Class transactionConfigClass)
Set the iBATIS TransactionConfig class to use.
|
void |
setTransactionConfigProperties(java.util.Properties transactionConfigProperties)
Set properties to be passed to the TransactionConfig instance used
by this SqlMapClient.
|
void |
setUseTransactionAwareDataSource(boolean useTransactionAwareDataSource)
Set whether to use a transaction-aware DataSource for the SqlMapClient,
i.e.
|
public static org.springframework.jdbc.support.lob.LobHandler getConfigTimeLobHandler()
This instance will be set before initialization of the corresponding SqlMapClient, and reset immediately afterwards. It is thus only available during configuration.
public void setConfigLocation(org.springframework.core.io.Resource configLocation)
public void setConfigLocations(org.springframework.core.io.Resource[] configLocations)
public void setMappingLocations(org.springframework.core.io.Resource[] mappingLocations)
This is an alternative to specifying "<sqlMap>" entries in a sql-map-client config file. This property being based on Spring's resource abstraction also allows for specifying resource patterns here: e.g. "/myApp/*-map.xml".
Note that this feature requires iBATIS 2.3.2; it will not work with any previous iBATIS version.
public void setSqlMapClientProperties(java.util.Properties sqlMapClientProperties)
<properties>
tag in the sql-map-config.xml
file. Will be used to resolve placeholders in the config file.setConfigLocation(org.springframework.core.io.Resource)
,
SqlMapClientBuilder.buildSqlMapClient(java.io.InputStream, java.util.Properties)
public void setDataSource(javax.sql.DataSource dataSource)
If specified, this will override corresponding settings in the SqlMapClient properties. Usually, you will specify DataSource and transaction configuration either here or in 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!
setTransactionConfigClass(java.lang.Class)
,
setTransactionConfigProperties(java.util.Properties)
,
SqlMapTransactionManager.getDataSource()
,
JdbcAccessor.setDataSource(javax.sql.DataSource)
public void setUseTransactionAwareDataSource(boolean useTransactionAwareDataSource)
Default is "true": When the SqlMapClient performs direct database operations outside of Spring's SqlMapClientTemplate (for example, lazy loading or direct SqlMapClient access), it will still participate in active Spring-managed transactions.
As a further effect, using a transaction-aware DataSource will apply remaining transaction timeouts to all created JDBC Statements. This means that all operations performed by the SqlMapClient will automatically participate in Spring-managed transaction timeouts.
Turn this flag off to get raw DataSource handling, without Spring transaction checks. Operations on Spring's SqlMapClientTemplate will still detect Spring-managed transactions, but lazy loading or direct SqlMapClient access won't.
setDataSource(javax.sql.DataSource)
,
TransactionAwareDataSourceProxy
,
DataSourceTransactionManager
,
SqlMapClientTemplate
,
SqlMapClient
public void setTransactionConfigClass(java.lang.Class transactionConfigClass)
com.ibatis.sqlmap.engine.transaction.external.ExternalTransactionConfig
.
Will only get applied when using a Spring-managed DataSource. An instance of this class will get populated with the given DataSource and initialized with the given properties.
The default ExternalTransactionConfig is appropriate if there is external transaction management that the SqlMapClient should participate in: be it Spring transaction management, EJB CMT or plain JTA. This should be the typical scenario. If there is no active transaction, SqlMapClient operations will execute SQL statements non-transactionally.
JdbcTransactionConfig or JtaTransactionConfig is only necessary when using the iBATIS SqlMapTransactionManager API instead of external transactions. If there is no explicit transaction, SqlMapClient operations will automatically start a transaction for their own scope (in contrast to the external transaction mode, see above).
It is strongly recommended to use iBATIS SQL Maps with Spring transaction management (or EJB CMT). In this case, the default ExternalTransactionConfig is fine. Lazy loading and SQL Maps operations without explicit transaction demarcation will execute non-transactionally.
Even with Spring transaction management, it might be desirable to specify JdbcTransactionConfig: This will still participate in existing Spring-managed transactions, but lazy loading and operations without explicit transaction demaration will execute in their own auto-started transactions. However, this is usually not necessary.
setDataSource(javax.sql.DataSource)
,
setTransactionConfigProperties(java.util.Properties)
,
TransactionConfig
,
ExternalTransactionConfig
,
com.ibatis.sqlmap.engine.transaction.jdbc.JdbcTransactionConfig
,
com.ibatis.sqlmap.engine.transaction.jta.JtaTransactionConfig
,
SqlMapTransactionManager
public void setTransactionConfigProperties(java.util.Properties transactionConfigProperties)
TransactionConfig.initialize(java.util.Properties)
,
ExternalTransactionConfig
,
com.ibatis.sqlmap.engine.transaction.jdbc.JdbcTransactionConfig
,
com.ibatis.sqlmap.engine.transaction.jta.JtaTransactionConfig
public void setLobHandler(org.springframework.jdbc.support.lob.LobHandler lobHandler)
getConfigTimeLobHandler()
,
TypeHandler
,
ClobStringTypeHandler
,
BlobByteArrayTypeHandler
,
BlobSerializableTypeHandler
public void afterPropertiesSet() throws java.lang.Exception
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
java.lang.Exception
protected com.ibatis.sqlmap.client.SqlMapClient buildSqlMapClient(org.springframework.core.io.Resource[] configLocations, org.springframework.core.io.Resource[] mappingLocations, java.util.Properties properties) throws java.io.IOException
The default implementation uses the standard iBATIS SqlMapClientBuilder
API to build a SqlMapClient instance based on an InputStream (if possible,
on iBATIS 2.3 and higher) or on a Reader (on iBATIS up to version 2.2).
configLocations
- the config files to load fromproperties
- the SqlMapClient properties (if any)null
)java.io.IOException
- if loading the config file failedSqlMapClientBuilder.buildSqlMapClient(java.io.Reader)
protected void applyTransactionConfig(com.ibatis.sqlmap.client.SqlMapClient sqlMapClient, com.ibatis.sqlmap.engine.transaction.TransactionConfig transactionConfig)
The default implementation casts to ExtendedSqlMapClient, retrieves the maximum number of concurrent transactions from the SqlMapExecutorDelegate, and sets an iBATIS TransactionManager with the given TransactionConfig.
sqlMapClient
- the SqlMapClient to apply the TransactionConfig totransactionConfig
- the iBATIS TransactionConfig to applyExtendedSqlMapClient
,
SqlMapExecutorDelegate.getMaxTransactions()
,
SqlMapExecutorDelegate.setTxManager(com.ibatis.sqlmap.engine.transaction.TransactionManager)
public com.ibatis.sqlmap.client.SqlMapClient getObject()
getObject
in interface org.springframework.beans.factory.FactoryBean<com.ibatis.sqlmap.client.SqlMapClient>
public java.lang.Class<? extends com.ibatis.sqlmap.client.SqlMapClient> getObjectType()
getObjectType
in interface org.springframework.beans.factory.FactoryBean<com.ibatis.sqlmap.client.SqlMapClient>
public boolean isSingleton()
isSingleton
in interface org.springframework.beans.factory.FactoryBean<com.ibatis.sqlmap.client.SqlMapClient>