org.springframework.cloud.stream.function

Class IntegrationFlowFunctionSupport

java.lang.Object

org.springframework.cloud.stream.function.IntegrationFlowFunctionSupport

public class IntegrationFlowFunctionSupport
extends Object

Since:

2.1

Author:

Oleg Zhurakousky, David Turanski, Ilayaperumal Gopinathan

Method Summary

Modifier and Type	Method and Description
boolean	andThenFunction(org.springframework.integration.dsl.IntegrationFlowBuilder flowBuilder, org.springframework.messaging.MessageChannel outputChannel, StreamFunctionProperties functionProperties) Add a Function bean to the end of an integration flow.
<I,O> boolean	andThenFunction(org.reactivestreams.Publisher<?> publisher, org.springframework.messaging.MessageChannel outputChannel, StreamFunctionProperties functionProperties)
<T> boolean	containsFunction(Class<T> typeOfFunction) Determines if function specified via 'spring.cloud.stream.function.definition' property can be located in FunctionCatalogs.
<T> boolean	containsFunction(Class<T> typeOfFunction, String functionName) Determines if function specified via 'spring.cloud.stream.function.definition' property can be located in FunctionCatalog.
org.springframework.cloud.function.context.FunctionType	getCurrentFunctionType()
org.springframework.integration.dsl.IntegrationFlowBuilder	integrationFlowForFunction(org.springframework.messaging.SubscribableChannel inputChannel, org.springframework.messaging.MessageChannel outputChannel)
org.springframework.integration.dsl.IntegrationFlowBuilder	integrationFlowFromChannel(org.springframework.messaging.SubscribableChannel inputChannel)
org.springframework.integration.dsl.IntegrationFlowBuilder	integrationFlowFromNamedSupplier() Create an instance of the IntegrationFlowBuilder from a Supplier bean available in the context.
org.springframework.integration.dsl.IntegrationFlowBuilder	integrationFlowFromProvidedSupplier(Supplier<?> supplier) Create an instance of the IntegrationFlowBuilder from a provided Supplier.

Methods inherited from class java.lang.Object

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

Method Detail

containsFunction

public <T> boolean containsFunction(Class<T> typeOfFunction)

Determines if function specified via 'spring.cloud.stream.function.definition' property can be located in FunctionCatalogs.

Type Parameters:

T - type of function

Parameters:

typeOfFunction - must be Supplier, Function or Consumer

Returns:

true if function is already stored

containsFunction

public <T> boolean containsFunction(Class<T> typeOfFunction,
                                    String functionName)

Determines if function specified via 'spring.cloud.stream.function.definition' property can be located in FunctionCatalog.

Type Parameters:

T - type of function

Parameters:

typeOfFunction - must be Supplier, Function or Consumer

functionName - the function name to check

Returns:

true if function is already stored

getCurrentFunctionType

public org.springframework.cloud.function.context.FunctionType getCurrentFunctionType()

Returns:

the function type basing on the function definition.

integrationFlowFromNamedSupplier

public org.springframework.integration.dsl.IntegrationFlowBuilder integrationFlowFromNamedSupplier()

Create an instance of the IntegrationFlowBuilder from a Supplier bean available in the context. The name of the bean must be provided via `spring.cloud.stream.function.definition` property.

Returns:

instance of IntegrationFlowBuilder

Throws:

IllegalStateException - if the named Supplier can not be located.

integrationFlowFromProvidedSupplier

public org.springframework.integration.dsl.IntegrationFlowBuilder integrationFlowFromProvidedSupplier(Supplier<?> supplier)

Create an instance of the IntegrationFlowBuilder from a provided Supplier.

Parameters:

supplier - supplier from which the flow builder will be built

Returns:

instance of IntegrationFlowBuilder

integrationFlowFromChannel

public org.springframework.integration.dsl.IntegrationFlowBuilder integrationFlowFromChannel(org.springframework.messaging.SubscribableChannel inputChannel)

Parameters:

inputChannel - channel for which flow we be built

Returns:

instance of IntegrationFlowBuilder

integrationFlowForFunction

public org.springframework.integration.dsl.IntegrationFlowBuilder integrationFlowForFunction(org.springframework.messaging.SubscribableChannel inputChannel,
                                                                                             org.springframework.messaging.MessageChannel outputChannel)

Parameters:

inputChannel - channel for which flow we be built

outputChannel - channel for which flow we be built

Returns:

instance of IntegrationFlowBuilder

andThenFunction

public boolean andThenFunction(org.springframework.integration.dsl.IntegrationFlowBuilder flowBuilder,
                               org.springframework.messaging.MessageChannel outputChannel,
                               StreamFunctionProperties functionProperties)

Add a Function bean to the end of an integration flow. The name of the bean must be provided via `spring.cloud.stream.function.definition` property.

NOTE: If this method returns true, the integration flow is now represented as a Reactive Streams Publisher bean.

Parameters:

flowBuilder - instance of the IntegrationFlowBuilder representing the current state of the integration flow

outputChannel - channel where the output of a function will be sent

functionProperties - the function properties

Returns:

true if Function was located and added and false if it wasn't.

andThenFunction

public <I,O> boolean andThenFunction(org.reactivestreams.Publisher<?> publisher,
                                     org.springframework.messaging.MessageChannel outputChannel,
                                     StreamFunctionProperties functionProperties)

Type Parameters:

I - input of the function

O - output of the function

Parameters:

publisher - publisher to subscribe to

outputChannel - output channel to which a message will be sent

functionProperties - function properties

Returns:

whether the function was properly invoked