org.springframework.integration.dsl.context

Class IntegrationFlowContext.IntegrationFlowRegistrationBuilder

java.lang.Object

org.springframework.integration.dsl.context.IntegrationFlowContext.IntegrationFlowRegistrationBuilder

Enclosing class:

IntegrationFlowContext

public final class IntegrationFlowContext.IntegrationFlowRegistrationBuilder
extends java.lang.Object

Since:

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

Author:

Gary Russell

Method Summary

Modifier and Type	Method and Description
IntegrationFlowContext.IntegrationFlowRegistrationBuilder	addBean(java.lang.Object bean) Add an object which will be registered as an IntegrationFlow dependant bean in the application context.
IntegrationFlowContext.IntegrationFlowRegistrationBuilder	addBean(java.lang.String name, java.lang.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(java.lang.String id) Specify an id for the IntegrationFlow to register.
IntegrationFlowRegistration	register() Register an IntegrationFlow and all the dependant and support components in the application context and return an associated IntegrationFlowRegistration control object.
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 Detail

id

public IntegrationFlowContext.IntegrationFlowRegistrationBuilder id(java.lang.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

public 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

public IntegrationFlowContext.IntegrationFlowRegistrationBuilder addBean(java.lang.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

public IntegrationFlowContext.IntegrationFlowRegistrationBuilder addBean(java.lang.String name,
                                                                         java.lang.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

useFlowIdAsPrefix

public 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

public IntegrationFlowRegistration register()

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

Returns:

the IntegrationFlowRegistration instance.