Package org.springframework.integration.dsl

Class IntegrationFlowDefinition<B extends IntegrationFlowDefinition<B>>

java.lang.Object

org.springframework.integration.dsl.BaseIntegrationFlowDefinition<B>

org.springframework.integration.dsl.IntegrationFlowDefinition<B>

Type Parameters:

B - the IntegrationFlowDefinition implementation type.

Direct Known Subclasses:

IntegrationFlowBuilder, IntegrationFlowExtension

public abstract class IntegrationFlowDefinition<B extends IntegrationFlowDefinition<B>>
extends BaseIntegrationFlowDefinition<B>

The BaseIntegrationFlowDefinition extension for syntax sugar with generics for some type-based EIP-methods when an expected payload type is assumed from upstream. For more explicit type conversion the methods with a Class argument are recommended for use.

Since:

5.0

Author:

Artem Bilan, Gary Russell, Gabriele Del Prete

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.dsl.BaseIntegrationFlowDefinition

BaseIntegrationFlowDefinition.ReplyProducerCleaner

Field Summary

Fields inherited from class org.springframework.integration.dsl.BaseIntegrationFlowDefinition

integrationComponents, PARSER

Method Summary

Modifier and Type	Method	Description
<P> B	filter(GenericSelector<P> genericSelector)	Populate a MessageFilter with MethodInvokingSelector for the provided GenericSelector.
<P> B	filter(GenericSelector<P> genericSelector, Consumer<FilterEndpointSpec> endpointConfigurer)	Populate a MessageFilter with MethodInvokingSelector for the provided GenericSelector.
<P> B	handle(GenericHandler<P> handler)	Populate a ServiceActivatingHandler for the MethodInvokingMessageProcessor to invoke the provided GenericHandler at runtime.
<P> B	handle(GenericHandler<P> handler, Consumer<GenericEndpointSpec<ServiceActivatingHandler>> endpointConfigurer)	Populate a ServiceActivatingHandler for the MethodInvokingMessageProcessor to invoke the provided GenericHandler at runtime.
<S, T> B	route(Function<S,T> router)	Populate the MethodInvokingRouter for provided Function with default options.
<S, T> B	route(Function<S,T> router, Consumer<RouterSpec<T,MethodInvokingRouter>> routerConfigurer)	Populate the MethodInvokingRouter for provided Function with provided options from RouterSpec.
<S, T> B	transform(GenericTransformer<S,T> genericTransformer)	Populate the MessageTransformingHandler instance for the provided GenericTransformer.

Methods inherited from class org.springframework.integration.dsl.BaseIntegrationFlowDefinition

_this, addComponent, addComponent, addComponents, aggregate, aggregate, aggregate, barrier, barrier, bridge, bridge, channel, channel, channel, channel, checkReuse, claimCheckIn, claimCheckIn, claimCheckOut, claimCheckOut, claimCheckOut, controlBus, controlBus, convert, convert, currentComponent, currentInterceptableChannel, currentMessageChannel, delay, delay, enrich, enrichHeaders, enrichHeaders, enrichHeaders, enrichHeaders, enrichHeaders, extractProxyTarget, filter, filter, filter, filter, filter, filter, filter, filter, filter, fixedSubscriberChannel, fixedSubscriberChannel, fluxTransform, gateway, gateway, gateway, gateway, gateway, gateway, get, getCurrentComponent, getCurrentMessageChannel, getIntegrationComponents, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handle, handleReactive, handleReactive, handleReactive, handleReactive, headerFilter, headerFilter, headerFilter, intercept, isImplicitChannel, isOutputChannelRequired, log, log, log, log, log, log, log, log, log, log, log, log, log, nullChannel, obtainInputChannelFromFlow, publishSubscribeChannel, publishSubscribeChannel, publishSubscribeChannel, register, registerOutputChannelIfCan, resequence, resequence, route, route, route, route, route, route, route, route, route, route, route, route, route, route, routeByException, routeToRecipients, scatterGather, scatterGather, scatterGather, scatterGather, scatterGather, scatterGather, setImplicitChannel, split, split, split, split, split, split, split, split, split, splitWith, to, toReactivePublisher, toReactivePublisher, transform, transform, transform, transform, transform, transform, transformWith, trigger, trigger, trigger, trigger, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap

Methods inherited from class java.lang.Object

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

Method Details

transform

public <S,
T> B transform(GenericTransformer<S,T> genericTransformer)

Populate the MessageTransformingHandler instance for the provided GenericTransformer. Use BaseIntegrationFlowDefinition.transform(Class, GenericTransformer) if you need to access the entire message. Shortcut for:

 
  .transformWith((transformerSpec) -> transformerSpec.function(genericTransformer))
 
 

