Class StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder

java.lang.Object

org.springframework.integration.dsl.context.StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder

All Implemented Interfaces:

IntegrationFlowContext.IntegrationFlowRegistrationBuilder

Enclosing class:

StandardIntegrationFlowContext

public final class StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder
extends Object
implements IntegrationFlowContext.IntegrationFlowRegistrationBuilder

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

Since:

5.1

Author:

Artem Bilan, Gary Russell, Alexander Shaklein, Artem Vozhdayenko

Method Summary

Modifier and Type	Method	Description
StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder	addBean(Object bean)	Add an object which will be registered as an IntegrationFlow dependant bean in the application context.
StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder	addBean(String name, Object bean)	Add an object which will be registered as an IntegrationFlow dependant bean in the application context.
StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder	autoStartup(boolean autoStartupToSet)	The boolean flag to indication if an IntegrationFlow must be started automatically after registration.
StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder	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	setSource(Object source)	Set the configuration source Object for this manual Integration flow definition.
IntegrationFlowContext.IntegrationFlowRegistrationBuilder	useFlowIdAsPrefix()	Invoke this method to prefix bean names in the flow with the (required) flow id and a period.

Methods inherited from class java.lang.Object

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

Method Details

id

public StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder 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.

Specified by:

id in interface IntegrationFlowContext.IntegrationFlowRegistrationBuilder

Parameters:

id - the id for the IntegrationFlow to register

Returns:

the current builder instance

autoStartup

public StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder autoStartup(boolean autoStartupToSet)

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

Specified by:

autoStartup in interface IntegrationFlowContext.IntegrationFlowRegistrationBuilder

Parameters:

autoStartupToSet - start or not the IntegrationFlow automatically after registration.

Returns:

the current builder instance

addBean

public StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder 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.

Specified by:

addBean in interface IntegrationFlowContext.IntegrationFlowRegistrationBuilder

Parameters:

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

Returns:

the current builder instance

addBean

public StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder 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.

Specified by:

addBean in interface IntegrationFlowContext.IntegrationFlowRegistrationBuilder

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

public IntegrationFlowContext.IntegrationFlowRegistrationBuilder setSource(Object source)

Description copied from interface: IntegrationFlowContext.IntegrationFlowRegistrationBuilder

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.

Specified by:

setSource in interface IntegrationFlowContext.IntegrationFlowRegistrationBuilder

Parameters:

source - the configuration source representation.

Returns:

the current builder instance

useFlowIdAsPrefix

public IntegrationFlowContext.IntegrationFlowRegistrationBuilder useFlowIdAsPrefix()

Description copied from interface: IntegrationFlowContext.IntegrationFlowRegistrationBuilder

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.

Specified by:

useFlowIdAsPrefix in interface IntegrationFlowContext.IntegrationFlowRegistrationBuilder

Returns:

the current builder instance.

See Also:

• IntegrationFlowContext.IntegrationFlowRegistrationBuilder.id(String)

register

public 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.

Specified by:

register in interface IntegrationFlowContext.IntegrationFlowRegistrationBuilder

Returns:

the IntegrationFlowContext.IntegrationFlowRegistration instance.