Package org.springframework.kafka.listener

Class ContainerGroupSequencer

java.lang.Object

org.springframework.kafka.listener.ContainerGroupSequencer

All Implemented Interfaces:

EventListener, Aware, ApplicationContextAware, ApplicationListener<ListenerContainerIdleEvent>, Lifecycle, Phased, SmartLifecycle

public class ContainerGroupSequencer
extends Object
implements ApplicationContextAware, ApplicationListener<ListenerContainerIdleEvent>, SmartLifecycle

Sequence the starting of container groups when all containers in the previous group are idle.

Since:

2.7.3

Author:

Gary Russell

Field Summary

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
ContainerGroupSequencer(ListenerContainerRegistry registry, long defaultIdleEventInterval, String... containerGroups)	Set containers in each group to not auto start.

Method Summary

Modifier and Type	Method	Description
int	getPhase()
void	initialize()
boolean	isAutoStartup()
boolean	isRunning()
void	onApplicationEvent(ListenerContainerIdleEvent event)
void	setApplicationContext(ApplicationContext applicationContext)
void	setAutoStartup(boolean autoStartup)	Set to false to not automatically start.
void	setPhase(int phase)	Set the SmartLifecycle.getPhase().
void	setStopLastGroupWhenIdle(boolean stopLastGroupWhenIdle)	Set to true to stop the containers in the final group when they go idle.
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationListener

supportsAsyncExecution

Methods inherited from interface org.springframework.context.SmartLifecycle

stop

Constructor Details

ContainerGroupSequencer

public ContainerGroupSequencer(ListenerContainerRegistry registry,
 long defaultIdleEventInterval,
 String... containerGroups)

Set containers in each group to not auto start. Start the containers in the first group. Start containers in group[n] when all containers in group[n-1] are idle; stop the containers in group[n-1].

Parameters:

registry - the registry.

defaultIdleEventInterval - the idle event interval if not already set.

containerGroups - The list of container groups, in order.

Method Details

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setStopLastGroupWhenIdle

public void setStopLastGroupWhenIdle(boolean stopLastGroupWhenIdle)

Set to true to stop the containers in the final group when they go idle. By default, the containers in the final group remain running.

Parameters:

stopLastGroupWhenIdle - true to stop containers in the final group.

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

setAutoStartup

public void setAutoStartup(boolean autoStartup)

Set to false to not automatically start.

Parameters:

autoStartup - false to not start;

Since:

2.7.6

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

setPhase

public void setPhase(int phase)

Set the SmartLifecycle.getPhase().

Parameters:

phase - the phase.

Since:

2.7.6

onApplicationEvent

public void onApplicationEvent(ListenerContainerIdleEvent event)

Specified by:

onApplicationEvent in interface ApplicationListener<ListenerContainerIdleEvent>

start

public void start()

Specified by:

start in interface Lifecycle

initialize

public void initialize()

stop

public void stop()

Specified by:

stop in interface Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle