Package org.springframework.integration.dsl.context

Interface IntegrationFlowContext.IntegrationFlowRegistrationBuilder

All Known Implementing Classes:

StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder

Enclosing interface:

IntegrationFlowContext

public static interface IntegrationFlowContext.IntegrationFlowRegistrationBuilder

A Builder pattern implementation for the options to register IntegrationFlow in the application context.

Method Summary

Modifier and Type	Method	Description
IntegrationFlowContext.IntegrationFlowRegistrationBuilder	addBean(Object bean)	Add an object which will be registered as an IntegrationFlow dependant bean in the application context.
IntegrationFlowContext.IntegrationFlowRegistrationBuilder	addBean(String name, Object bean)	Add an object which will be registered as an IntegrationFlow dependant bean in the application context.
IntegrationFlowContext.IntegrationFlowRegistrationBuilder	autoStartup(boolean autoStartup)	The boolean flag to indication if an IntegrationFlow must be started automatically after registration.
IntegrationFlowContext.IntegrationFlowRegistrationBuilder	id(String id)	Specify an id for the IntegrationFlow to register.
IntegrationFlowContext.IntegrationFlowRegistration	register()	Register an IntegrationFlow and all the dependant and support components in the application context and return an associated IntegrationFlowContext.IntegrationFlowRegistration control object.
IntegrationFlowContext.IntegrationFlowRegistrationBuilder	setDescription(String description)	Set a human-readable description of this integration flow.
IntegrationFlowContext.IntegrationFlowRegistrationBuilder	setSource(Object source)	Set the configuration source Object for this manual Integration flow definition.
default IntegrationFlowContext.IntegrationFlowRegistrationBuilder	useFlowIdAsPrefix()	Invoke this method to prefix bean names in the flow with the (required) flow id and a period.

Method Details

id

IntegrationFlowContext.IntegrationFlowRegistrationBuilder id(String id)

Specify an id for the IntegrationFlow to register. Must be unique per context. The registration with this id must be destroyed before reusing for a new IntegrationFlow instance.

Parameters:

id - the id for the IntegrationFlow to register

Returns:

the current builder instance

autoStartup

IntegrationFlowContext.IntegrationFlowRegistrationBuilder autoStartup(boolean autoStartup)

The boolean flag to indication if an IntegrationFlow must be started automatically after registration. Defaults to true.

Parameters:

autoStartup - start or not the IntegrationFlow automatically after registration.

Returns:

the current builder instance

addBean

IntegrationFlowContext.IntegrationFlowRegistrationBuilder addBean(Object bean)

Add an object which will be registered as an IntegrationFlow dependant bean in the application context. Usually it is some support component, which needs an application context. For example dynamically created connection factories or header mappers for AMQP, JMS, TCP etc.

Parameters:

bean - an additional arbitrary bean to register into the application context.

Returns:

the current builder instance

addBean

IntegrationFlowContext.IntegrationFlowRegistrationBuilder addBean(@Nullable
 String name,
 Object bean)

Add an object which will be registered as an IntegrationFlow dependant bean in the application context. Usually it is some support component, which needs an application context. For example dynamically created connection factories or header mappers for AMQP, JMS, TCP etc.

Parameters:

name - the name for the bean to register.

bean - an additional arbitrary bean to register into the application context.

Returns:

the current builder instance

setSource

IntegrationFlowContext.IntegrationFlowRegistrationBuilder setSource(Object source)

Set the configuration source Object for this manual Integration flow definition. Can be any arbitrary object which could easily lead to a source code for the flow when a messaging exception happens at runtime.

Parameters:

source - the configuration source representation.

Returns:

the current builder instance

Since:

5.2

setDescription

IntegrationFlowContext.IntegrationFlowRegistrationBuilder setDescription(String description)

Set a human-readable description of this integration flow.

Parameters:

description - the description for integration flow instance.

Returns:

the current builder instance

Since:

6.4

useFlowIdAsPrefix

default IntegrationFlowContext.IntegrationFlowRegistrationBuilder useFlowIdAsPrefix()

Invoke this method to prefix bean names in the flow with the (required) flow id and a period. This is useful if you wish to register the same flow multiple times while retaining the ability to reference beans within the flow; adding the unique flow id to the bean name makes the name unique.

Returns:

the current builder instance.

Since:

5.0.6

See Also:

• id(String)

register

IntegrationFlowContext.IntegrationFlowRegistration register()

Register an IntegrationFlow and all the dependant and support components in the application context and return an associated IntegrationFlowContext.IntegrationFlowRegistration control object.

Returns:

the IntegrationFlowContext.IntegrationFlowRegistration instance.