org.springframework.cloud.stream.binder

Interface Binding<T>

All Superinterfaces:

org.springframework.context.Lifecycle, org.springframework.integration.endpoint.Pausable

All Known Implementing Classes:

DefaultBinding

public interface Binding<T>
extends org.springframework.integration.endpoint.Pausable

Represents a binding between an input or output and an adapter endpoint that connects via a Binder. The binding could be for a consumer or a producer. A consumer binding represents a connection from an adapter to an input. A producer binding represents a connection from an output to an adapter.

Author:

Jennifer Hickey, Mark Fisher, Gary Russell, Marius Bogoevici, Oleg Zhurakousky

See Also:

EnableBinding

Method Summary

Modifier and Type	Method and Description
default Map<String,Object>	getExtendedInfo()
default String	getName() Returns the name of this binding (i.e., channel name)
default boolean	isRunning() Returns 'true' if the target component represented by this instance is running.
default void	pause() Pauses the target component represented by this instance if and only if the component implements Pausable interface NOTE: At the time the instance is created the component is already started and active.
default void	resume() Resumes the target component represented by this instance if and only if the component implements Pausable interface NOTE: At the time the instance is created the component is already started and active.
default void	start() Stops the target component represented by this instance.
default void	stop() Starts the target component represented by this instance.
void	unbind() Unbinds the target component represented by this instance and stops any active components.

Method Detail

getExtendedInfo

default Map<String,Object> getExtendedInfo()

start

default void start()

Stops the target component represented by this instance. NOTE: At the time the instance is created the component is already started. This operation is typically used by actuator to re-bind/re-start.

Specified by:

start in interface org.springframework.context.Lifecycle

See Also:

BindingsEndpoint

stop

default void stop()

Starts the target component represented by this instance. NOTE: At the time the instance is created the component is already started. This operation is typically used by actuator to re-bind/re-start.

Specified by:

stop in interface org.springframework.context.Lifecycle

See Also:

BindingsEndpoint

pause

default void pause()

Pauses the target component represented by this instance if and only if the component implements Pausable interface NOTE: At the time the instance is created the component is already started and active. This operation is typically used by actuator to pause/resume.

Specified by:

pause in interface org.springframework.integration.endpoint.Pausable

See Also:

BindingsEndpoint

resume

default void resume()

Resumes the target component represented by this instance if and only if the component implements Pausable interface NOTE: At the time the instance is created the component is already started and active. This operation is typically used by actuator to pause/resume.

Specified by:

resume in interface org.springframework.integration.endpoint.Pausable

See Also:

BindingsEndpoint

isRunning

default boolean isRunning()

Returns 'true' if the target component represented by this instance is running.

Specified by:

isRunning in interface org.springframework.context.Lifecycle

getName

default String getName()

Returns the name of this binding (i.e., channel name)

Returns:

binding name

unbind

void unbind()

Unbinds the target component represented by this instance and stops any active components. Implementations must be idempotent. After this method is invoked, the target is not expected to receive any messages; this instance should be discarded, and a new Binding should be created instead.