Package org.springframework.integration.dsl

Class IntegrationFlows

java.lang.Object

org.springframework.integration.dsl.IntegrationFlows

public final class IntegrationFlows
extends java.lang.Object

The central factory for fluent IntegrationFlowBuilder API.

Since:

5.0

See Also:

IntegrationFlowBeanPostProcessor

Method Summary

Modifier and Type	Method	Description
static IntegrationFlowBuilder	from(java.lang.Class<?> serviceInterface)	Populate the MessageChannel to the new IntegrationFlowBuilder chain, which becomes as a requestChannel for the Messaging Gateway(s) built on the provided service interface.
static IntegrationFlowBuilder	from(java.lang.Class<?> serviceInterface, java.util.function.Consumer<GatewayProxySpec> endpointConfigurer)	Populate the MessageChannel to the new IntegrationFlowBuilder chain, which becomes as a requestChannel for the Messaging Gateway(s) built on the provided service interface.
static IntegrationFlowBuilder	from(java.lang.String messageChannelName)	Populate the MessageChannel name to the new IntegrationFlowBuilder chain.
static IntegrationFlowBuilder	from(java.lang.String messageChannelName, boolean fixedSubscriber)	Populate the MessageChannel name to the new IntegrationFlowBuilder chain.
static IntegrationFlowBuilder	from(org.reactivestreams.Publisher<? extends org.springframework.messaging.Message<?>> publisher)	Populate a FluxMessageChannel to the IntegrationFlowBuilder chain and subscribe it to the provided Publisher.
static IntegrationFlowBuilder	from(MessageSource<?> messageSource)	Populate the provided MessageSource object to the IntegrationFlowBuilder chain.
static IntegrationFlowBuilder	from(MessageSource<?> messageSource, java.util.function.Consumer<SourcePollingChannelAdapterSpec> endpointConfigurer)	Populate the provided MessageSource object to the IntegrationFlowBuilder chain.
static IntegrationFlowBuilder	from(IntegrationFlow other)	Start the flow with a composition from the IntegrationFlow.
static IntegrationFlowBuilder	from(MessageChannelSpec<?,?> messageChannelSpec)	Populate the MessageChannel object to the IntegrationFlowBuilder chain using the fluent API from MessageChannelSpec.
static IntegrationFlowBuilder	from(MessageProducerSpec<?,?> messageProducerSpec)	Populate the MessageProducerSupport object to the IntegrationFlowBuilder chain using the fluent API from the MessageProducerSpec.
static IntegrationFlowBuilder	from(MessageSourceSpec<?,? extends MessageSource<?>> messageSourceSpec)	Populate the MessageSource object to the IntegrationFlowBuilder chain using the fluent API from the provided MessageSourceSpec.
static IntegrationFlowBuilder	from(MessageSourceSpec<?,? extends MessageSource<?>> messageSourceSpec, java.util.function.Consumer<SourcePollingChannelAdapterSpec> endpointConfigurer)	Populate the MessageSource object to the IntegrationFlowBuilder chain using the fluent API from the provided MessageSourceSpec.
static IntegrationFlowBuilder	from(MessagingGatewaySpec<?,?> inboundGatewaySpec)	Populate the MessagingGatewaySupport object to the IntegrationFlowBuilder chain using the fluent API from the MessagingGatewaySpec.
static IntegrationFlowBuilder	from(MessageProducerSupport messageProducer)	Populate the provided MessageProducerSupport object to the IntegrationFlowBuilder chain.
static IntegrationFlowBuilder	from(MessagingGatewaySupport inboundGateway)	Populate the provided MessagingGatewaySupport object to the IntegrationFlowBuilder chain.
static IntegrationFlowBuilder	from(org.springframework.messaging.MessageChannel messageChannel)	Populate the provided MessageChannel object to the IntegrationFlowBuilder chain.
static <T> IntegrationFlowBuilder	fromSupplier(java.util.function.Supplier<T> messageSource)	Provides Supplier as source of messages to the integration flow which will be triggered by the application context's default poller (which must be declared).
static <T> IntegrationFlowBuilder	fromSupplier(java.util.function.Supplier<T> messageSource, java.util.function.Consumer<SourcePollingChannelAdapterSpec> endpointConfigurer)	Provides Supplier as source of messages to the integration flow.

