org.springframework.jca.support
Class LocalConnectionFactoryBean

java.lang.Object
  org.springframework.jca.support.LocalConnectionFactoryBean

All Implemented Interfaces:

FactoryBean, InitializingBean

public class LocalConnectionFactoryBean
extends Object
implements FactoryBean, InitializingBean

This FactoryBean creates a local JCA connection factory in non-managed mode.

The type of the connection factory is dependent on the actual connector: the connector can either expose its native API or follow the standard Common Client Interface (CCI), as defined by the JCA spec. In the latter case, the exposed interface is javax.resource.cci.ConnectionFactory.

In such a scenario, the connector uses a local ConnectionManager and you can't participate in global transactions because the connector will never be enlist/delist in the current JTA transaction.

In non-managed mode, a connector is not deployed on an application server. Consequently, it can't use the server's system contracts: connection management, transaction management, and security management.

In order to use this FactoryBean, you must specify the connector's "managerConnectionFactory" (usually configured as separate JavaBean), which will be used to create the actual connection factory.

Since:

1.2

Author:

Juergen Hoeller

See Also:

setManagedConnectionFactory(javax.resource.spi.ManagedConnectionFactory), ConnectionFactory

Constructor Summary

LocalConnectionFactoryBean()

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	setConnectionManager(ConnectionManager connectionManager) Set the JCA ConnectionManager that should be used to create the desired connection factory.
void	setManagedConnectionFactory(ManagedConnectionFactory managedConnectionFactory) Set the JCA ManagerConnectionFactory that should be used to create the desired connection factory.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalConnectionFactoryBean

public LocalConnectionFactoryBean()

Method Detail

setManagedConnectionFactory

public void setManagedConnectionFactory(ManagedConnectionFactory managedConnectionFactory)

Set the JCA ManagerConnectionFactory that should be used to create the desired connection factory.

The ManagerConnectionFactory will usually be set up as separate bean (potentially as inner bean), populated with JavaBean properties: a ManagerConnectionFactory is encouraged to follow the JavaBean pattern by the JCA specification, analogous to a JDBC DataSource and a JDO PersistenceManagerFactory.

See Also:

ManagedConnectionFactory.createConnectionFactory()

setConnectionManager

public void setConnectionManager(ConnectionManager connectionManager)

Set the JCA ConnectionManager that should be used to create the desired connection factory.

A ConnectionManager implementation for local usage is often included with a JCA connector. Such an included ConnectionManager might be set as default, with no need to explicitly specify one.

See Also:

ManagedConnectionFactory.createConnectionFactory(javax.resource.spi.ConnectionManager)

afterPropertiesSet

public void afterPropertiesSet()
                        throws ResourceException

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:

ResourceException

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.

If this method returns null, the factory will consider the FactoryBean as not fully initialized and throw a corresponding FactoryBeanNotInitializedException.

Specified by:

getObject in interface FactoryBean

Returns:

an instance of the bean (should not be null; a null value will be considered as an indication of incomplete initialization)

See Also:

FactoryBeanNotInitializedException

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