Class JmsGatewaySupport
java.lang.Object
org.springframework.jms.core.support.JmsGatewaySupport
- All Implemented Interfaces:
InitializingBean
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(jakarta.jms.ConnectionFactory) method.
- Since:
- 1.1.1
- Author:
- Mark Pollack
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal voidInvoked by the containingBeanFactoryafter it has set all bean properties and satisfiedBeanFactoryAware,ApplicationContextAwareetc.protected JmsTemplatecreateJmsTemplate(ConnectionFactory connectionFactory) Create a JmsTemplate for the given ConnectionFactory.final ConnectionFactoryReturn the JMS ConnectionFactory used by the gateway.final JmsTemplateReturn the JmsTemplate for the gateway.protected voidSubclasses can override this for custom initialization behavior.final voidsetConnectionFactory(ConnectionFactory connectionFactory) Set the JMS connection factory to be used by the gateway.final voidsetJmsTemplate(JmsTemplate jmsTemplate) Set the JmsTemplate for the gateway.
-
Field Details
-
logger
Logger available to subclasses.
-
-
Constructor Details
-
JmsGatewaySupport
public JmsGatewaySupport()
-
-
Method Details
-
setConnectionFactory
Set the JMS connection factory to be used by the gateway. Will automatically create a JmsTemplate for the given ConnectionFactory. -
createJmsTemplate
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.
- Parameters:
connectionFactory- the JMS ConnectionFactory to create a JmsTemplate for- Returns:
- the new JmsTemplate instance
- See Also:
-
getConnectionFactory
Return the JMS ConnectionFactory used by the gateway. -
setJmsTemplate
Set the JmsTemplate for the gateway. -
getJmsTemplate
Return the JmsTemplate for the gateway. -
afterPropertiesSet
Description copied from interface:InitializingBeanInvoked by the containingBeanFactoryafter it has set all bean properties and satisfiedBeanFactoryAware,ApplicationContextAwareetc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
- Specified by:
afterPropertiesSetin interfaceInitializingBean- Throws:
IllegalArgumentExceptionBeanInitializationException
-
initGateway
Subclasses can override this for custom initialization behavior. Gets called after population of this instance's bean properties.- Throws:
Exception- if initialization fails
-