AbstractFlowConstruct (Mule Core 4.0.0-BETA.4 API)

java.lang.Object
- org.mule.runtime.api.meta.AbstractAnnotatedObject
- - org.mule.runtime.core.internal.construct.AbstractFlowConstruct

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, org.mule.runtime.api.meta.AnnotatedObject, org.mule.runtime.api.meta.NamedObject, FlowConstruct, LifecycleStateEnabled

Direct Known Subclasses:

AbstractPipeline
```
public abstract class AbstractFlowConstruct
extends org.mule.runtime.api.meta.AbstractAnnotatedObject
implements FlowConstruct, org.mule.runtime.api.lifecycle.Lifecycle
```
Abstract implementation of FlowConstruct that:
- Is constructed with unique name and MuleContext.
- Uses a MessageSource as the source of messages.
- Uses a chain of Processors to process messages.
- Has lifecycle and propagates this lifecycle to both MessageSource and Processors in the correct order depending on the lifecycle phase.
- Allows an ExceptionListener to be set.
Implementations of AbstractFlowConstuct should implement validateConstruct() validate the resulting construct. Validation may include validation of the type of attributes of the MessageSource.
Implementations may also implement doInitialise(), doStart(), doStop() and doDispose() if they need to perform any action on lifecycle transitions.

Field Summary

Fields
Modifier and Type	Field and Description
`protected MessagingExceptionHandler`	`exceptionListener`
`protected String`	`initialState` Determines the initial state of this flow when the mule starts.
`protected static org.slf4j.Logger`	`LOGGER`
`protected MuleContext`	`muleContext`
`protected String`	`name`
`protected FlowConstructStatistics`	`statistics`

Fields inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject
LOCATION_KEY

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

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

Constructor Summary

Constructors
Constructor and Description

AbstractFlowConstruct(String name, MuleContext muleContext)

Constructors
Constructor and Description
`AbstractFlowConstruct(String name, MuleContext muleContext)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`configureStatistics()`
`void`	`dispose()`
`protected void`	`disposeIfDisposable(Object candidate)`
`protected void`	`doDispose()`
`protected void`	`doInitialise()`
`protected void`	`doStart()`
`protected void`	`doStop()`
`abstract String`	`getConstructType()`
`MessagingExceptionHandler`	`getExceptionListener()`
`String`	`getInitialState()`
`LifecycleState`	`getLifecycleState()`
`MuleContext`	`getMuleContext()`
`String`	`getName()`
`String`	`getServerId()`
`FlowConstructStatistics`	`getStatistics()`
`String`	`getUniqueIdString()` Generate a unique ID string
`void`	`initialise()`
`protected void`	`initialiseIfInitialisable(Object candidate)`
`protected void`	`injectExceptionHandler(Object candidate)`
`protected void`	`injectFlowConstructMuleContext(Object candidate)`
`boolean`	`isStarted()`
`boolean`	`isStopped()`
`boolean`	`isStopping()`
`void`	`setExceptionListener(MessagingExceptionHandler exceptionListener)`
`void`	`setInitialState(String initialState)`
`void`	`start()`
`protected void`	`startIfStartable(Object candidate)`
`void`	`stop()`
`protected void`	`stopIfStoppable(Object candidate)`
`String`	`toString()`
`protected void`	`validateConstruct()` Validates configured flow construct

Methods inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject
getAnnotation, getAnnotations, getLocation, setAnnotations

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOGGER
```
protected static final org.slf4j.Logger LOGGER
```
  - name
```
protected String name
```
  - exceptionListener
```
protected MessagingExceptionHandler exceptionListener
```
  - muleContext
```
protected final MuleContext muleContext
```
  - statistics
```
protected FlowConstructStatistics statistics
```
  - initialState
```
protected String initialState
```
    Determines the initial state of this flow when the mule starts. Can be 'stopped' or 'started' (default)
- Constructor Detail
  - AbstractFlowConstruct
```
public AbstractFlowConstruct(String name,
                             MuleContext muleContext)
```
- Method Detail
  - initialise
```
public final void initialise()
                      throws org.mule.runtime.api.lifecycle.InitialisationException
```
    Specified by:
    
    initialise in interface org.mule.runtime.api.lifecycle.Initialisable
    
    Throws:
    
    org.mule.runtime.api.lifecycle.InitialisationException
  - start
```
public final void start()
                 throws org.mule.runtime.api.exception.MuleException
