| java.lang.Object
 org.springframework.orm.ibatis.SqlMapClientFactoryBean
| SqlMapClientFactoryBean | | public SqlMapClientFactoryBean()(Code) | | |
| applyTransactionConfig | | protected void applyTransactionConfig(SqlMapClient sqlMapClient, TransactionConfig transactionConfig)(Code) | | Apply the given iBATIS TransactionConfig to the SqlMapClient.
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.
Parameters:
sqlMapClient - the SqlMapClient to apply the TransactionConfig to
Parameters:
transactionConfig - the iBATIS TransactionConfig to apply
See Also: com.ibatis.sqlmap.engine.impl.ExtendedSqlMapClient
See Also: com.ibatis.sqlmap.engine.impl.SqlMapExecutorDelegate.getMaxTransactions
See Also: com.ibatis.sqlmap.engine.impl.SqlMapExecutorDelegate.setTxManager |
| buildSqlMapClient | | protected SqlMapClient buildSqlMapClient(Resource configLocation, Properties properties) throws IOException(Code) | | Build a SqlMapClient instance based on the given standard configuration.
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).
Parameters:
configLocation - the config file to load from
Parameters:
properties - the SqlMapClient properties (if any) the SqlMapClient instance (never null)
throws:
IOException - if loading the config file failed
See Also: com.ibatis.sqlmap.client.SqlMapClientBuilder.buildSqlMapClient |
| isSingleton | | public boolean isSingleton()(Code) | | |
| setConfigLocation | | public void setConfigLocation(Resource configLocation)(Code) | | Set the location of the iBATIS SqlMapClient config file.
A typical value is "WEB-INF/sql-map-config.xml".
|
| setDataSource | | public void setDataSource(DataSource dataSource)(Code) | | Set the DataSource to be used by iBATIS SQL Maps. This will be passed to the
SqlMapClient as part of a TransactionConfig instance.
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!
See Also: SqlMapClientFactoryBean.setTransactionConfigClass
See Also: SqlMapClientFactoryBean.setTransactionConfigProperties
See Also: com.ibatis.sqlmap.client.SqlMapClient.getDataSource
See Also: SqlMapClientTemplate.setDataSource
See Also: SqlMapClientTemplate.queryForPaginatedList |
| setSqlMapClientProperties | | public void setSqlMapClientProperties(Properties sqlMapClientProperties)(Code) | | Set optional properties to be passed into the SqlMapClientBuilder, as
alternative to a <properties> tag in the sql-map-config.xml
file. Will be used to resolve placeholders in the config file.
See Also: SqlMapClientFactoryBean.setConfigLocation
See Also: com.ibatis.sqlmap.client.SqlMapClientBuilder.buildSqlMapClient(java.io.Readerjava.util.Properties) |
| setTransactionConfigClass | | public void setTransactionConfigClass(Class transactionConfigClass)(Code) | | Set the iBATIS TransactionConfig class to use. Default is
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.
See Also: SqlMapClientFactoryBean.setDataSource
See Also: SqlMapClientFactoryBean.setTransactionConfigProperties
See Also: com.ibatis.sqlmap.engine.transaction.TransactionConfig
See Also: com.ibatis.sqlmap.engine.transaction.external.ExternalTransactionConfig
See Also: com.ibatis.sqlmap.engine.transaction.jdbc.JdbcTransactionConfig
See Also: com.ibatis.sqlmap.engine.transaction.jta.JtaTransactionConfig
See Also: com.ibatis.sqlmap.client.SqlMapTransactionManager |
| setTransactionConfigProperties | | public void setTransactionConfigProperties(Properties transactionConfigProperties)(Code) | | Set properties to be passed to the TransactionConfig instance used
by this SqlMapClient. Supported properties depend on the concrete
TransactionConfig implementation used:
- ExternalTransactionConfig supports "DefaultAutoCommit"
(default: false) and "SetAutoCommitAllowed" (default: true).
Note that Spring uses SetAutoCommitAllowed = false as default,
in contrast to the iBATIS default, to always keep the original
autoCommit value as provided by the connection pool.
- JdbcTransactionConfig does not supported any properties.
- JtaTransactionConfig supports "UserTransaction"
(no default), specifying the JNDI location of the JTA UserTransaction
(usually "java:comp/UserTransaction").
See Also: com.ibatis.sqlmap.engine.transaction.TransactionConfig.initialize
See Also: com.ibatis.sqlmap.engine.transaction.external.ExternalTransactionConfig
See Also: com.ibatis.sqlmap.engine.transaction.jdbc.JdbcTransactionConfig
See Also: com.ibatis.sqlmap.engine.transaction.jta.JtaTransactionConfig |
| setUseTransactionAwareDataSource | | public void setUseTransactionAwareDataSource(boolean useTransactionAwareDataSource)(Code) | | Set whether to use a transaction-aware DataSource for the SqlMapClient,
i.e. whether to automatically wrap the passed-in DataSource with Spring's
TransactionAwareDataSourceProxy.
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.
See Also: SqlMapClientFactoryBean.setDataSource
See Also: org.springframework.jdbc.datasource.TransactionAwareDataSourceProxy
See Also: org.springframework.jdbc.datasource.DataSourceTransactionManager
See Also: SqlMapClientTemplate
See Also: com.ibatis.sqlmap.client.SqlMapClient |
|
|