Package org.springframework.integration.core

Interface Pausable

All Superinterfaces:

Lifecycle, ManageableLifecycle

All Known Implementing Classes:

KafkaInboundGateway, KafkaMessageDrivenChannelAdapter, KafkaMessageSource

public interface Pausable
extends ManageableLifecycle

Endpoints implementing this interface can be paused/resumed. A paused endpoint might still maintain a connection to an external system, but will not send or receive messages.

Since:

5.0.3

Author:

Gary Russell, Artem Bilan

Method Summary

Modifier and Type	Method	Description
default boolean	isPaused()	Check if the endpoint is paused.
void	pause()	Pause the endpoint.
void	resume()	Resume the endpoint if paused.

Methods inherited from interface org.springframework.integration.support.management.ManageableLifecycle

isRunning, start, stop

Method Details

pause

@ManagedOperation(description="Pause the component")
@Reflective
void pause()

Pause the endpoint.

resume

@ManagedOperation(description="Resume the component")
@Reflective
void resume()

Resume the endpoint if paused.

isPaused

@ManagedAttribute(description="Is the component paused?")
@Reflective
default boolean isPaused()

Check if the endpoint is paused.

Returns:

true if paused.

Since:

5.4