org.springframework.jca.cci.core.support
Class CciDaoSupport

java.lang.Object
  extended by org.springframework.jca.cci.core.support.CciDaoSupport
All Implemented Interfaces:
InitializingBean

public abstract class CciDaoSupport
extends Object
implements InitializingBean

Convenient super class for CCI data access objects. Requires a ConnectionFactory to be set, providing a CciTemplate based on it to subclasses.

This base class is mainly intended for CciTemplate usage but can also be used when working with ConnectionFactoryUtils directly or with org.springframework.cci.object classes.

Since:
1.2
Author:
Thierry Templier, Juergen Hoeller
See Also:
setConnectionFactory(javax.resource.cci.ConnectionFactory), CciTemplate, ConnectionFactoryUtils

Field Summary
protected  Log logger
           
 
Constructor Summary
CciDaoSupport()
           
 
Method Summary
 void afterPropertiesSet()
          Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
protected  CciTemplate createCciTemplate(ConnectionFactory connectionFactory)
          Create a CciTemplate for the given ConnectionFactory.
 CciTemplate getCciTemplate()
          Return the CciTemplate for this DAO, pre-initialized with the ConnectionFactory or set explicitly.
protected  Connection getConnection()
          Get a CCI Connection, either from the current transaction or a new one.
 ConnectionFactory getConnectionFactory()
          Return the ConnectionFactory used by this DAO.
protected  void initDao()
          Subclasses can override this for custom initialization behavior.
protected  void releaseConnection(Connection con)
          Close the given CCI Connection, created via this bean's ConnectionFactory, if it isn't bound to the thread.
 void setCciTemplate(CciTemplate cciTemplate)
          Set the CciTemplate for this DAO explicitly, as an alternative to specifying a ConnectionFactory.
 void setConnectionFactory(ConnectionFactory connectionFactory)
          Set the ConnectionFactory to be used by this DAO.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

protected final Log logger
Constructor Detail

CciDaoSupport

public CciDaoSupport()
Method Detail

setConnectionFactory

public final void setConnectionFactory(ConnectionFactory connectionFactory)
Set the ConnectionFactory to be used by this DAO.


createCciTemplate

protected CciTemplate createCciTemplate(ConnectionFactory connectionFactory)
Create a CciTemplate for the given ConnectionFactory. Only invoked if populating the DAO with a ConnectionFactory reference!

Can be overridden in subclasses to provide a CciTemplate instance with different configuration, or a custom CciTemplate subclass.

Parameters:
connectionFactory - the CCI ConnectionFactory to create a CciTemplate for
Returns:
the new CciTemplate instance
See Also:
setConnectionFactory(javax.resource.cci.ConnectionFactory)

getConnectionFactory

public final ConnectionFactory getConnectionFactory()
Return the ConnectionFactory used by this DAO.


setCciTemplate

public final void setCciTemplate(CciTemplate cciTemplate)
Set the CciTemplate for this DAO explicitly, as an alternative to specifying a ConnectionFactory.


getCciTemplate

public final CciTemplate getCciTemplate()
Return the CciTemplate for this DAO, pre-initialized with the ConnectionFactory or set explicitly.


afterPropertiesSet

public final void afterPropertiesSet()
                              throws Exception
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:
Exception - in the event of misconfiguration (such as failure to set an essential property) or if initialization fails.

initDao

protected void initDao()
                throws Exception
Subclasses can override this for custom initialization behavior. Gets called after population of this instance's bean properties.

Throws:
Exception - if initialization fails

getConnection

protected final Connection getConnection()
                                  throws CannotGetCciConnectionException
Get a CCI Connection, either from the current transaction or a new one.

Returns:
the CCI Connection
Throws:
CannotGetCciConnectionException - if the attempt to get a Connection failed
See Also:
ConnectionFactoryUtils.getConnection(javax.resource.cci.ConnectionFactory)

releaseConnection

protected final void releaseConnection(Connection con)
Close the given CCI Connection, created via this bean's ConnectionFactory, if it isn't bound to the thread.

Parameters:
con - Connection to close
See Also:
ConnectionFactoryUtils.releaseConnection(javax.resource.cci.Connection, javax.resource.cci.ConnectionFactory)


Copyright (c) 2002-2005 The Spring Framework Project.