|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mule.construct.AbstractFlowConstruct
public abstract class AbstractFlowConstruct
Abstract implementation of FlowConstruct
that:
MuleContext
.
MessageSource
as the source of messages.
MessageProcessor
s to process messages.
MessageSource
and
MessageProcessor
s in the correct order depending on the lifecycle phase.
ExceptionListener
to be set.
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 | |
---|---|
protected MessagingExceptionHandler |
exceptionListener
|
static String |
INITIAL_STATE_STARTED
|
static String |
INITIAL_STATE_STOPPED
The initial states that the flow can be started in |
protected String |
initialState
Determines the initial state of this flow when the mule starts. |
protected FlowConstructLifecycleManager |
lifecycleManager
|
protected Log |
logger
|
protected MessageInfoMapping |
messageInfoMapping
|
protected MuleContext |
muleContext
|
protected String |
name
|
protected FlowConstructStatistics |
statistics
|
Fields inherited from interface org.mule.api.lifecycle.Initialisable |
---|
PHASE_NAME |
Fields inherited from interface org.mule.api.lifecycle.Startable |
---|
PHASE_NAME |
Fields inherited from interface org.mule.api.lifecycle.Stoppable |
---|
PHASE_NAME |
Fields inherited from interface org.mule.api.lifecycle.Disposable |
---|
PHASE_NAME |
Fields inherited from interface org.mule.api.AnnotatedObject |
---|
PROPERTY_NAME |
Constructor Summary | |
---|---|
AbstractFlowConstruct(String name,
MuleContext muleContext)
|
Method Summary | |
---|---|
protected void |
configureStatistics()
|
void |
dispose()
A lifecycle method where implementor should free up any resources. |
protected void |
disposeIfDisposable(Object candidate)
|
protected void |
doDispose()
|
protected void |
doInitialise()
|
protected void |
doStart()
|
protected void |
doStop()
|
Object |
getAnnotation(QName name)
Gets the value of specified annotation. |
Map<QName,Object> |
getAnnotations()
Gets all annotations. |
abstract String |
getConstructType()
|
MessagingExceptionHandler |
getExceptionListener()
|
String |
getInitialState()
|
LifecycleState |
getLifecycleState()
|
MessageInfoMapping |
getMessageInfoMapping()
|
MuleContext |
getMuleContext()
|
String |
getName()
Gets the name of the object |
FlowConstructStatistics |
getStatistics()
|
void |
initialise()
Method used to perform any initialisation work. |
protected void |
initialiseIfInitialisable(Object candidate)
|
protected void |
injectFlowConstructMuleContext(Object candidate)
|
boolean |
isStarted()
|
boolean |
isStopped()
|
boolean |
isStopping()
|
void |
setAnnotations(Map<QName,Object> newAnnotations)
Sets annotations to the object. |
void |
setExceptionListener(MessagingExceptionHandler exceptionListener)
|
void |
setInitialState(String initialState)
|
void |
setMessageInfoMapping(MessageInfoMapping messageInfoMapping)
|
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected transient Log logger
protected String name
protected MessagingExceptionHandler exceptionListener
protected final FlowConstructLifecycleManager lifecycleManager
protected final MuleContext muleContext
protected FlowConstructStatistics statistics
protected MessageInfoMapping messageInfoMapping
public static final String INITIAL_STATE_STOPPED
public static final String INITIAL_STATE_STARTED
protected String initialState
Constructor Detail |
---|
public AbstractFlowConstruct(String name, MuleContext muleContext)
Method Detail |
---|
public final void initialise() throws InitialisationException
Initialisable
InitialisationException
should be thrown,
causing the Mule instance to shutdown. If the error is recoverable, say by
retrying to connect, a RecoverableException
should be thrown.
There is no guarantee that by throwing a Recoverable exception that the Mule
instance will not shut down.
initialise
in interface Initialisable
InitialisationException
- if a fatal error occurs causing the Mule instance to shutdown
RecoverableException
- if an error occurs that can be recovered frompublic final void start() throws MuleException
start
in interface Startable
MuleException
public final void stop() throws MuleException
stop
in interface Stoppable
MuleException
public final void dispose()
Disposable
dispose
in interface Disposable
public boolean isStarted()
public boolean isStopped()
public boolean isStopping()
public String getName()
NamedObject
getName
in interface NamedObject
public MessagingExceptionHandler getExceptionListener()
getExceptionListener
in interface FlowConstruct
public void setExceptionListener(MessagingExceptionHandler exceptionListener)
public String getInitialState()
public void setInitialState(String initialState)
public LifecycleState getLifecycleState()
getLifecycleState
in interface LifecycleStateEnabled
public MuleContext getMuleContext()
getMuleContext
in interface FlowConstruct
public FlowConstructStatistics getStatistics()
getStatistics
in interface FlowConstruct
public MessageInfoMapping getMessageInfoMapping()
getMessageInfoMapping
in interface FlowConstruct
MessageInfoMapping
used to control how Important message
information is pulled from the current message.public void setMessageInfoMapping(MessageInfoMapping messageInfoMapping)
protected void doInitialise() throws MuleException
MuleException
protected void configureStatistics()
protected void doStart() throws MuleException
MuleException
protected void doStop() throws MuleException
MuleException
protected void doDispose()
protected void validateConstruct() throws FlowConstructInvalidException
FlowConstructInvalidException
- if the flow construct does not pass
validationprotected void injectFlowConstructMuleContext(Object candidate)
public String toString()
toString
in class Object
protected void initialiseIfInitialisable(Object candidate) throws InitialisationException
InitialisationException
protected void startIfStartable(Object candidate) throws MuleException
MuleException
protected void stopIfStoppable(Object candidate) throws MuleException
MuleException
protected void disposeIfDisposable(Object candidate)
public final Object getAnnotation(QName name)
AnnotatedObject
getAnnotation
in interface AnnotatedObject
public final Map<QName,Object> getAnnotations()
AnnotatedObject
getAnnotations
in interface AnnotatedObject
public final void setAnnotations(Map<QName,Object> newAnnotations)
AnnotatedObject
setAnnotations
in interface AnnotatedObject
public abstract String getConstructType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |