|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | METHOD | DETAIL: FIELD | METHOD |
public interface IPluginControlService
The control service allows lifecycle management operations to be performed on plugins. It also provides methods to create and retrieve plugins.
Method Summary | |
---|---|
boolean
|
createPlugin(String pluginId, Class pluginType)
Creates a new plugin with the given identifier and plugin type, initializes the bean for it, and automatically starts it if AbstractPluginInfo.getAutoStart is enabled. |
boolean
|
createPlugin(String pluginId, Class pluginType, Map properties)
Creates a new plugin with the given identifier, plugin type, and additional properties, initializes bean for it, and automatically starts it if AbstractPluginInfo.getAutoStart is enabled. |
boolean
|
createPlugin(String pluginId, String pluginType)
Creates a new plugin with the given identifier and plugin type, initializes bean for it, and automatically starts it if AbstractPluginInfo.getAutoStart is enabled. |
boolean
|
createPlugin(String pluginId, String pluginType, Map properties)
Creates a new plugin with the given identifier, plugin type, and additional properties, initializes bean for it, and automatically starts it if AbstractPluginInfo.getAutoStart is enabled. |
Object
|
getPlugin(String pluginType, Map config)
Retrieves a plugin by the plugin type and according to specific properties given in AbstractPlugin.getConfig. |
Object
|
getPluginById(String pluginId)
Retrieves a plugin by the unique identifier from AbstractPlugin.getId. |
List
|
getPlugins(String pluginType)
Retrieves a list of plugins that are of the specified plugin type. |
List
|
getPlugins(String pluginType, Map config)
Retrieves a list of plugins that are of the specified plugin type and contain the specified properties given in AbstractPlugin.getConfig. |
void
|
start(String pluginId)
Starts a plugin with the specified identifier, including handling of events before and after start and verifying configuration. |
void
|
stop(String pluginId)
Stops a plugin with the specified identifier, including handling of events before and after stop. |
void
|
verifyConfiguration(String pluginId)
Verifies the current configuration of the plugin with the specified identifier. |
Method Detail |
---|
public boolean createPlugin(String pluginId, Class pluginType)
public boolean createPlugin(String pluginId, Class pluginType, Map properties)
properties
- Map containing configuration properties as defined in AbstractPluginInfo, including a config Map.
public boolean createPlugin(String pluginId, String pluginType)
public boolean createPlugin(String pluginId, String pluginType, Map properties)
properties
- Map containing configuration properties as defined in AbstractPluginInfo, including a config Map.
public Object getPlugin(String pluginType, Map config)
public Object getPluginById(String pluginId)
public List getPlugins(String pluginType)
public List getPlugins(String pluginType, Map config)
public void start(String pluginId)
public void stop(String pluginId)
public void verifyConfiguration(String pluginId)
Groovy Documentation