Methods inherited from class java.lang.Object

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

Method Details

from

public static IntegrationFlowBuilder from(java.lang.String messageChannelName)

Populate the MessageChannel name to the new IntegrationFlowBuilder chain. The IntegrationFlow inputChannel.

Parameters:

messageChannelName - the name of existing MessageChannel bean. The new DirectChannel bean will be created on context startup if there is no bean with this name.

Returns:

new IntegrationFlowBuilder.

from

public static IntegrationFlowBuilder from(java.lang.String messageChannelName, boolean fixedSubscriber)

Populate the MessageChannel name to the new IntegrationFlowBuilder chain. Typically for the FixedSubscriberChannel together with fixedSubscriber = true. The IntegrationFlow inputChannel.

Parameters:

messageChannelName - the name for DirectChannel or FixedSubscriberChannel to be created on context startup, not reference. The MessageChannel depends on the fixedSubscriber boolean argument.

fixedSubscriber - the boolean flag to determine if result MessageChannel should be DirectChannel, if false or FixedSubscriberChannel, if true.

Returns:

new IntegrationFlowBuilder.

See Also:

DirectChannel, FixedSubscriberChannel

from

public static IntegrationFlowBuilder from(MessageChannelSpec<?,?> messageChannelSpec)

Populate the MessageChannel object to the IntegrationFlowBuilder chain using the fluent API from MessageChannelSpec. The IntegrationFlow inputChannel.

Parameters:

messageChannelSpec - the MessageChannelSpec to populate MessageChannel instance.

Returns:

new IntegrationFlowBuilder.

See Also:

MessageChannels

from

public static IntegrationFlowBuilder from(org.springframework.messaging.MessageChannel messageChannel)

Populate the provided MessageChannel object to the IntegrationFlowBuilder chain. The IntegrationFlow inputChannel.

Parameters:

messageChannel - the MessageChannel to populate.

Returns:

new IntegrationFlowBuilder.

from

public static IntegrationFlowBuilder from(MessageSourceSpec<?,? extends MessageSource<?>> messageSourceSpec)

Populate the MessageSource object to the IntegrationFlowBuilder chain using the fluent API from the provided MessageSourceSpec. The IntegrationFlow startMessageSource.

Parameters:

messageSourceSpec - the MessageSourceSpec to use.

Returns:

new IntegrationFlowBuilder.

See Also:

and its implementations.

from

public static IntegrationFlowBuilder from(MessageSourceSpec<?,? extends MessageSource<?>> messageSourceSpec, java.util.function.Consumer<SourcePollingChannelAdapterSpec> endpointConfigurer)

Populate the MessageSource object to the IntegrationFlowBuilder chain using the fluent API from the provided MessageSourceSpec. The IntegrationFlow startMessageSource.

Parameters:

messageSourceSpec - the MessageSourceSpec to use.

endpointConfigurer - the Consumer to provide more options for the SourcePollingChannelAdapterFactoryBean.

Returns:

new IntegrationFlowBuilder.

See Also:

MessageSourceSpec, SourcePollingChannelAdapterSpec

fromSupplier

public static <T> IntegrationFlowBuilder fromSupplier(java.util.function.Supplier<T> messageSource)

Provides Supplier as source of messages to the integration flow which will be triggered by the application context's default poller (which must be declared).

Type Parameters:

T - the supplier type.

Parameters:

messageSource - the Supplier to populate.

Returns:

new IntegrationFlowBuilder.

See Also:

Supplier

fromSupplier

public static <T> IntegrationFlowBuilder fromSupplier(java.util.function.Supplier<T> messageSource, java.util.function.Consumer<SourcePollingChannelAdapterSpec> endpointConfigurer)

Provides Supplier as source of messages to the integration flow. which will be triggered by a provided SourcePollingChannelAdapter.

Type Parameters:

T - the supplier type.

Parameters:

messageSource - the Supplier to populate.

endpointConfigurer - the Consumer to provide more options for the SourcePollingChannelAdapterFactoryBean.

Returns:

new IntegrationFlowBuilder.

See Also:

Supplier

from

public static IntegrationFlowBuilder from(MessageSource<?> messageSource)

