Package org.springframework.integration.jms

Class JmsInboundGateway

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.gateway.MessagingGatewaySupport

org.springframework.integration.jms.JmsInboundGateway

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, OrderlyShutdownCapable, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent

public class JmsInboundGateway
extends MessagingGatewaySupport
implements OrderlyShutdownCapable

A wrapper around the JmsMessageDrivenEndpoint implementing MessagingGatewaySupport.

Since:

5.0

Author:

Artem Bilan, Gary Russell

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.gateway.MessagingGatewaySupport

MessagingGatewaySupport.ConvertingMessagingTemplate

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.gateway.MessagingGatewaySupport

messagingTemplate

Fields inherited from class org.springframework.integration.endpoint.AbstractEndpoint

lifecycleCondition, lifecycleLock

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
JmsInboundGateway(AbstractMessageListenerContainer listenerContainer, ChannelPublishingJmsMessageListener listener)

Method Summary

Modifier and Type	Method	Description
int	afterShutdown()	Called after normal shutdown of schedulers, executors etc, and after the shutdown delay has elapsed, but before any forced shutdown of any remaining active scheduler/executor threads.Can optionally return the number of active messages still in process.
int	beforeShutdown()	Called before shutdown begins.
void	destroy()
protected void	doStart()	Subclasses must implement this method with the start behavior.
protected void	doStop()	Subclasses must implement this method with the stop behavior.
String	getComponentType()	Subclasses may implement this method to provide component type information.
ChannelPublishingJmsMessageListener	getListener()
protected void	onInit()	Subclasses may implement this for initialization logic.
void	registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)	Inject a MetricsCaptor.
void	registerObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)	Inject an ObservationRegistry.
void	setApplicationContext(ApplicationContext applicationContext)
void	setErrorChannel(MessageChannel errorChannel)	Set the error channel.
void	setErrorChannelName(String errorChannelName)	Set the error channel name.
void	setErrorOnTimeout(boolean errorOnTimeout)	If errorOnTimeout is true, construct an instance that will send an ErrorMessage with a MessageTimeoutException payload to the error channel if a reply is expected but none is received.
void	setObservationConvention(MessageRequestReplyReceiverObservationConvention observationConvention)
void	setReplyChannel(MessageChannel replyChannel)	Set the reply channel.
void	setReplyChannelName(String replyChannelName)	Set the reply channel name.
void	setReplyTimeout(long replyTimeout)	Set the timeout value for receiving reply messages.
void	setRequestChannel(MessageChannel requestChannel)	Set the request channel.
void	setRequestChannelName(String requestChannelName)	Set the request channel name.
void	setRequestTimeout(long requestTimeout)	Set the timeout value for sending request messages.
void	setShouldTrack(boolean shouldTrack)	Specify whether this gateway should be tracked in the Message History of Messages that originate from its send or sendAndReceive operations.
void	setShutdownContainerOnStop(boolean shutdownContainerOnStop)	Set to false to prevent listener container shutdown when the endpoint is stopped.

Methods inherited from class org.springframework.integration.gateway.MessagingGatewaySupport

buildErrorMessage, buildSendTimer, getErrorChannel, getErrorMessageAttributes, getErrorMessageStrategy, getIntegrationPatternType, getManagedName, getManagedType, getOverrides, getReplyChannel, getRequestChannel, isLoggingEnabled, isObserved, receive, receive, receiveMessage, receiveMessage, registerReplyMessageCorrelatorIfNecessary, send, sendAndReceive, sendAndReceiveMessage, sendAndReceiveMessageReactive, sendTimer, setErrorMessageStrategy, setLoggingEnabled, setManagedName, setManagedType, setReceiverObservationConvention, setReplyMapper, setRequestMapper

Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint

doStop, getPhase, getRole, isActive, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getThisAs

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Constructor Details

JmsInboundGateway

public JmsInboundGateway(AbstractMessageListenerContainer listenerContainer,
 ChannelPublishingJmsMessageListener listener)

Method Details

setRequestChannel

public void setRequestChannel(MessageChannel requestChannel)

Description copied from class: MessagingGatewaySupport

Set the request channel.

Overrides:

setRequestChannel in class MessagingGatewaySupport

Parameters:

requestChannel - the channel to which request messages will be sent

setRequestChannelName

public void setRequestChannelName(String requestChannelName)

Description copied from class: MessagingGatewaySupport

Set the request channel name.

Overrides:

setRequestChannelName in class MessagingGatewaySupport

Parameters:

requestChannelName - the channel bean name to which request messages will be sent

setReplyChannel

public void setReplyChannel(MessageChannel replyChannel)

Description copied from class: MessagingGatewaySupport

Set the reply channel. If no reply channel is provided, this gateway will always use an anonymous, temporary channel for handling replies.

Overrides:

setReplyChannel in class MessagingGatewaySupport

Parameters:

replyChannel - the channel from which reply messages will be received

setReplyChannelName

public void setReplyChannelName(String replyChannelName)

Description copied from class: MessagingGatewaySupport

Set the reply channel name. If no reply channel is provided, this gateway will always use an anonymous, temporary channel for handling replies.

Overrides:

setReplyChannelName in class MessagingGatewaySupport

Parameters:

replyChannelName - the channel bean name from which reply messages will be received

setErrorChannel

public void setErrorChannel(MessageChannel errorChannel)

Description copied from class: MessagingGatewaySupport

