Package org.springframework.integration.jms

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:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.SmartInitializingSingleton, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, org.springframework.integration.context.ExpressionCapable, org.springframework.integration.context.OrderlyShutdownCapable, org.springframework.integration.core.MessageProducer, org.springframework.integration.IntegrationPattern, org.springframework.integration.support.context.NamedComponent, org.springframework.integration.support.management.IntegrationInboundManagement, org.springframework.integration.support.management.IntegrationManagement, org.springframework.integration.support.management.ManageableLifecycle, org.springframework.integration.support.management.ManageableSmartLifecycle, org.springframework.integration.support.management.TrackableComponent
public class JmsMessageDrivenEndpoint extends org.springframework.integration.endpoint.MessageProducerSupport implements org.springframework.integration.context.OrderlyShutdownCapable
A message-driven endpoint that receive JMS messages, converts them into Spring Integration Messages, and then sends the result to a channel.

  • Nested Class Summary

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

    org.springframework.integration.support.management.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(org.springframework.jms.listener.AbstractMessageListenerContainer listenerContainer, ChannelPublishingJmsMessageListener listener)
    Construct an instance with an externally configured container.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    afterShutdown()
     
    void
    afterSingletonsInstantiated()
     
    int
    beforeShutdown()
     
    void
    destroy()
     
    protected void
    doStart()
     
    protected void
    doStop()
     
    String
    getComponentType()
     
    ChannelPublishingJmsMessageListener
    getListener()
     
    protected void
    onInit()
     
    void
    registerMetricsCaptor(org.springframework.integration.support.management.metrics.MetricsCaptor captor)
     
    void
    registerObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)
     
    void
    setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
     
    void
    setErrorChannel(org.springframework.messaging.MessageChannel errorChannel)
     
    void
    setErrorChannelName(String errorChannelName)
     
    void
    setObservationConvention(org.springframework.integration.support.management.observation.MessageReceiverObservationConvention observationConvention)
     
    void
    setOutputChannel(org.springframework.messaging.MessageChannel outputChannel)
     
    void
    setOutputChannelName(String outputChannelName)
     
    void
    setSendTimeout(long sendTimeout)
     
    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, getComponentName, getConversionService, getExpression, getIntegrationProperties, 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

    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(org.springframework.jms.listener.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(org.springframework.messaging.MessageChannel outputChannel)
      Specified by:
      setOutputChannel in interface org.springframework.integration.core.MessageProducer
      Overrides:
      setOutputChannel in class org.springframework.integration.endpoint.MessageProducerSupport

    • setOutputChannelName

      public void setOutputChannelName(String outputChannelName)
      Specified by:
      setOutputChannelName in interface org.springframework.integration.core.MessageProducer
      Overrides:
      setOutputChannelName in class org.springframework.integration.endpoint.MessageProducerSupport

    • setErrorChannel

      public void setErrorChannel(org.springframework.messaging.MessageChannel errorChannel)
      Overrides:
      setErrorChannel in class org.springframework.integration.endpoint.MessageProducerSupport

    • setErrorChannelName

      public void setErrorChannelName(String errorChannelName)
      Overrides:
      setErrorChannelName in class org.springframework.integration.endpoint.MessageProducerSupport

    • setSendTimeout

      public void setSendTimeout(long sendTimeout)
      Overrides:
      setSendTimeout in class org.springframework.integration.endpoint.MessageProducerSupport

    • setShouldTrack

      public void setShouldTrack(boolean shouldTrack)
      Specified by:
      setShouldTrack in interface org.springframework.integration.support.management.TrackableComponent
      Overrides:
      setShouldTrack in class org.springframework.integration.endpoint.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(org.springframework.integration.support.management.metrics.MetricsCaptor captor)
      Specified by:
      registerMetricsCaptor in interface org.springframework.integration.support.management.IntegrationManagement

    • registerObservationRegistry

      public void registerObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)
      Specified by:
      registerObservationRegistry in interface org.springframework.integration.support.management.IntegrationManagement
      Overrides:
      registerObservationRegistry in class org.springframework.integration.endpoint.MessageProducerSupport

    • setObservationConvention

      public void setObservationConvention(org.springframework.integration.support.management.observation.MessageReceiverObservationConvention observationConvention)
      Overrides:
      setObservationConvention in class org.springframework.integration.endpoint.MessageProducerSupport

    • setApplicationContext

      public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext) throws org.springframework.beans.BeansException
      Specified by:
      setApplicationContext in interface org.springframework.context.ApplicationContextAware
      Overrides:
      setApplicationContext in class org.springframework.integration.context.IntegrationObjectSupport
      Throws:
      org.springframework.beans.BeansException

    • getComponentType

      public String getComponentType()
      Specified by:
      getComponentType in interface org.springframework.integration.support.context.NamedComponent
      Overrides:
      getComponentType in class org.springframework.integration.context.IntegrationObjectSupport

    • afterSingletonsInstantiated

      public void afterSingletonsInstantiated()
      Specified by:
      afterSingletonsInstantiated in interface org.springframework.beans.factory.SmartInitializingSingleton
      Overrides:
      afterSingletonsInstantiated in class org.springframework.integration.endpoint.MessageProducerSupport

    • onInit

      protected void onInit()
      Overrides:
      onInit in class org.springframework.integration.endpoint.MessageProducerSupport

    • doStart

      protected void doStart()
      Overrides:
      doStart in class org.springframework.integration.endpoint.MessageProducerSupport

    • doStop

      protected void doStop()
      Overrides:
      doStop in class org.springframework.integration.endpoint.MessageProducerSupport

    • destroy

      public void destroy()
      Specified by:
      destroy in interface org.springframework.beans.factory.DisposableBean
      Specified by:
      destroy in interface org.springframework.integration.support.management.IntegrationManagement
      Overrides:
      destroy in class org.springframework.integration.endpoint.AbstractEndpoint

    • beforeShutdown

      public int beforeShutdown()
      Specified by:
      beforeShutdown in interface org.springframework.integration.context.OrderlyShutdownCapable

    • afterShutdown

      public int afterShutdown()
      Specified by:
      afterShutdown in interface org.springframework.integration.context.OrderlyShutdownCapable