Type Parameters:

S - the source type - 'transform from'.

T - the target type - 'transform to'.

Parameters:

genericTransformer - the GenericTransformer to populate.

Returns:

the current IntegrationFlowDefinition.

See Also:

• MethodInvokingTransformer
• LambdaMessageProcessor

filter

public <P> B filter(GenericSelector<P> genericSelector)

Populate a MessageFilter with MethodInvokingSelector for the provided GenericSelector. Typically used with a Java 8 Lambda expression:

 
  .filter("World"::equals)
 
 

Use BaseIntegrationFlowDefinition.filter(Class, GenericSelector) if you need to access the entire message.

Type Parameters:

P - the source payload type.

Parameters:

genericSelector - the GenericSelector to use.

Returns:

the current IntegrationFlowDefinition.

filter

public <P> B filter(GenericSelector<P> genericSelector,
 Consumer<FilterEndpointSpec> endpointConfigurer)

Populate a MessageFilter with MethodInvokingSelector for the provided GenericSelector. In addition, accept options for the integration endpoint using FilterEndpointSpec. Typically used with a Java 8 Lambda expression:

 
  .filter("World"::equals, e -> e.autoStartup(false))
 
 

Use BaseIntegrationFlowDefinition.filter(Class, GenericSelector, Consumer) if you need to access the entire message.

Type Parameters:

P - the source payload type.

Parameters:

genericSelector - the GenericSelector to use.

endpointConfigurer - the Consumer to provide integration endpoint options.

Returns:

the current IntegrationFlowDefinition.

See Also:

• FilterEndpointSpec

handle

public <P> B handle(GenericHandler<P> handler)

Populate a ServiceActivatingHandler for the MethodInvokingMessageProcessor to invoke the provided GenericHandler at runtime. Typically used with a Java 8 Lambda expression:

 
  .<Integer>handle((p, h) -> p / 2)
 
 

Use BaseIntegrationFlowDefinition.handle(Class, GenericHandler) if you need to access the entire message.

Type Parameters:

P - the payload type to expect.

Parameters:

handler - the handler to invoke.

Returns:

the current IntegrationFlowDefinition.

See Also:

• LambdaMessageProcessor

handle

public <P> B handle(GenericHandler<P> handler,
 Consumer<GenericEndpointSpec<ServiceActivatingHandler>> endpointConfigurer)

Populate a ServiceActivatingHandler for the MethodInvokingMessageProcessor to invoke the provided GenericHandler at runtime. In addition, accept options for the integration endpoint using GenericEndpointSpec. Typically used with a Java 8 Lambda expression:

 
  .<Integer>handle((p, h) -> p / 2, e -> e.autoStartup(false))
 
 

Use BaseIntegrationFlowDefinition.handle(Class, GenericHandler, Consumer) if you need to access the entire message.

Type Parameters:

P - the payload type to expect.

Parameters:

handler - the handler to invoke.

endpointConfigurer - the Consumer to provide integration endpoint options.

Returns:

the current IntegrationFlowDefinition.

See Also:

• LambdaMessageProcessor
• GenericEndpointSpec

route

public <S,
T> B route(Function<S,T> router)

Populate the MethodInvokingRouter for provided Function with default options. Typically used with a Java 8 Lambda expression:

 
  .route(p -> p.equals("foo") || p.equals("bar") ? new String[] {"foo", "bar"} : null)
 
 

Use BaseIntegrationFlowDefinition.route(Class, Function) if you need to access the entire message.

Type Parameters:

S - the source payload type.

T - the target result type.

Parameters:

router - the Function to use.

Returns:

the current IntegrationFlowDefinition.

route

public <S,
T> B route(Function<S,T> router,
 Consumer<RouterSpec<T,MethodInvokingRouter>> routerConfigurer)

Populate the MethodInvokingRouter for provided Function with provided options from RouterSpec. In addition, accept options for the integration endpoint using GenericEndpointSpec. Typically used with a Java 8 Lambda expression:

 
  .<Integer, Boolean>route(p -> p % 2 == 0,
                 m -> m.channelMapping("true", "evenChannel")
                       .subFlowMapping("false", f ->
                                   f.<Integer>handle((p, h) -> p * 3))
                       .applySequence(false))
 
 

Use BaseIntegrationFlowDefinition.route(Class, Function, Consumer) if you need to access the entire message.

Type Parameters:

S - the source payload type.

T - the target result type.

Parameters:

router - the Function to use.

routerConfigurer - the Consumer to provide MethodInvokingRouter options.

Returns:

the current IntegrationFlowDefinition.