Set the error channel. If no error channel is provided, this gateway will propagate Exceptions to the caller. To completely suppress Exceptions, provide a reference to the "nullChannel" here.

Overrides:

setErrorChannel in class MessagingGatewaySupport

Parameters:

errorChannel - The error channel.

setErrorChannelName

public void setErrorChannelName(String errorChannelName)

Description copied from class: MessagingGatewaySupport

Set the error channel name. If no error channel is provided, this gateway will propagate Exceptions to the caller. To completely suppress Exceptions, provide a reference to the "nullChannel" here.

Overrides:

setErrorChannelName in class MessagingGatewaySupport

Parameters:

errorChannelName - The error channel bean name.

setRequestTimeout

public void setRequestTimeout(long requestTimeout)

Description copied from class: MessagingGatewaySupport

Set the timeout value for sending request messages. If not explicitly configured, the default is one second.

Overrides:

setRequestTimeout in class MessagingGatewaySupport

Parameters:

requestTimeout - the timeout value in milliseconds

setReplyTimeout

public void setReplyTimeout(long replyTimeout)

Description copied from class: MessagingGatewaySupport

Set the timeout value for receiving reply messages. If not explicitly configured, the default is one second.

Overrides:

setReplyTimeout in class MessagingGatewaySupport

Parameters:

replyTimeout - the timeout value in milliseconds

setErrorOnTimeout

public void setErrorOnTimeout(boolean errorOnTimeout)

Description copied from class: MessagingGatewaySupport

If errorOnTimeout is true, construct an instance that will send an ErrorMessage with a MessageTimeoutException payload to the error channel if a reply is expected but none is received. If no error channel is configured, the MessageTimeoutException will be thrown.

Overrides:

setErrorOnTimeout in class MessagingGatewaySupport

Parameters:

errorOnTimeout - true to create the error message on reply timeout.

setShouldTrack

public void setShouldTrack(boolean shouldTrack)

Description copied from class: MessagingGatewaySupport

Specify whether this gateway should be tracked in the Message History of Messages that originate from its send or sendAndReceive operations.

Specified by:

setShouldTrack in interface TrackableComponent

Overrides:

setShouldTrack in class MessagingGatewaySupport

setShutdownContainerOnStop

public void setShutdownContainerOnStop(boolean shutdownContainerOnStop)

Set to false to prevent listener container shutdown when the endpoint is stopped. Then, if so configured, any cached consumer(s) in the container will remain. Otherwise, the shared connection and will be closed and the listener invokers shut down; this behavior is new starting with version 5.1. Default: true.

Parameters:

shutdownContainerOnStop - false to not shutdown.

Since:

5.1

registerMetricsCaptor

public void registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)

Description copied from interface: IntegrationManagement

Inject a MetricsCaptor. Ignored if ObservationRegistry is provided.

Specified by:

registerMetricsCaptor in interface IntegrationManagement

Overrides:

registerMetricsCaptor in class MessagingGatewaySupport

Parameters:

metricsCaptorToRegister - the captor.

See Also:

• IntegrationManagement.registerObservationRegistry(ObservationRegistry)

registerObservationRegistry

public void registerObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)

Description copied from interface: IntegrationManagement

Inject an ObservationRegistry. If provided, the MetricsCaptor is ignored. The meters capturing has to be configured as an ObservationHandler on the provided ObservationRegistry.

Specified by:

registerObservationRegistry in interface IntegrationManagement

Overrides:

registerObservationRegistry in class MessagingGatewaySupport

Parameters:

observationRegistry - the ObservationRegistry to expose observations from the component.

See Also:

• IntegrationManagement.registerMetricsCaptor(MetricsCaptor)

setObservationConvention

public void setObservationConvention(MessageRequestReplyReceiverObservationConvention observationConvention)

Overrides:

setObservationConvention in class MessagingGatewaySupport

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class MessagingGatewaySupport

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Overrides:

setApplicationContext in class IntegrationObjectSupport

Throws:

BeansException

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class MessagingGatewaySupport

getListener

public ChannelPublishingJmsMessageListener getListener()

doStart

protected void doStart()

Description copied from class: AbstractEndpoint

Subclasses must implement this method with the start behavior. This method will be invoked while holding the AbstractEndpoint.lifecycleLock.

Overrides:

doStart in class MessagingGatewaySupport

doStop

protected void doStop()

Description copied from class: AbstractEndpoint

Subclasses must implement this method with the stop behavior. This method will be invoked while holding the AbstractEndpoint.lifecycleLock.

Overrides:

doStop in class MessagingGatewaySupport

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Specified by:

destroy in interface IntegrationManagement

Overrides:

destroy in class MessagingGatewaySupport

beforeShutdown

public int beforeShutdown()

Description copied from interface: OrderlyShutdownCapable

Called before shutdown begins. Implementations should stop accepting new messages. Can optionally return the number of active messages in process.

Specified by:

beforeShutdown in interface OrderlyShutdownCapable

Returns:

The number of active messages if available.

afterShutdown

public int afterShutdown()

Description copied from interface: OrderlyShutdownCapable

Called after normal shutdown of schedulers, executors etc, and after the shutdown delay has elapsed, but before any forced shutdown of any remaining active scheduler/executor threads.Can optionally return the number of active messages still in process.

Specified by:

afterShutdown in interface OrderlyShutdownCapable

Returns:

The number of active messages if available.