public abstract class

JmsGatewaySupport

extends Object
implements InitializingBean
java.lang.Object
   ↳ org.springframework.jms.core.support.JmsGatewaySupport

Class Overview

Convenient super class for application classes that need JMS access.

Requires a ConnectionFactory or a JmsTemplate instance to be set. It will create its own JmsTemplate if a ConnectionFactory is passed in. A custom JmsTemplate instance can be created for a given ConnectionFactory through overriding the createJmsTemplate(ConnectionFactory) method.

See Also

Summary

Fields
protected final Log logger Logger available to subclasses
Public Constructors
JmsGatewaySupport()
Public Methods
final void afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
final ConnectionFactory getConnectionFactory()
Return the JMS ConnectionFactory used by the gateway.
final JmsTemplate getJmsTemplate()
Return the JmsTemplate for the gateway.
final void setConnectionFactory(ConnectionFactory connectionFactory)
Set the JMS connection factory to be used by the gateway.
final void setJmsTemplate(JmsTemplate jmsTemplate)
Set the JmsTemplate for the gateway.
Protected Methods
JmsTemplate createJmsTemplate(ConnectionFactory connectionFactory)
Create a JmsTemplate for the given ConnectionFactory.
void initGateway()
Subclasses can override this for custom initialization behavior.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.beans.factory.InitializingBean

Fields

protected final Log logger

Logger available to subclasses

Public Constructors

public JmsGatewaySupport ()

Public Methods

public final 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.

Throws
BeanInitializationException
IllegalArgumentException

public final ConnectionFactory getConnectionFactory ()

Return the JMS ConnectionFactory used by the gateway.

public final JmsTemplate getJmsTemplate ()

Return the JmsTemplate for the gateway.

public final void setConnectionFactory (ConnectionFactory connectionFactory)

Set the JMS connection factory to be used by the gateway. Will automatically create a JmsTemplate for the given ConnectionFactory.

See Also

public final void setJmsTemplate (JmsTemplate jmsTemplate)

Set the JmsTemplate for the gateway.

See Also
  • #setConnectionFactory(javax.jms.ConnectionFactory)

Protected Methods

protected JmsTemplate createJmsTemplate (ConnectionFactory connectionFactory)

Create a JmsTemplate for the given ConnectionFactory. Only invoked if populating the gateway with a ConnectionFactory reference.

Can be overridden in subclasses to provide a JmsTemplate instance with a different configuration or the JMS 1.0.2 version, JmsTemplate102.

Parameters
connectionFactory the JMS ConnectionFactory to create a JmsTemplate for
Returns
  • the new JmsTemplate instance
See Also

protected void initGateway ()

Subclasses can override this for custom initialization behavior. Gets called after population of this instance's bean properties.

Throws
Exception if initialization fails