org.mule.runtime.core.api.construct

Interface Flow

All Superinterfaces:

org.mule.runtime.api.meta.AnnotatedObject, org.mule.runtime.api.lifecycle.Disposable, FlowConstruct, Function<org.reactivestreams.Publisher<Event>,org.reactivestreams.Publisher<Event>>, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, LifecycleStateEnabled, org.mule.runtime.api.meta.NamedObject, Pipeline, ProcessingDescriptor, Processor, ReactiveProcessor, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

All Known Implementing Classes:

DefaultFlowBuilder.DefaultFlow

public interface Flow
extends org.mule.runtime.api.meta.AnnotatedObject, org.mule.runtime.api.lifecycle.Lifecycle, Pipeline, Processor

Defines a Pipeline that represents a Mule flow.

A flow adds the following behaviour to a Pipeline

• Rejects inbound events when Flow is not started
• Gathers statistics and processing time data
• Implements MessageProcessor allowing direct invocation of the pipeline
• Supports the optional configuration of a ProcessingStrategy that determines how message processors are processed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Flow.Builder

Nested classes/interfaces inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor

ReactiveProcessor.ProcessingType

Field Summary

Fields

Modifier and Type	Field and Description
static String	INITIAL_STATE_STARTED
static String	INITIAL_STATE_STOPPED

Fields inherited from interface org.mule.runtime.api.meta.AnnotatedObject

PROPERTY_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Method Summary

Modifier and Type	Method and Description
static Flow.Builder	builder(String name, MuleContext muleContext) Creates a new flow builder
String	getInitialState()

Methods inherited from interface org.mule.runtime.api.meta.AnnotatedObject

getAnnotation, getAnnotations, getLocation, setAnnotations

Methods inherited from interface org.mule.runtime.api.lifecycle.Initialisable

initialise

Methods inherited from interface org.mule.runtime.api.lifecycle.Startable

start

Methods inherited from interface org.mule.runtime.api.lifecycle.Stoppable

stop

Methods inherited from interface org.mule.runtime.api.lifecycle.Disposable

dispose

Methods inherited from interface org.mule.runtime.core.api.construct.Pipeline

getMessageProcessors, getMessageSource, getProcessingStrategy, getProcessingStrategyFactory, getSerializationEventContextCache, setMessageProcessors, setMessageSource, setProcessingStrategyFactory

Methods inherited from interface org.mule.runtime.core.api.construct.FlowConstruct

getExceptionListener, getMuleContext, getServerId, getStatistics, getUniqueIdString

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Methods inherited from interface org.mule.runtime.core.api.lifecycle.LifecycleStateEnabled

getLifecycleState

Methods inherited from interface org.mule.runtime.core.api.processor.ProcessingDescriptor

isSynchronous

Methods inherited from interface org.mule.runtime.core.api.processor.Processor

apply, process

Methods inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor

getProcessingType

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

INITIAL_STATE_STOPPED

static final String INITIAL_STATE_STOPPED

See Also:

Constant Field Values

INITIAL_STATE_STARTED

static final String INITIAL_STATE_STARTED

See Also:

Constant Field Values

Method Detail

getInitialState

String getInitialState()

Returns:

initial state of the flow, which can be "started" or "stopped"

builder

static Flow.Builder builder(String name,
                            MuleContext muleContext)

Creates a new flow builder

Parameters:

name - name of the flow to be created. Non empty.

muleContext - context where the flow will be registered. Non null.