Populate the provided MessageSource object to the IntegrationFlowBuilder chain. The IntegrationFlow startMessageSource.

Parameters:

messageSource - the MessageSource to populate.

Returns:

new IntegrationFlowBuilder.

See Also:

MessageSource

from

public static IntegrationFlowBuilder from(MessageSource<?> messageSource, @Nullable java.util.function.Consumer<SourcePollingChannelAdapterSpec> endpointConfigurer)

Populate the provided MessageSource object to the IntegrationFlowBuilder chain. The IntegrationFlow startMessageSource. In addition use SourcePollingChannelAdapterSpec to provide options for the underlying SourcePollingChannelAdapter endpoint.

Parameters:

messageSource - the MessageSource to populate.

endpointConfigurer - the Consumer to provide more options for the SourcePollingChannelAdapterFactoryBean.

Returns:

new IntegrationFlowBuilder.

See Also:

MessageSource, SourcePollingChannelAdapterSpec

from

public static IntegrationFlowBuilder from(MessageProducerSpec<?,?> messageProducerSpec)

Populate the MessageProducerSupport object to the IntegrationFlowBuilder chain using the fluent API from the MessageProducerSpec. The IntegrationFlow startMessageProducer.

Parameters:

messageProducerSpec - the MessageProducerSpec to use.

Returns:

new IntegrationFlowBuilder.

See Also:

MessageProducerSpec

from

public static IntegrationFlowBuilder from(MessageProducerSupport messageProducer)

Populate the provided MessageProducerSupport object to the IntegrationFlowBuilder chain. The IntegrationFlow startMessageProducer.

Parameters:

messageProducer - the MessageProducerSupport to populate.

Returns:

new IntegrationFlowBuilder.

from

public static IntegrationFlowBuilder from(MessagingGatewaySpec<?,?> inboundGatewaySpec)

Populate the MessagingGatewaySupport object to the IntegrationFlowBuilder chain using the fluent API from the MessagingGatewaySpec. The IntegrationFlow startMessagingGateway.

Parameters:

inboundGatewaySpec - the MessagingGatewaySpec to use.

Returns:

new IntegrationFlowBuilder.

from

public static IntegrationFlowBuilder from(MessagingGatewaySupport inboundGateway)

Populate the provided MessagingGatewaySupport object to the IntegrationFlowBuilder chain. The IntegrationFlow startMessageProducer.

Parameters:

inboundGateway - the MessagingGatewaySupport to populate.

Returns:

new IntegrationFlowBuilder.

from

public static IntegrationFlowBuilder from(java.lang.Class<?> serviceInterface)

Populate the MessageChannel to the new IntegrationFlowBuilder chain, which becomes as a requestChannel for the Messaging Gateway(s) built on the provided service interface.

A gateway proxy bean for provided service interface is registered under a name from the MessagingGateway.name() if present or from the IntegrationFlow bean name plus .gateway suffix.

Parameters:

serviceInterface - the service interface class with an optional MessagingGateway annotation.

Returns:

new IntegrationFlowBuilder.

from

public static IntegrationFlowBuilder from(java.lang.Class<?> serviceInterface, @Nullable java.util.function.Consumer<GatewayProxySpec> endpointConfigurer)

Populate the MessageChannel to the new IntegrationFlowBuilder chain, which becomes as a requestChannel for the Messaging Gateway(s) built on the provided service interface.

A gateway proxy bean for provided service interface is based on the options configured via provided Consumer.

Parameters:

serviceInterface - the service interface class with an optional MessagingGateway annotation.

endpointConfigurer - the Consumer to configure proxy bean for gateway.

Returns:

new IntegrationFlowBuilder.

Since:

5.2

from

public static IntegrationFlowBuilder from(org.reactivestreams.Publisher<? extends org.springframework.messaging.Message<?>> publisher)

Populate a FluxMessageChannel to the IntegrationFlowBuilder chain and subscribe it to the provided Publisher.

Parameters:

publisher - the Publisher to subscribe to.

Returns:

new IntegrationFlowBuilder.

from

public static IntegrationFlowBuilder from(IntegrationFlow other)

Start the flow with a composition from the IntegrationFlow.

Parameters:

other - the IntegrationFlow from which to compose.

Returns:

new IntegrationFlowBuilder.

Since:

5.5.4