com.fnproject.fn.api.flow

Class Flows

java.lang.Object

com.fnproject.fn.api.flow.Flows

public final class Flows
extends Object

Fn Flow API entry point class - this provides access to the current Flow for the current function invocation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Flows.FlowSource Defines a supplier for the current runtime-
static interface	Flows.SerBiConsumer<T,U> Version of BiConsumer that is implicitly serializable.
static interface	Flows.SerBiFunction<T,U,R> Version of BiFunction that is implicitly serializable.
static interface	Flows.SerCallable<V> Version of Callable that is implicitly serializable.
static interface	Flows.SerConsumer<V> Version of Consumer that is implicitly serializable.
static interface	Flows.SerFunction<T,V> Version of Function that is implicitly serializable.
static interface	Flows.SerRunnable Version of Runnable that is implicitly serializable.
static interface	Flows.SerSupplier<V> Version of Supplier that is implicitly serializable.

Method Summary

Modifier and Type	Method and Description
static Flow	currentFlow() Return the current flow runtime - this will create a new flow if the current is not already bound to the invocation or an existing flow if one is already bound to the current invocation or if the invocation was triggered from within a flow stage.
static Flows.FlowSource	getCurrentFlowSource() Gets the current supplier of the flow runtime
static void	setCurrentFlowSource(Flows.FlowSource flowSource) Set the current runtime source - this determines how currentFlow() behaves

Methods inherited from class java.lang.Object

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

Method Detail

getCurrentFlowSource

public static Flows.FlowSource getCurrentFlowSource()

Gets the current supplier of the flow runtime

Returns:

the current supplier of the flow runtime

currentFlow

public static Flow currentFlow()

Return the current flow runtime - this will create a new flow if the current is not already bound to the invocation or an existing flow if one is already bound to the current invocation or if the invocation was triggered from within a flow stage.

Returns:

the current flow runtime

setCurrentFlowSource

public static void setCurrentFlowSource(Flows.FlowSource flowSource)

Set the current runtime source - this determines how currentFlow() behaves

This is provided for testing and internal use - users should not normally need to modify the runtime source.

Parameters:

flowSource - a function that instantiates a runtime on demand