org.mule.agent

Class ConfigScannerAgent

java.lang.Object

org.mule.AbstractAgent

org.mule.agent.ConfigScannerAgent

All Implemented Interfaces:

Agent, MuleContextAware, Disposable, Initialisable, Lifecycle, Startable, Stoppable, NamedObject

public class ConfigScannerAgent
extends AbstractAgent

EXPERIMENTAL!!! This agent scans a defined directory for dropped configuration files. It defaults to .mule/conf. Once configuration files are ready, they should be moved instead of deleted. We need a strategy for this. This agent should also respond to wire transfers (tcp, multicast).

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGENT_NAME

Fields inherited from class org.mule.AbstractAgent

muleContext, name

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

Constructor Summary

Constructors

Constructor and Description
ConfigScannerAgent()

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() A lifecycle method where implementor should free up any resources.
String	getConfigDirName()
List	getDependentAgents()
String	getDescription() Should be a 1 line description of the agent
void	initialise() Method used to perform any initialisation work.
void	registered()
void	setConfigDirName(String configDirName)
void	setDoStop(boolean doStop)
void	start()
void	stop()
String	toString()
void	unregistered()

Methods inherited from class org.mule.AbstractAgent

getName, setMuleContext, setName

Methods inherited from class java.lang.Object

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

Field Detail

AGENT_NAME

public static final String AGENT_NAME

See Also:

Constant Field Values

Constructor Detail

ConfigScannerAgent

public ConfigScannerAgent()

Method Detail

getConfigDirName

public String getConfigDirName()

setConfigDirName

public void setConfigDirName(String configDirName)

getDescription

public String getDescription()

Should be a 1 line description of the agent

Specified by:

getDescription in interface Agent

Overrides:

getDescription in class AbstractAgent

Returns:

start

public void start()
           throws MuleException

Throws:

MuleException

stop

public void stop()
          throws MuleException

Throws:

MuleException

dispose

public void dispose()

Description copied from interface: Disposable

A lifecycle method where implementor should free up any resources. If an exception is thrown it should just be logged and processing should continue. This method should not throw Runtime exceptions.

registered

public void registered()

unregistered

public void unregistered()

initialise

public void initialise()
                throws InitialisationException

Description copied from interface: Initialisable

Method used to perform any initialisation work. If a fatal error occurs during initialisation an 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.

Specified by:

initialise in interface Initialisable

Specified by:

initialise in class AbstractAgent

Throws:

InitialisationException - if a fatal error occurs causing the Mule instance to shutdown

RecoverableException - if an error occurs that can be recovered from

getDependentAgents

public List getDependentAgents()

Specified by:

getDependentAgents in interface Agent

Overrides:

getDependentAgents in class AbstractAgent

Returns:

List of Class objects (agent classes) that this Agent requires to be started before it can start itself. The implementation of this class may never return null.

toString

public String toString()

Overrides:

toString in class Object

setDoStop

public void setDoStop(boolean doStop)