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:
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.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.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 JmsInboundGateway extends org.springframework.integration.gateway.MessagingGatewaySupport implements org.springframework.integration.context.OrderlyShutdownCapable
A wrapper around the JmsMessageDrivenEndpoint implementing MessagingGatewaySupport.
Since:
5.0

  • Nested Class Summary

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

    org.springframework.integration.gateway.MessagingGatewaySupport.ConvertingMessagingTemplate

    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.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(org.springframework.jms.listener.AbstractMessageListenerContainer listenerContainer, ChannelPublishingJmsMessageListener listener)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    afterShutdown()
     
    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 metricsCaptorToRegister)
     
    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
    setErrorOnTimeout(boolean errorOnTimeout)
     
    void
    setObservationConvention(org.springframework.integration.support.management.observation.MessageRequestReplyReceiverObservationConvention observationConvention)
     
    void
    setReplyChannel(org.springframework.messaging.MessageChannel replyChannel)
     
    void
    setReplyChannelName(String replyChannelName)
     
    void
    setReplyTimeout(long replyTimeout)
     
    void
    setRequestChannel(org.springframework.messaging.MessageChannel requestChannel)
     
    void
    setRequestChannelName(String requestChannelName)
     
    void
    setRequestTimeout(long requestTimeout)
     
    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.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, 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(org.springframework.jms.listener.AbstractMessageListenerContainer listenerContainer, ChannelPublishingJmsMessageListener listener)

  • Method Details

    • setRequestChannel

      public void setRequestChannel(org.springframework.messaging.MessageChannel requestChannel)
      Overrides:
      setRequestChannel in class org.springframework.integration.gateway.MessagingGatewaySupport

    • setRequestChannelName

      public void setRequestChannelName(String requestChannelName)
      Overrides:
      setRequestChannelName in class org.springframework.integration.gateway.MessagingGatewaySupport

    • setReplyChannel

      public void setReplyChannel(org.springframework.messaging.MessageChannel replyChannel)
      Overrides:
      setReplyChannel in class org.springframework.integration.gateway.MessagingGatewaySupport

    • setReplyChannelName

      public void setReplyChannelName(String replyChannelName)
      Overrides:
      setReplyChannelName in class org.springframework.integration.gateway.MessagingGatewaySupport

    • setErrorChannel

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

    • setErrorChannelName

      public void setErrorChannelName(String errorChannelName)
      Overrides:
      setErrorChannelName in class org.springframework.integration.gateway.MessagingGatewaySupport

    • setRequestTimeout

      public void setRequestTimeout(long requestTimeout)
      Overrides:
      setRequestTimeout in class org.springframework.integration.gateway.MessagingGatewaySupport

    • setReplyTimeout

      public void setReplyTimeout(long replyTimeout)
      Overrides:
      setReplyTimeout in class org.springframework.integration.gateway.MessagingGatewaySupport

    • setErrorOnTimeout

      public void setErrorOnTimeout(boolean errorOnTimeout)
      Overrides:
      setErrorOnTimeout in class org.springframework.integration.gateway.MessagingGatewaySupport

    • setShouldTrack

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

    • 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.gateway.MessagingGatewaySupport

    • setObservationConvention

      public void setObservationConvention(org.springframework.integration.support.management.observation.MessageRequestReplyReceiverObservationConvention observationConvention)
      Overrides:
      setObservationConvention in class org.springframework.integration.gateway.MessagingGatewaySupport

    • getComponentType

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

    • 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

    • onInit

      protected void onInit()
      Overrides:
      onInit in class org.springframework.integration.gateway.MessagingGatewaySupport

    • getListener

      public ChannelPublishingJmsMessageListener getListener()

    • doStart

      protected void doStart()
      Overrides:
      doStart in class org.springframework.integration.gateway.MessagingGatewaySupport

    • doStop

      protected void doStop()
      Overrides:
      doStop in class org.springframework.integration.gateway.MessagingGatewaySupport

    • 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.gateway.MessagingGatewaySupport

    • 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