Class JmsMessageDrivenEndpoint

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.endpoint.MessageProducerSupport

org.springframework.integration.jms.JmsMessageDrivenEndpoint

All Implemented Interfaces:

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

public class JmsMessageDrivenEndpoint
extends MessageProducerSupport
implements OrderlyShutdownCapable

A message-driven endpoint that receive JMS messages, converts them into Spring Integration Messages, and then sends the result to a channel.

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

Nested Class Summary

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

IntegrationManagement.ManagementOverrides

Field Summary

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
JmsMessageDrivenEndpoint(AbstractMessageListenerContainer listenerContainer, ChannelPublishingJmsMessageListener listener)	Construct an instance with an externally configured container.

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.
void	afterSingletonsInstantiated()
int	beforeShutdown()	Called before shutdown begins.
void	destroy()
protected void	doStart()	Take no action by default.
protected void	doStop()	Take no action by default.
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 captor)	Inject a MetricsCaptor.
void	registerObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)	Inject an ObservationRegistry.
void	setApplicationContext(ApplicationContext applicationContext)
void	setErrorChannel(MessageChannel errorChannel)
void	setErrorChannelName(String errorChannelName)	Set the error channel name.
void	setObservationConvention(MessageReceiverObservationConvention observationConvention)	Set a custom MessageReceiverObservationConvention for IntegrationObservation.HANDLER.
void	setOutputChannel(MessageChannel outputChannel)	Specify the MessageChannel to which produced Messages should be sent.
void	setOutputChannelName(String outputChannelName)	Set the output channel name; overrides outputChannel if provided.
void	setSendTimeout(long sendTimeout)	Configure the default timeout value to use for send operations.
void	setSessionAcknowledgeMode(String sessionAcknowledgeMode)	Set the session acknowledge mode on the listener container.
void	setShouldTrack(boolean shouldTrack)
void	setShutdownContainerOnStop(boolean shutdownContainerOnStop)	Set to false to prevent listener container shutdown when the endpoint is stopped.

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

buildErrorMessage, getErrorChannel, getErrorMessageAttributes, getErrorMessageStrategy, getIntegrationPatternType, getMessagingTemplate, getOutputChannel, isObserved, sendErrorMessageIfNecessary, sendMessage, setErrorMessageStrategy, subscribeToPublisher

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, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, 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

getManagedName, getManagedType, getOverrides, getThisAs, isLoggingEnabled, setLoggingEnabled, setManagedName, setManagedType

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

getBeanName, getComponentName

Constructor Details

JmsMessageDrivenEndpoint

public JmsMessageDrivenEndpoint(AbstractMessageListenerContainer listenerContainer,
 ChannelPublishingJmsMessageListener listener)

Construct an instance with an externally configured container.

Parameters:

listenerContainer - the container.

listener - the listener.

Method Details

setSessionAcknowledgeMode

public void setSessionAcknowledgeMode(String sessionAcknowledgeMode)

Set the session acknowledge mode on the listener container. It will override the container setting even if an external container is provided. Defaults to null (won't change container) if an external container is provided or `transacted` when the framework creates an implicit DefaultMessageListenerContainer.

Parameters:

sessionAcknowledgeMode - the acknowledgement mode.

setOutputChannel

public void setOutputChannel(MessageChannel outputChannel)

Description copied from interface: MessageProducer

Specify the MessageChannel to which produced Messages should be sent.

Specified by:

setOutputChannel in interface MessageProducer

Overrides:

setOutputChannel in class MessageProducerSupport

Parameters:

outputChannel - The output channel.

setOutputChannelName

public void setOutputChannelName(String outputChannelName)

Description copied from class: MessageProducerSupport

Set the output channel name; overrides outputChannel if provided.

Specified by:

setOutputChannelName in interface MessageProducer

Overrides:

setOutputChannelName in class MessageProducerSupport

Parameters:

outputChannelName - the channel name.

setErrorChannel

public void setErrorChannel(MessageChannel errorChannel)

Overrides:

setErrorChannel in class MessageProducerSupport

setErrorChannelName

public void setErrorChannelName(String errorChannelName)

Description copied from class: MessageProducerSupport

Set the error channel name. If no error channel is provided, this endpoint will propagate Exceptions to the message-driven source. To completely suppress Exceptions, provide a reference to the "nullChannel" here.

Overrides:

setErrorChannelName in class MessageProducerSupport

Parameters:

errorChannelName - The error channel bean name.

setSendTimeout

public void setSendTimeout(long sendTimeout)

Description copied from class: MessageProducerSupport

Configure the default timeout value to use for send operations. May be overridden for individual messages.

Overrides:

setSendTimeout in class MessageProducerSupport

Parameters:

sendTimeout - the 'send' operation timeout in milliseconds

See Also:

• GenericMessagingTemplate.setSendTimeout(long)

setShouldTrack

public void setShouldTrack(boolean shouldTrack)

Specified by:

setShouldTrack in interface TrackableComponent

Overrides:

setShouldTrack in class MessageProducerSupport

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

getListener

public ChannelPublishingJmsMessageListener getListener()

registerMetricsCaptor

public void registerMetricsCaptor(MetricsCaptor captor)

Description copied from interface: IntegrationManagement

Inject a MetricsCaptor. Ignored if ObservationRegistry is provided.

Specified by:

registerMetricsCaptor in interface IntegrationManagement

Parameters:

captor - 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 MessageProducerSupport

Parameters:

observationRegistry - the ObservationRegistry to expose observations from the component.

See Also:

• IntegrationManagement.registerMetricsCaptor(MetricsCaptor)

setObservationConvention

public void setObservationConvention(MessageReceiverObservationConvention observationConvention)

Description copied from class: MessageProducerSupport

Set a custom MessageReceiverObservationConvention for IntegrationObservation.HANDLER. Ignored if an ObservationRegistry is not configured for this component.

Overrides:

setObservationConvention in class MessageProducerSupport

Parameters:

observationConvention - the MessageReceiverObservationConvention to use.

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Overrides:

setApplicationContext in class IntegrationObjectSupport

Throws:

BeansException

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 IntegrationObjectSupport

afterSingletonsInstantiated

public void afterSingletonsInstantiated()

Specified by:

afterSingletonsInstantiated in interface SmartInitializingSingleton

Overrides:

afterSingletonsInstantiated in class MessageProducerSupport

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class MessageProducerSupport

doStart

protected void doStart()

Description copied from class: MessageProducerSupport

Take no action by default. Subclasses may override this if they need lifecycle-managed behavior. Protected by 'lifecycleLock'.

Overrides:

doStart in class MessageProducerSupport

doStop

protected void doStop()

Description copied from class: MessageProducerSupport

Take no action by default. Subclasses may override this if they need lifecycle-managed behavior.

Overrides:

doStop in class MessageProducerSupport

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Specified by:

destroy in interface IntegrationManagement

Overrides:

destroy in class AbstractEndpoint

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.