Package org.springframework.cloud.stream.binding

Class BindingsLifecycleController

java.lang.Object

org.springframework.cloud.stream.binding.BindingsLifecycleController

public class BindingsLifecycleController
extends Object

Lifecycle controller for the bindings. It is registered as a bean and once injected could be used to control the lifecycle f the bindings.

Since:

3.x

Author:

Oleg Zhurakousky

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BindingsLifecycleController.State	Binding states.

Constructor Summary

Constructors

Constructor	Description
BindingsLifecycleController(List<InputBindingLifecycle> inputBindingLifecycles, List<OutputBindingLifecycle> outputBindingsLifecycles)

Method Summary

Modifier and Type	Method	Description
void	changeState(String bindingName, BindingsLifecycleController.State state)	General purpose method to change the state of the provided binding.
void	pause(String bindingName)	Convenience method to pause the binding with provided `bindingName`.
List<Binding<?>>	queryState(String name)	Queries the individual state of a binding.
List<Map<?,?>>	queryStates()	Queries the List of states for all available bindings.
void	resume(String bindingName)	Convenience method to resume the binding with provided `bindingName`.
void	start(String bindingName)	Convenience method to start the binding with provided `bindingName`.
void	stop(String bindingName)	Convenience method to stop the binding with provided `bindingName`.

Methods inherited from class java.lang.Object

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

Constructor Detail

BindingsLifecycleController

public BindingsLifecycleController(List<InputBindingLifecycle> inputBindingLifecycles,
                                   List<OutputBindingLifecycle> outputBindingsLifecycles)

Method Detail

stop

public void stop(String bindingName)

Convenience method to stop the binding with provided `bindingName`.

Parameters:

bindingName - the name of the binding.

start

public void start(String bindingName)

Convenience method to start the binding with provided `bindingName`.

Parameters:

bindingName - the name of the binding.

pause

public void pause(String bindingName)

Convenience method to pause the binding with provided `bindingName`.

Parameters:

bindingName - the name of the binding.

resume

public void resume(String bindingName)

Convenience method to resume the binding with provided `bindingName`.

Parameters:

bindingName - the name of the binding.

changeState

public void changeState(String bindingName,
                        BindingsLifecycleController.State state)

General purpose method to change the state of the provided binding.

Parameters:

bindingName - the name of the binding.

state - the BindingsLifecycleController.State you wish to set this binding to

queryStates

public List<Map<?,?>> queryStates()

Queries the List of states for all available bindings. The returned list consists of Binding objects which could be further interrogated using Binding.isPaused() and Binding.isRunning().

Returns:

the list of Bindings

queryState

public List<Binding<?>> queryState(String name)

Queries the individual state of a binding. The returned list Binding object could be further interrogated using Binding.isPaused() and Binding.isRunning().

Returns:

collection of Binding objects.