com.mulesoft.mule.runtime.plugin

Class SimpleMulePlugin

java.lang.Object

com.mulesoft.mule.runtime.plugin.SimpleMulePlugin

All Implemented Interfaces:

MulePlugin, 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

public class SimpleMulePlugin
extends Object
implements MulePlugin

Provides a simple MulePlugin implementation to extend from when creating a new plugin.

Field Summary

Fields

Modifier and Type	Field and Description
protected File	directory

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

Constructor Summary

Constructors

Constructor and Description
SimpleMulePlugin()

Method Summary

Modifier and Type	Method and Description
void	dispose()
void	initialise()
boolean	isDisabledOnEnvironment() Indicates when a plugin is disabled in the current execution environment to avoid being started.
void	setWorkingDirectory(File directory) Sets working directory for the plugin
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

directory

protected File directory

Constructor Detail

SimpleMulePlugin

public SimpleMulePlugin()

Method Detail

setWorkingDirectory

public void setWorkingDirectory(File directory)

Description copied from interface: MulePlugin

Sets working directory for the plugin

Specified by:

setWorkingDirectory in interface MulePlugin

Parameters:

directory - working directory no shared with other plugins. Not Null.

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

initialise

public 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 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 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

isDisabledOnEnvironment

public boolean isDisabledOnEnvironment()

Description copied from interface: MulePlugin

Indicates when a plugin is disabled in the current execution environment to avoid being started.

Specified by:

isDisabledOnEnvironment in interface MulePlugin

Returns:

true when disabled, false otherwise