Package org.springframework.kafka.listener

Class ListenerContainerPauseService

  • public class ListenerContainerPauseService
extends java.lang.Object
    Service for pausing and resuming of MessageListenerContainer.
    Since:
    2.9

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void pause​(java.lang.String listenerId, java.time.Duration pauseDuration)
      Pause the listener by given id.
      void pause​(MessageListenerContainer messageListenerContainer, java.time.Duration pauseDuration)
      Pause the listener by given container instance.
      void pausePartition​(MessageListenerContainer messageListenerContainer, org.apache.kafka.common.TopicPartition partition, java.time.Duration pauseDuration)
      Pause consumption from a given partition for the duration.
      void resume​(java.lang.String listenerId)
      Resume the listener container by given id.
      void resume​(MessageListenerContainer messageListenerContainer)
      Resume the listener container.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ListenerContainerPauseService

        public ListenerContainerPauseService​(@Nullable
                                     ListenerContainerRegistry registry,
                                     org.springframework.scheduling.TaskScheduler scheduler)
        Create an instance with the provided registry and scheduler.
        Parameters:
        registry - the registry or null.
        scheduler - the scheduler.

    • Method Detail

      • pause

        public void pause​(java.lang.String listenerId,
                  java.time.Duration pauseDuration)
        Pause the listener by given id. Checks if the listener has already been requested to pause. Sets executor schedule for resuming the same listener after pauseDuration.
        Parameters:
        listenerId - the id of the listener
        pauseDuration - duration between pause() and resume() actions

      • pause

        public void pause​(MessageListenerContainer messageListenerContainer,
                  java.time.Duration pauseDuration)
        Pause the listener by given container instance. Checks if the listener has already been requested to pause. Sets executor schedule for resuming the same listener after pauseDuration.
        Parameters:
        messageListenerContainer - the listener container
        pauseDuration - duration between pause() and resume() actions

      • pausePartition

        public void pausePartition​(MessageListenerContainer messageListenerContainer,
                           org.apache.kafka.common.TopicPartition partition,
                           java.time.Duration pauseDuration)
        Pause consumption from a given partition for the duration.
        Parameters:
        messageListenerContainer - the container.
        partition - the partition.
        pauseDuration - the duration.

      • resume

        public void resume​(java.lang.String listenerId)
        Resume the listener container by given id.
        Parameters:
        listenerId - the id of the listener

      • resume

        public void resume​(MessageListenerContainer messageListenerContainer)
        Resume the listener container.
        Parameters:
        messageListenerContainer - the listener container