Package org.springframework.amqp.rabbit.listener

Interface RabbitListenerEndpoint

All Known Implementing Classes:
AbstractRabbitListenerEndpoint, MethodRabbitListenerEndpoint, MultiMethodRabbitListenerEndpoint, SimpleRabbitListenerEndpoint
public interface RabbitListenerEndpoint
Model for a Rabbit listener endpoint. Can be used against a RabbitListenerConfigurer to register endpoints programmatically.
Since:
1.4
Author:
Stephane Nicoll, Gary Russell

  • Method Details

    • getId

      String getId()
      Returns:
      the id of this endpoint. The id can be further qualified when the endpoint is resolved against its actual listener container.
      See Also:

    • getGroup

      String getGroup()
      Returns:
      the group of this endpoint or null if not in a group.
      Since:
      1.5

    • getConcurrency

      String getConcurrency()
      Returns:
      the concurrency of this endpoint.
      Since:
      2.0

    • getAutoStartup

      Boolean getAutoStartup()
      Override of the default autoStartup property.
      Returns:
      the autoStartup.
      Since:
      2.0

    • setupListenerContainer

      void setupListenerContainer(MessageListenerContainer listenerContainer)
      Setup the specified message listener container with the model defined by this endpoint.

      This endpoint must provide the requested missing option(s) of the specified container to make it usable. Usually, this is about setting the queues and the messageListener to use but an implementation may override any default setting that was already set.

      Parameters:
      listenerContainer - the listener container to configure

    • setMessageConverter

      default void setMessageConverter(MessageConverter converter)
      The preferred way for a container factory to pass a message converter to the endpoint's adapter.
      Parameters:
      converter - the converter.
      Since:
      2.0.8

    • getMessageConverter

      @Nullable default MessageConverter getMessageConverter()
      Used by the container factory to check if this endpoint supports the preferred way for a container factory to pass a message converter to the endpoint's adapter. If null is returned, the factory will fall back to the legacy method of passing the converter via the container.
      Returns:
      the converter.
      Since:
      2.0.8

    • getTaskExecutor

      @Nullable default TaskExecutor getTaskExecutor()
      Get the task executor to use for this endpoint's listener container. Overrides any executor set on the container factory.
      Returns:
      the executor.
      Since:
      2.2

    • setBatchListener

      default void setBatchListener(boolean batchListener)
      Called by the container factory with the factory's batchListener property.
      Parameters:
      batchListener - the batchListener to set.
      Since:
      2.2

    • setBatchingStrategy

      default void setBatchingStrategy(BatchingStrategy batchingStrategy)
      Set a BatchingStrategy to use when debatching messages.
      Parameters:
      batchingStrategy - the batching strategy.
      Since:
      2.2
      See Also:

    • getAckMode

      @Nullable default AcknowledgeMode getAckMode()
      Override the container factory's AcknowledgeMode.
      Returns:
      the acknowledgment mode.
      Since:
      2.2

    • getReplyPostProcessor

      @Nullable default ReplyPostProcessor getReplyPostProcessor()
      Return a ReplyPostProcessor to post process a reply message before it is sent.
      Returns:
      the post processor.
      Since:
      2.2.5

    • getReplyContentType

      @Nullable default String getReplyContentType()
      Get the reply content type.
      Returns:
      the content type.
      Since:
      2.3

    • isConverterWinsContentType

      default boolean isConverterWinsContentType()
      Return whether the content type set by a converter prevails or not.
      Returns:
      false to always apply the reply content type.
      Since:
      2.3