public class

UserCredentialsConnectionFactoryAdapter

extends Object
implements InitializingBean
java.lang.Object
   ↳ org.springframework.jms.connection.UserCredentialsConnectionFactoryAdapter

Class Overview

An adapter for a target JMS javax.jms.ConnectionFactory, applying the given user credentials to every standard createConnection() call, that is, implicitly invoking createConnection(username, password) 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 user credentials configured. Client code can work with the ConnectionFactory without passing in username and password on every createConnection() 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/jms/mycf"/>
 </bean>

 <bean id="myConnectionFactory" class="org.springframework.jms.connection.UserCredentialsConnectionFactoryAdapter">
   <property name="targetConnectionFactory" ref="myTargetConnectionFactory"/>
   <property name="username" value="myusername"/>
   <property name="password" value="mypassword"/>
 </bean>

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

Summary

Public Constructors
UserCredentialsConnectionFactoryAdapter()
Public Methods
void afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
Connection createConnection(String username, String password)
Delegate the call straight to the target ConnectionFactory.
final Connection createConnection()
Determine whether there are currently thread-bound credentials, using them if available, falling back to the statically specified username and password (i.e.
QueueConnection createQueueConnection(String username, String password)
Delegate the call straight to the target QueueConnectionFactory.
final QueueConnection createQueueConnection()
Determine whether there are currently thread-bound credentials, using them if available, falling back to the statically specified username and password (i.e.
TopicConnection createTopicConnection(String username, String password)
Delegate the call straight to the target TopicConnectionFactory.
final TopicConnection createTopicConnection()
Determine whether there are currently thread-bound credentials, using them if available, falling back to the statically specified username and password (i.e.
void removeCredentialsFromCurrentThread()
Remove any user credentials for this proxy from the current thread.
void setCredentialsForCurrentThread(String username, String password)
Set user credententials for this proxy and the current thread.
void setPassword(String password)
Set the password that this adapter should use for retrieving Connections.
void setTargetConnectionFactory(ConnectionFactory targetConnectionFactory)
Set the target ConnectionFactory that this ConnectionFactory should delegate to.
void setUsername(String username)
Set the username that this adapter should use for retrieving Connections.
Protected Methods
Connection doCreateConnection(String username, String password)
This implementation delegates to the createConnection(username, password) method of the target ConnectionFactory, passing in the specified user credentials.
QueueConnection doCreateQueueConnection(String username, String password)
This implementation delegates to the createQueueConnection(username, password) method of the target QueueConnectionFactory, passing in the specified user credentials.
TopicConnection doCreateTopicConnection(String username, String password)
This implementation delegates to the createTopicConnection(username, password) method of the target TopicConnectionFactory, passing in the specified user credentials.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.beans.factory.InitializingBean

Public Constructors

public UserCredentialsConnectionFactoryAdapter ()

Public Methods

public void afterPropertiesSet ()

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.

public Connection createConnection (String username, String password)

Delegate the call straight to the target ConnectionFactory.

Throws
JMSException

public final Connection createConnection ()

Determine whether there are currently thread-bound credentials, using them if available, falling back to the statically specified username and password (i.e. values of the bean properties) else.

Throws
JMSException

public QueueConnection createQueueConnection (String username, String password)

Delegate the call straight to the target QueueConnectionFactory.

Throws
JMSException

public final QueueConnection createQueueConnection ()

Determine whether there are currently thread-bound credentials, using them if available, falling back to the statically specified username and password (i.e. values of the bean properties) else.

Throws
JMSException

public TopicConnection createTopicConnection (String username, String password)

Delegate the call straight to the target TopicConnectionFactory.

Throws
JMSException

public final TopicConnection createTopicConnection ()

Determine whether there are currently thread-bound credentials, using them if available, falling back to the statically specified username and password (i.e. values of the bean properties) else.

Throws
JMSException

public void removeCredentialsFromCurrentThread ()

Remove any user credentials for this proxy from the current thread. Statically specified user credentials apply again afterwards.

public void setCredentialsForCurrentThread (String username, String password)

Set user credententials for this proxy and the current thread. The given username and password will be applied to all subsequent createConnection() calls on this ConnectionFactory proxy.

This will override any statically specified user credentials, that is, values of the "username" and "password" bean properties.

Parameters
username the username to apply
password the password to apply

public void setPassword (String password)

Set the password that this adapter should use for retrieving Connections. Default is no specific password.

public void setTargetConnectionFactory (ConnectionFactory targetConnectionFactory)

Set the target ConnectionFactory that this ConnectionFactory should delegate to.

public void setUsername (String username)

Set the username that this adapter should use for retrieving Connections. Default is no specific user.

Protected Methods

protected Connection doCreateConnection (String username, String password)

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

Parameters
username the username to use
password the password to use
Returns
  • the Connection
Throws
JMSException
See Also
  • javax.jms.ConnectionFactory#createConnection(String, String)
  • javax.jms.ConnectionFactory#createConnection()

protected QueueConnection doCreateQueueConnection (String username, String password)

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

Parameters
username the username to use
password the password to use
Returns
  • the Connection
Throws
JMSException
See Also
  • javax.jms.QueueConnectionFactory#createQueueConnection(String, String)
  • javax.jms.QueueConnectionFactory#createQueueConnection()

protected TopicConnection doCreateTopicConnection (String username, String password)

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

Parameters
username the username to use
password the password to use
Returns
  • the Connection
Throws
JMSException
See Also
  • javax.jms.TopicConnectionFactory#createTopicConnection(String, String)
  • javax.jms.TopicConnectionFactory#createTopicConnection()