Class JmsPollableMessageChannelSpec<S extends JmsPollableMessageChannelSpec<S,T>,T extends AbstractJmsChannel>

java.lang.Object
org.springframework.beans.factory.config.AbstractFactoryBean<T>
org.springframework.integration.dsl.IntegrationComponentSpec<S,C>
org.springframework.integration.dsl.MessageChannelSpec<S,T>
org.springframework.integration.jms.dsl.JmsPollableMessageChannelSpec<S,T>
Type Parameters:
S - the target JmsPollableMessageChannelSpec implementation type.
T - the target channel implementation type.
All Implemented Interfaces:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<T>, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, org.springframework.integration.dsl.ComponentsRegistration
Direct Known Subclasses:
JmsMessageChannelSpec

public class JmsPollableMessageChannelSpec<S extends JmsPollableMessageChannelSpec<S,T>,T extends AbstractJmsChannel> extends org.springframework.integration.dsl.MessageChannelSpec<S,T>
A MessageChannelSpec for an AbstractJmsChannel.
Since:
5.0
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final JmsChannelFactoryBean
     

    Fields inherited from class org.springframework.integration.dsl.MessageChannelSpec

    channel

    Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

    PARSER, target

    Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

    logger

    Fields inherited from interface org.springframework.beans.factory.FactoryBean

    OBJECT_TYPE_ATTRIBUTE

    Fields inherited from interface org.springframework.context.SmartLifecycle

    DEFAULT_PHASE
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    JmsPollableMessageChannelSpec(jakarta.jms.ConnectionFactory connectionFactory)
     
    protected
    JmsPollableMessageChannelSpec(JmsChannelFactoryBean jmsChannelFactoryBean, jakarta.jms.ConnectionFactory connectionFactory)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    deliveryPersistent(boolean deliveryPersistent)
     
    destination(jakarta.jms.Destination destination)
    Configure the destination that backs this channel.
    destination(String destination)
    Configure the destination name that backs this channel.
    destinationResolver(org.springframework.jms.support.destination.DestinationResolver destinationResolver)
     
    protected T
     
    explicitQosEnabled(boolean explicitQosEnabled)
     
    protected S
    id(String id)
     
    jmsMessageConverter(org.springframework.jms.support.converter.MessageConverter messageConverter)
    Configure the MessageConverter used for both sending and receiving.
    messageIdEnabled(boolean messageIdEnabled)
     
    messageSelector(String messageSelector)
    Configure a message selector in the DefaultMessageListenerContainer (when message driven) or the JmsTemplate (when polled).
    messageTimestampEnabled(boolean messageTimestampEnabled)
     
    priority(int priority)
    Default priority.
    receiveTimeout(long receiveTimeout)
     
    sessionAcknowledgeMode(int sessionAcknowledgeMode)
     
    sessionTransacted(boolean sessionTransacted)
    Configure transactional sessions for both the JmsTemplate (sends and polled receives) and DefaultMessageListenerContainer (message-driven receives).
    timeToLive(long timeToLive)
     

    Methods inherited from class org.springframework.integration.dsl.MessageChannelSpec

    datatype, getComponentsToRegister, interceptor, messageConverter, wireTap, wireTap, wireTap

    Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

    _this, createInstance, destroyInstance, get, getId, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

    Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

    afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Constructor Details

    • JmsPollableMessageChannelSpec

      protected JmsPollableMessageChannelSpec(jakarta.jms.ConnectionFactory connectionFactory)
    • JmsPollableMessageChannelSpec

      protected JmsPollableMessageChannelSpec(JmsChannelFactoryBean jmsChannelFactoryBean, jakarta.jms.ConnectionFactory connectionFactory)
  • Method Details

    • id

      protected S id(@Nullable String id)
      Overrides:
      id in class org.springframework.integration.dsl.IntegrationComponentSpec<S extends JmsPollableMessageChannelSpec<S,T>,T extends AbstractJmsChannel>
    • destination

      public S destination(String destination)
      Configure the destination name that backs this channel.
      Parameters:
      destination - the destination.
      Returns:
      the current MessageChannelSpec.
    • destinationResolver

      public S destinationResolver(org.springframework.jms.support.destination.DestinationResolver destinationResolver)
      Parameters:
      destinationResolver - the destinationResolver.
      Returns:
      the current MessageChannelSpec.
      See Also:
      • JmsDestinationAccessor.setDestinationResolver(DestinationResolver)
      • JmsDestinationAccessor.setDestinationResolver(DestinationResolver)
    • destination

      public S destination(jakarta.jms.Destination destination)
      Configure the destination that backs this channel.
      Parameters:
      destination - the destination.
      Returns:
      the current MessageChannelSpec.
    • messageSelector

      public S messageSelector(String messageSelector)
      Configure a message selector in the DefaultMessageListenerContainer (when message driven) or the JmsTemplate (when polled).
      Parameters:
      messageSelector - the messageSelector.
      Returns:
      the current MessageChannelSpec.
      See Also:
      • AbstractMessageListenerContainer.setMessageSelector(String)
      • JmsTemplate.receiveSelectedAndConvert(String)
    • jmsMessageConverter

      public S jmsMessageConverter(org.springframework.jms.support.converter.MessageConverter messageConverter)
      Configure the MessageConverter used for both sending and receiving.
      Parameters:
      messageConverter - the messageConverter.
      Returns:
      the current MessageChannelSpec.
      See Also:
      • JmsTemplate.setMessageConverter(MessageConverter)
    • deliveryPersistent

      public S deliveryPersistent(boolean deliveryPersistent)
      Parameters:
      deliveryPersistent - the deliveryPersistent.
      Returns:
      the current MessageChannelSpec.
      See Also:
      • JmsTemplate.setDeliveryPersistent(boolean)
    • explicitQosEnabled

      public S explicitQosEnabled(boolean explicitQosEnabled)
      Parameters:
      explicitQosEnabled - the explicitQosEnabled.
      Returns:
      the current MessageChannelSpec.
      See Also:
      • JmsTemplate.setExplicitQosEnabled(boolean)
    • messageIdEnabled

      public S messageIdEnabled(boolean messageIdEnabled)
      Parameters:
      messageIdEnabled - the messageIdEnabled.
      Returns:
      the current MessageChannelSpec.
      See Also:
      • JmsTemplate.setMessageIdEnabled(boolean)
    • messageTimestampEnabled

      public S messageTimestampEnabled(boolean messageTimestampEnabled)
      Parameters:
      messageTimestampEnabled - the messageTimestampEnabled.
      Returns:
      the current MessageChannelSpec.
      See Also:
      • JmsTemplate.setMessageTimestampEnabled(boolean)
    • priority

      public S priority(int priority)
      Default priority. May be overridden at run time with a message priority header.
      Parameters:
      priority - the priority.
      Returns:
      the current MessageChannelSpec.
      See Also:
      • JmsTemplate.setPriority(int)
    • timeToLive

      public S timeToLive(long timeToLive)
      Parameters:
      timeToLive - the timeToLive.
      Returns:
      the current MessageChannelSpec.
      See Also:
      • JmsTemplate.setTimeToLive(long)
    • receiveTimeout

      public S receiveTimeout(long receiveTimeout)
      Parameters:
      receiveTimeout - the receiveTimeout.
      Returns:
      the current MessageChannelSpec.
      See Also:
      • JmsTemplate.setReceiveTimeout(long)
      • AbstractPollingMessageListenerContainer.setReceiveTimeout(long)
    • sessionAcknowledgeMode

      public S sessionAcknowledgeMode(int sessionAcknowledgeMode)
      Parameters:
      sessionAcknowledgeMode - the acknowledgement mode constant
      Returns:
      the current MessageChannelSpec.
      See Also:
      • etc.
    • sessionTransacted

      public S sessionTransacted(boolean sessionTransacted)
      Configure transactional sessions for both the JmsTemplate (sends and polled receives) and DefaultMessageListenerContainer (message-driven receives).
      Parameters:
      sessionTransacted - the sessionTransacted.
      Returns:
      the current MessageChannelSpec.
    • doGet

      protected T doGet()
      Overrides:
      doGet in class org.springframework.integration.dsl.MessageChannelSpec<S extends JmsPollableMessageChannelSpec<S,T>,T extends AbstractJmsChannel>