```
    Specified by:
    
    start in interface org.mule.runtime.api.lifecycle.Startable
    
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - stop
```
public final void stop()
                throws org.mule.runtime.api.exception.MuleException
```
    Specified by:
    
    stop in interface org.mule.runtime.api.lifecycle.Stoppable
    
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - dispose
```
public final void dispose()
```
    Specified by:
    
    dispose in interface org.mule.runtime.api.lifecycle.Disposable
  - isStarted
```
public boolean isStarted()
```
  - isStopped
```
public boolean isStopped()
```
  - isStopping
```
public boolean isStopping()
```
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface org.mule.runtime.api.meta.NamedObject
  - getExceptionListener
```
public MessagingExceptionHandler getExceptionListener()
```
    Specified by:
    
    getExceptionListener in interface FlowConstruct
    
    Returns:
    
    The exception listener that will be used to handle exceptions that may be thrown at different points during the message flow defined by this construct.
  - setExceptionListener
```
public void setExceptionListener(MessagingExceptionHandler exceptionListener)
```
  - getInitialState
```
public String getInitialState()
```
  - setInitialState
```
public void setInitialState(String initialState)
```
  - getLifecycleState
```
public LifecycleState getLifecycleState()
```
    Specified by:
    
    getLifecycleState in interface LifecycleStateEnabled
  - getMuleContext
```
public MuleContext getMuleContext()
```
    Specified by:
    
    getMuleContext in interface FlowConstruct
    
    Returns:
    
    This muleContext that this flow construct belongs to and runs in the context of.
  - getStatistics
```
public FlowConstructStatistics getStatistics()
```
    Specified by:
    
    getStatistics in interface FlowConstruct
    
    Returns:
    
    The statistics holder used by this flow construct to keep track of its activity.
  - doInitialise
```
protected void doInitialise()
                     throws org.mule.runtime.api.exception.MuleException
```
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - configureStatistics
```
protected void configureStatistics()
```
  - doStart
```
protected void doStart()
                throws org.mule.runtime.api.exception.MuleException
```
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - doStop
```
protected void doStop()
               throws org.mule.runtime.api.exception.MuleException
```
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - doDispose
```
protected void doDispose()
```
  - validateConstruct
```
protected void validateConstruct()
                          throws FlowConstructInvalidException
```
    Validates configured flow construct
    
    Throws:
    
    FlowConstructInvalidException - if the flow construct does not pass validation
  - injectFlowConstructMuleContext
```
protected void injectFlowConstructMuleContext(Object candidate)
```
  - injectExceptionHandler
```
protected void injectExceptionHandler(Object candidate)
```
  - getUniqueIdString
```
public String getUniqueIdString()
```
    Description copied from interface: FlowConstruct
    
    Generate a unique ID string
    
    Specified by:
    
    getUniqueIdString in interface FlowConstruct
  - getServerId
```
public String getServerId()
```
    Specified by:
    
    getServerId in interface FlowConstruct
    
    Returns:
    
    the id of the running mule server
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - initialiseIfInitialisable
```
protected void initialiseIfInitialisable(Object candidate)
                                  throws org.mule.runtime.api.lifecycle.InitialisationException
```
    Throws:
    
    org.mule.runtime.api.lifecycle.InitialisationException
  - startIfStartable
```
protected void startIfStartable(Object candidate)
                         throws org.mule.runtime.api.exception.MuleException
```
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - stopIfStoppable
```
protected void stopIfStoppable(Object candidate)
                        throws org.mule.runtime.api.exception.MuleException
```
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - disposeIfDisposable
```
protected void disposeIfDisposable(Object candidate)
```
  - getConstructType
```
public abstract String getConstructType()
```
    Returns:
    
    the type of construct being created, e.g. "Flow"

Class AbstractFlowConstruct

Field Summary

Fields inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

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

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

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

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

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

Constructor Summary

Method Summary

Methods inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

Methods inherited from class java.lang.Object

Field Detail

LOGGER

name

exceptionListener

muleContext

statistics

initialState

Constructor Detail

AbstractFlowConstruct

Method Detail

initialise

start

stop

dispose

isStarted

isStopped

isStopping

getName

getExceptionListener

setExceptionListener

getInitialState

setInitialState

getLifecycleState

getMuleContext

getStatistics

doInitialise

configureStatistics

doStart

doStop

doDispose

validateConstruct

injectFlowConstructMuleContext

injectExceptionHandler

getUniqueIdString

getServerId

toString

initialiseIfInitialisable

startIfStartable

stopIfStoppable

disposeIfDisposable

getConstructType