org.springframework.integration.dsl.context

Class StandardIntegrationFlowContext

java.lang.Object

org.springframework.integration.dsl.context.StandardIntegrationFlowContext

All Implemented Interfaces:

Aware, BeanFactoryAware, IntegrationFlowContext

public final class StandardIntegrationFlowContext
extends Object
implements IntegrationFlowContext, BeanFactoryAware

Standard implementation of IntegrationFlowContext.

Since:

5.1

Author:

Artem Bilan, Gary Russell, Alexander Shaklein

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder A Builder pattern implementation for the options to register IntegrationFlow in the application context.

Nested classes/interfaces inherited from interface org.springframework.integration.dsl.context.IntegrationFlowContext

IntegrationFlowContext.IntegrationFlowRegistration, IntegrationFlowContext.IntegrationFlowRegistrationBuilder

Method Summary

Modifier and Type	Method and Description
IntegrationFlowContext.IntegrationFlowRegistration	getRegistrationById(String flowId) Obtain an IntegrationFlowRegistration for the IntegrationFlow associated with the provided flowId.
Map<String,IntegrationFlowContext.IntegrationFlowRegistration>	getRegistry() Provide the state of the mapping of integration flow names to their IntegrationFlowRegistration instances.
boolean	isUseIdAsPrefix(String flowId) Return true to prefix flow bean names with the flow id and a period.
MessagingTemplate	messagingTemplateFor(String flowId) Obtain a MessagingTemplate with its default destination set to the input channel of the IntegrationFlow for provided flowId.
StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder	registration(IntegrationFlow integrationFlow) Associate provided IntegrationFlow with an StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder for additional options and farther registration in the application context.
void	remove(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(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(BeanFactory beanFactory)
                    throws BeansException

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

registration

public StandardIntegrationFlowContext.StandardIntegrationFlowRegistrationBuilder registration(IntegrationFlow integrationFlow)

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

Specified by:

registration in interface IntegrationFlowContext

Parameters:

integrationFlow - the IntegrationFlow to register

Returns:

the IntegrationFlowRegistrationBuilder associated with the provided IntegrationFlow

isUseIdAsPrefix

public boolean isUseIdAsPrefix(String flowId)

Description copied from interface: IntegrationFlowContext

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

Specified by:

isUseIdAsPrefix in interface IntegrationFlowContext

Parameters:

flowId - the flow id.

Returns:

true to use as a prefix.

getRegistrationById

public IntegrationFlowContext.IntegrationFlowRegistration getRegistrationById(String flowId)

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

Specified by:

getRegistrationById in interface IntegrationFlowContext

Parameters:

flowId - the bean name to obtain

Returns:

the IntegrationFlowRegistration for provided id or null

remove

public void remove(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.

Specified by:

remove in interface IntegrationFlowContext

Parameters:

flowId - the bean name to destroy from

messagingTemplateFor

public MessagingTemplate messagingTemplateFor(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.

Specified by:

messagingTemplateFor in interface IntegrationFlowContext

Parameters:

flowId - the bean name to obtain the input channel from

Returns:

the MessagingTemplate instance

getRegistry

public Map<String,IntegrationFlowContext.IntegrationFlowRegistration> getRegistry()

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

Specified by:

getRegistry in interface IntegrationFlowContext

Returns:

the registry of flow ids and their registration.