public abstract class AbstractAgent extends Object implements Agent, MuleContextAware
Modifier and Type | Field and Description |
---|---|
protected MuleContext |
muleContext |
protected String |
name |
PHASE_NAME
PHASE_NAME
PHASE_NAME
PHASE_NAME
Modifier | Constructor and Description |
---|---|
protected |
AbstractAgent(String name) |
Modifier and Type | Method and Description |
---|---|
List |
getDependentAgents() |
String |
getDescription()
Should be a 1 line description of the agent
|
String |
getName()
Gts the name of the object
|
abstract void |
initialise()
Method used to perform any initialisation work.
|
void |
setMuleContext(MuleContext context) |
void |
setName(String name)
Sets the name of the object
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
registered, unregistered
dispose
protected MuleContext muleContext
protected String name
protected AbstractAgent(String name)
public final String getName()
NamedObject
getName
in interface NamedObject
public final void setName(String name)
NamedObject
setName
in interface NamedObject
name
- the name of the objectpublic String getDescription()
Agent
getDescription
in interface Agent
public List getDependentAgents()
getDependentAgents
in interface Agent
null
.public void setMuleContext(MuleContext context)
setMuleContext
in interface MuleContextAware
public abstract 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 shutdownRecoverableException
- if an error occurs that can be recovered fromCopyright © 2003–2013 MuleSource, Inc.. All rights reserved.