Class AmqpBaseInboundGatewaySpec<S extends AmqpBaseInboundGatewaySpec<S>>

java.lang.Object
org.springframework.beans.factory.config.AbstractFactoryBean<T>
org.springframework.integration.dsl.IntegrationComponentSpec<S,G>
org.springframework.integration.dsl.MessagingGatewaySpec<S,AmqpInboundGateway>
org.springframework.integration.amqp.dsl.AmqpBaseInboundGatewaySpec<S>
Type Parameters:
S - the target AmqpBaseInboundGatewaySpec 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<AmqpInboundGateway>, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle
Direct Known Subclasses:
AmqpInboundGatewaySpec

public class AmqpBaseInboundGatewaySpec<S extends AmqpBaseInboundGatewaySpec<S>> extends org.springframework.integration.dsl.MessagingGatewaySpec<S,AmqpInboundGateway>
A base MessagingGatewaySpec implementation for AmqpInboundGateway endpoint options. Doesn't allow to specify listenerContainer options.
Since:
5.0
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final DefaultAmqpHeaderMapper
     

    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
     
  • Method Summary

    Modifier and Type
    Method
    Description
    batchingStrategy(org.springframework.amqp.rabbit.batch.BatchingStrategy batchingStrategy)
    Set a batching strategy to use when de-batching messages.
    bindSourceMessage(boolean bindSourceMessage)
    Set to true to bind the source message in the headers.
    defaultReplyTo(String defaultReplyTo)
    The defaultReplyTo address with the form
    Configure the gateway's AmqpHeaderMapper; defaults to DefaultAmqpHeaderMapper.
    Only applies if the default header mapper is used.
    Only applies if the default header mapper is used.
    messageConverter(org.springframework.amqp.support.converter.MessageConverter messageConverter)
    Configure the gateway's MessageConverter; defaults to SimpleMessageConverter.
    messageRecoverer(org.springframework.amqp.rabbit.retry.MessageRecoverer messageRecoverer)
    Set a MessageRecoverer when using retry within the adapter.
    recoveryCallback(org.springframework.retry.RecoveryCallback<?> recoveryCallback)
    Set a RecoveryCallback when using retry within the adapter.
    replyHeadersMappedLast(boolean replyHeadersMappedLast)
    When mapping headers for the outbound (reply) message, determine whether the headers are mapped before the message is converted, or afterwards.
    retryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)
    Set a RetryTemplate to use for retrying a message delivery within the adapter.

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

    autoStartup, errorChannel, errorChannel, errorOnTimeout, id, phase, replyChannel, replyChannel, replyMapper, replyTimeout, requestChannel, requestChannel, requestMapper, requestTimeout, shouldTrack

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

    _this, createInstance, destroyInstance, doGet, 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

    • AmqpBaseInboundGatewaySpec

      protected AmqpBaseInboundGatewaySpec(AmqpInboundGateway gateway)
  • Method Details

    • messageConverter

      public S messageConverter(org.springframework.amqp.support.converter.MessageConverter messageConverter)
      Configure the gateway's MessageConverter; defaults to SimpleMessageConverter.
      Parameters:
      messageConverter - the messageConverter.
      Returns:
      the spec.
      See Also:
    • headerMapper

      public S headerMapper(AmqpHeaderMapper headerMapper)
      Configure the gateway's AmqpHeaderMapper; defaults to DefaultAmqpHeaderMapper.
      Parameters:
      headerMapper - the headerMapper.
      Returns:
      the spec.
      See Also:
    • mappedRequestHeaders

      public S mappedRequestHeaders(String... headers)
      Only applies if the default header mapper is used.
      Parameters:
      headers - the headers.
      Returns:
      the spec.
      See Also:
      • AbstractHeaderMapper.setRequestHeaderNames(String[])
    • mappedReplyHeaders

      public S mappedReplyHeaders(String... headers)
      Only applies if the default header mapper is used.
      Parameters:
      headers - the headers.
      Returns:
      the spec.
      See Also:
      • AbstractHeaderMapper.setReplyHeaderNames(String[])
    • defaultReplyTo

      public S defaultReplyTo(String defaultReplyTo)
      The defaultReplyTo address with the form
       (exchange)/(routingKey)
       
      or
       (queueName)
       
      if the request message doesn't have a replyTo property. The second form uses the default exchange ("") and the queue name as the routing key.
      Parameters:
      defaultReplyTo - the default replyTo address to use.
      Returns:
      the spec.
      See Also:
    • retryTemplate

      public S retryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)
      Set a RetryTemplate to use for retrying a message delivery within the adapter.
      Parameters:
      retryTemplate - the template.
      Returns:
      the spec.
      Since:
      5.0.2
      See Also:
    • recoveryCallback

      public S recoveryCallback(org.springframework.retry.RecoveryCallback<?> recoveryCallback)
      Set a RecoveryCallback when using retry within the adapter.
      Parameters:
      recoveryCallback - the callback.
      Returns:
      the spec.
      Since:
      5.0.2
      See Also:
    • batchingStrategy

      public S batchingStrategy(org.springframework.amqp.rabbit.batch.BatchingStrategy batchingStrategy)
      Set a batching strategy to use when de-batching messages.
      Parameters:
      batchingStrategy - the strategy to use.
      Returns:
      the spec.
      Since:
      5.2.1
      See Also:
    • bindSourceMessage

      public S bindSourceMessage(boolean bindSourceMessage)
      Set to true to bind the source message in the headers.
      Parameters:
      bindSourceMessage - true to bind.
      Returns:
      the spec.
      Since:
      5.1.9
      See Also:
    • replyHeadersMappedLast

      public S replyHeadersMappedLast(boolean replyHeadersMappedLast)
      When mapping headers for the outbound (reply) message, determine whether the headers are mapped before the message is converted, or afterwards.
      Parameters:
      replyHeadersMappedLast - true if reply headers are mapped after conversion.
      Returns:
      the spec.
      Since:
      5.1.9
      See Also:
    • messageRecoverer

      public S messageRecoverer(org.springframework.amqp.rabbit.retry.MessageRecoverer messageRecoverer)
      Set a MessageRecoverer when using retry within the adapter.
      Parameters:
      messageRecoverer - the callback.
      Returns:
      the spec.
      Since:
      5.5
      See Also: