IntegrationFlowContext (Spring Integration 5.4.14-SNAPSHOT API)

All Known Implementing Classes:

StandardIntegrationFlowContext
```
public interface IntegrationFlowContext
```
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 IntegrationFlowContext.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, Gary Russell, Artem Vozhdayenko

See Also:

IntegrationFlowContext.IntegrationFlowRegistration

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`IntegrationFlowContext.IntegrationFlowRegistration`
`static interface`	`IntegrationFlowContext.IntegrationFlowRegistrationBuilder` A Builder pattern implementation for the options to register `IntegrationFlow` in the application context.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`IntegrationFlowContext.IntegrationFlowRegistration`	`getRegistrationById(String flowId)` Obtain an `IntegrationFlowContext.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 `IntegrationFlowContext.IntegrationFlowRegistration` instances.
`default 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`.
`IntegrationFlowContext.IntegrationFlowRegistrationBuilder`	`registration(IntegrationFlow integrationFlow)` Associate provided `IntegrationFlow` with an `IntegrationFlowContext.IntegrationFlowRegistrationBuilder` 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.

- Method Detail
  - registration
```
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
  - getRegistrationById
```
IntegrationFlowContext.IntegrationFlowRegistration getRegistrationById(String flowId)
```
    Obtain an IntegrationFlowContext.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
```
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.
    
    Parameters:
    
    flowId - the bean name to destroy from
  - messagingTemplateFor
```
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.
    
    Parameters:
    
    flowId - the bean name to obtain the input channel from
    
    Returns:
    
    the MessagingTemplate instance
  - getRegistry
```
Map<String,IntegrationFlowContext.IntegrationFlowRegistration> getRegistry()
```
    Provide the state of the mapping of integration flow names to their IntegrationFlowContext.IntegrationFlowRegistration instances.
    
    Returns:
    
    the registry of flow ids and their registration.
  - isUseIdAsPrefix
```
default boolean isUseIdAsPrefix(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

Interface IntegrationFlowContext

Nested Class Summary

Method Summary

Method Detail

registration

getRegistrationById

remove

messagingTemplateFor

getRegistry

isUseIdAsPrefix