com.mulesoft.mule.runtime.plugin.manager

Interface PluginManager

All Superinterfaces:

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

All Known Implementing Classes:

MulePluginManager

public interface PluginManager
extends org.mule.runtime.api.lifecycle.Lifecycle

Manages all plugins that are installed in the mule instance.

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	disablePlugin(String name) Disables an enabled plugin.
void	enablePlugin(String name) Enables a disabled plugin.
ManagedMulePlugin	findRegisteredPlugin(String name) Finds a given plugin by name.
Collection<ManagedMulePlugin>	registeredPlugins() List all registered mule plugins
void	registerPlugin(ManagedMulePlugin plugin) Registers a plugin in the mule instance
void	unregisterPlugin(String name) Unregisters a plugin from the mule instance.

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

initialise

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

start

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

stop

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

dispose

Method Detail

registerPlugin

void registerPlugin(ManagedMulePlugin plugin)
             throws PluginAlreadyRegisteredException

Registers a plugin in the mule instance

Parameters:

plugin - plugin to register

Throws:

PluginAlreadyRegisteredException - if there is already a mule plugin registered with the same name

unregisterPlugin

void unregisterPlugin(String name)
               throws PluginNoRegisteredException

Unregisters a plugin from the mule instance.

Parameters:

name - name of the plugin to unregister

Throws:

PluginNoRegisteredException - if there is no such registered plugin

registeredPlugins

Collection<ManagedMulePlugin> registeredPlugins()

List all registered mule plugins

Returns:

a not null list of plugins

findRegisteredPlugin

ManagedMulePlugin findRegisteredPlugin(String name)

Finds a given plugin by name.

Parameters:

name - name of the plugin to find

Returns:

a plugin with the given name or null if there is no registered plugin for that name

disablePlugin

void disablePlugin(String name)
            throws PluginNoRegisteredException,
                   PluginLifecycleException

Disables an enabled plugin.

Parameters:

name - name of the plugin to disable

Throws:

PluginNoRegisteredException - if there is no such registered plugin

PluginLifecycleException - if plugin is already disabled

enablePlugin

void enablePlugin(String name)
           throws PluginNoRegisteredException,
                  PluginLifecycleException

Enables a disabled plugin.

Parameters:

name - name of the plugin to enable

Throws:

PluginNoRegisteredException - if there is no such registered plugin

PluginLifecycleException - if plugin is already enabled