org.springframework.integration.dsl

Class StandardIntegrationFlow

java.lang.Object

org.springframework.integration.dsl.StandardIntegrationFlow

All Implemented Interfaces:

Lifecycle, Phased, SmartLifecycle, IntegrationFlow

public class StandardIntegrationFlow
extends Object
implements IntegrationFlow, SmartLifecycle

The standard implementation of the IntegrationFlow interface instantiated by the Framework. Represents a logical container for the components configured for the integration flow. It can be treated as a single component, especially when declaring dynamically, using the IntegrationFlowContext.

Being the logical container for the target integration components, this class controls the lifecycle of all those components, when its start() and stop() are invoked.

This component is never autoStartup, because all the components are registered as beans in the application context and their initial start up phase is controlled from the lifecycle processor automatically.

However, when we register an IntegrationFlow dynamically using the IntegrationFlowContext API, the lifecycle processor from the application context is not involved; therefore we should control the lifecycle of the beans manually, or rely on the IntegrationFlowContext API. Its created registration is autoStartup by default and starts the flow when it is registered. If you disable the registration's auto- startup behavior, you are responsible for starting the flow or its component beans.

This component doesn't track its running state during stop() action and delegates directly to stop the registered components, to avoid dangling processes after a registered IntegrationFlow is removed from the flow context.

Since:

5.0

Author:

Artem Bilan

See Also:

IntegrationFlows, IntegrationFlowBeanPostProcessor, IntegrationFlowContext, SmartLifecycle

Field Summary

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Method Summary

Modifier and Type	Method and Description
void	configure(IntegrationFlowDefinition<?> flow) The callback-based function to declare the chain of EIP-methods to configure an integration flow with the provided IntegrationFlowDefinition.
MessageChannel	getInputChannel() Return the first MessageChannel component which is essential a flow input channel.
Map<Object,String>	getIntegrationComponents()
int	getPhase()
boolean	isAutoStartup()
boolean	isRunning()
void	setIntegrationComponents(Map<Object,String> integrationComponents)
void	start()
void	stop()
void	stop(Runnable callback)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

configure

public void configure(IntegrationFlowDefinition<?> flow)

Description copied from interface: IntegrationFlow

The callback-based function to declare the chain of EIP-methods to configure an integration flow with the provided IntegrationFlowDefinition.

Specified by:

configure in interface IntegrationFlow

Parameters:

flow - the IntegrationFlowDefinition to configure

getInputChannel

public MessageChannel getInputChannel()

Description copied from interface: IntegrationFlow

Return the first MessageChannel component which is essential a flow input channel.

Specified by:

getInputChannel in interface IntegrationFlow

Returns:

the channel.

setIntegrationComponents

public void setIntegrationComponents(Map<Object,String> integrationComponents)

getIntegrationComponents

public Map<Object,String> getIntegrationComponents()

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface SmartLifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

toString

public String toString()

Overrides:

toString in class Object