public class

ConnectionSpecConnectionFactoryAdapter

extends DelegatingConnectionFactory
java.lang.Object
   ↳ org.springframework.jca.cci.connection.DelegatingConnectionFactory
     ↳ org.springframework.jca.cci.connection.ConnectionSpecConnectionFactoryAdapter

Class Overview

An adapter for a target CCI javax.resource.cci.ConnectionFactory, applying the given ConnectionSpec to every standard getConnection() call, that is, implicitly invoking getConnection(ConnectionSpec) on the target. All other methods simply delegate to the corresponding methods of the target ConnectionFactory.

Can be used to proxy a target JNDI ConnectionFactory that does not have a ConnectionSpec configured. Client code can work with the ConnectionFactory without passing in a ConnectionSpec on every getConnection() call.

In the following example, client code can simply transparently work with the preconfigured "myConnectionFactory", implicitly accessing "myTargetConnectionFactory" with the specified user credentials.

 <bean id="myTargetConnectionFactory" class="org.springframework.jndi.JndiObjectFactoryBean">
   <property name="jndiName" value="java:comp/env/cci/mycf"/>
 </bean>

 <bean id="myConnectionFactory" class="org.springframework.jca.cci.connection.ConnectionSpecConnectionFactoryAdapter">
   <property name="targetConnectionFactory" ref="myTargetConnectionFactory"/>
   <property name="connectionSpec">
     <bean class="your.resource.adapter.ConnectionSpecImpl">
       <property name="username" value="myusername"/>
       <property name="password" value="mypassword"/>
     </bean>
   </property>
 </bean>

If the "connectionSpec" is empty, this proxy will simply delegate to the standard getConnection() method of the target ConnectionFactory. This can be used to keep a UserCredentialsConnectionFactoryAdapter bean definition just for the option of implicitly passing in a ConnectionSpec if the particular target ConnectionFactory requires it.

See Also

Summary

Public Constructors
ConnectionSpecConnectionFactoryAdapter()
Public Methods
final Connection getConnection()
Determine whether there is currently a thread-bound ConnectionSpec, using it if available, falling back to the statically specified "connectionSpec" property else.
void removeConnectionSpecFromCurrentThread()
Remove any ConnectionSpec for this proxy from the current thread.
void setConnectionSpec(ConnectionSpec connectionSpec)
Set the ConnectionSpec that this adapter should use for retrieving Connections.
void setConnectionSpecForCurrentThread(ConnectionSpec spec)
Set a ConnectionSpec for this proxy and the current thread.
Protected Methods
Connection doGetConnection(ConnectionSpec spec)
This implementation delegates to the getConnection(ConnectionSpec) method of the target ConnectionFactory, passing in the specified user credentials.
[Expand]
Inherited Methods
From class org.springframework.jca.cci.connection.DelegatingConnectionFactory
From class java.lang.Object
From interface org.springframework.beans.factory.InitializingBean

Public Constructors

public ConnectionSpecConnectionFactoryAdapter ()

Public Methods

public final Connection getConnection ()

Determine whether there is currently a thread-bound ConnectionSpec, using it if available, falling back to the statically specified "connectionSpec" property else.

Throws
ResourceException

public void removeConnectionSpecFromCurrentThread ()

Remove any ConnectionSpec for this proxy from the current thread. A statically specified ConnectionSpec applies again afterwards.

public void setConnectionSpec (ConnectionSpec connectionSpec)

Set the ConnectionSpec that this adapter should use for retrieving Connections. Default is none.

public void setConnectionSpecForCurrentThread (ConnectionSpec spec)

Set a ConnectionSpec for this proxy and the current thread. The given ConnectionSpec will be applied to all subsequent getConnection() calls on this ConnectionFactory proxy.

This will override any statically specified "connectionSpec" property.

Parameters
spec the ConnectionSpec to apply

Protected Methods

protected Connection doGetConnection (ConnectionSpec spec)

This implementation delegates to the getConnection(ConnectionSpec) method of the target ConnectionFactory, passing in the specified user credentials. If the specified username is empty, it will simply delegate to the standard getConnection() method of the target ConnectionFactory.

Parameters
spec the ConnectionSpec to apply
Returns
  • the Connection
Throws
ResourceException
See Also
  • javax.resource.cci.ConnectionFactory#getConnection(javax.resource.cci.ConnectionSpec)
  • javax.resource.cci.ConnectionFactory#getConnection()