org.springframework.integration.dsl.context

Class IntegrationFlowContext

java.lang.Object

org.springframework.integration.dsl.context.IntegrationFlowContext

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware

public final class IntegrationFlowContext
extends java.lang.Object
implements org.springframework.beans.factory.BeanFactoryAware

A public API for dynamic (manual) registration of IntegrationFlows, not via standard bean registration phase.

The bean of this component is provided via framework automatically. A bean name is based on the decapitalized class name. It must be injected to the target service before use.

The typical use-case, and, therefore algorithm, is:

• create an IntegrationFlow instance depending of the business logic
• register that IntegrationFlow in this IntegrationFlowContext, with optional id and autoStartup flag
• obtain a MessagingTemplate for that IntegrationFlow (if it is started from the MessageChannel) and send (or send-and-receive) messages to the IntegrationFlow
• remove the IntegrationFlow by its id from this IntegrationFlowContext

For convenience an associated IntegrationFlowRegistration is returned after registration. It can be used for access to the target IntegrationFlow or for manipulation with its lifecycle.

Since:

5.0

Author:

Artem Bilan

See Also:

IntegrationFlowRegistration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IntegrationFlowContext.IntegrationFlowRegistrationBuilder

Method Summary

Modifier and Type	Method and Description
IntegrationFlowRegistration	getRegistrationById(java.lang.String flowId) Obtain an IntegrationFlowRegistration for the IntegrationFlow associated with the provided flowId.
java.util.Map<java.lang.String,IntegrationFlowRegistration>	getRegistry() Provide the state of the mapping of integration flow names to their IntegrationFlowRegistration instances.
boolean	isUseIdAsPrefix(java.lang.String flowId) Return true to prefix flow bean names with the flow id and a period.
MessagingTemplate	messagingTemplateFor(java.lang.String flowId) Obtain a MessagingTemplate with its default destination set to the input channel of the IntegrationFlow for provided flowId.
IntegrationFlowContext.IntegrationFlowRegistrationBuilder	registration(IntegrationFlow integrationFlow) Associate provided IntegrationFlow with an IntegrationFlowContext.IntegrationFlowRegistrationBuilder for additional options and farther registration in the application context.
void	remove(java.lang.String flowId) Destroy an IntegrationFlow bean (as well as all its dependant beans) for provided flowId and clean up all the local cache for it.
void	setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)

Methods inherited from class java.lang.Object

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

Method Detail

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
                    throws org.springframework.beans.BeansException

Specified by:

setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware

Throws:

org.springframework.beans.BeansException

registration

public IntegrationFlowContext.IntegrationFlowRegistrationBuilder registration(IntegrationFlow integrationFlow)

Associate provided IntegrationFlow with an IntegrationFlowContext.IntegrationFlowRegistrationBuilder for additional options and farther registration in the application context.

Parameters:

integrationFlow - the IntegrationFlow to register

Returns:

the IntegrationFlowRegistrationBuilder associated with the provided IntegrationFlow

isUseIdAsPrefix

public boolean isUseIdAsPrefix(java.lang.String flowId)

Return true to prefix flow bean names with the flow id and a period.

Parameters:

flowId - the flow id.

Returns:

true to use as a prefix.

Since:

5.0.6

getRegistrationById

public IntegrationFlowRegistration getRegistrationById(java.lang.String flowId)

Obtain an IntegrationFlowRegistration for the IntegrationFlow associated with the provided flowId.

Parameters:

flowId - the bean name to obtain

Returns:

the IntegrationFlowRegistration for provided id or null

remove

public void remove(java.lang.String flowId)

Destroy an IntegrationFlow bean (as well as all its dependant beans) for provided flowId and clean up all the local cache for it.

Parameters:

flowId - the bean name to destroy from

messagingTemplateFor

public MessagingTemplate messagingTemplateFor(java.lang.String flowId)

Obtain a MessagingTemplate with its default destination set to the input channel of the IntegrationFlow for provided flowId.

Any IntegrationFlow bean (not only manually registered) can be used for this method.

If IntegrationFlow doesn't start with the MessageChannel, the IllegalStateException is thrown.

Parameters:

flowId - the bean name to obtain the input channel from

Returns:

the MessagingTemplate instance

getRegistry

public java.util.Map<java.lang.String,IntegrationFlowRegistration> getRegistry()

Provide the state of the mapping of integration flow names to their IntegrationFlowRegistration instances.

Returns:

the registry of flow ids and their registration.