org.rhq.enterprise.server.plugin

Interface ServerPluginManagerRemote

All Known Subinterfaces:

ServerPluginManagerLocal

All Known Implementing Classes:

ServerPluginManagerBean

public interface ServerPluginManagerRemote

Remote management interface for server plugins.

Method Summary

Methods

Modifier and Type	Method and Description
List<org.rhq.core.domain.plugin.PluginKey>	deleteServerPlugins(org.rhq.core.domain.auth.Subject subject, List<Integer> pluginIds) Removes the plugins from the system and unschedules their jobs.
List<org.rhq.core.domain.plugin.PluginKey>	disableServerPlugins(org.rhq.core.domain.auth.Subject subject, List<Integer> pluginIds) Disables the plugins and unschedules their jobs.
List<org.rhq.core.domain.plugin.PluginKey>	enableServerPlugins(org.rhq.core.domain.auth.Subject subject, List<Integer> pluginIds) Enables the plugins and restarts them.
List<org.rhq.core.domain.plugin.ServerPlugin>	getServerPlugins(org.rhq.core.domain.auth.Subject subject) Returns a list of all the installed server plugins in the database, minus the content object.
ControlResults	invokeServerPluginControl(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.plugin.PluginKey pluginKey, String controlName, org.rhq.core.domain.configuration.Configuration params) Invokes a control operation on a given plugin and returns the results.
void	restartMasterPluginContainer(org.rhq.core.domain.auth.Subject subject) Recycles the master plugin container, essentially shutting down all server plugins and then restarting them.

Method Detail

restartMasterPluginContainer

void restartMasterPluginContainer(org.rhq.core.domain.auth.Subject subject)

Recycles the master plugin container, essentially shutting down all server plugins and then restarting them.

Parameters:

subject - the user asking to restart the master plugin container

getServerPlugins

List<org.rhq.core.domain.plugin.ServerPlugin> getServerPlugins(org.rhq.core.domain.auth.Subject subject)

Returns a list of all the installed server plugins in the database, minus the content object.

Returns:

all installed server plugins found in the DB

enableServerPlugins

List<org.rhq.core.domain.plugin.PluginKey> enableServerPlugins(org.rhq.core.domain.auth.Subject subject,
                                                             List<Integer> pluginIds)
                                                               throws Exception

Enables the plugins and restarts them.

Parameters:

subject - user making the request

pluginIds - the plugins to be enabled

Returns:

the list of keys of the plugins that were enabled

Throws:

Exception - if failed to disable a plugin

disableServerPlugins

List<org.rhq.core.domain.plugin.PluginKey> disableServerPlugins(org.rhq.core.domain.auth.Subject subject,
                                                              List<Integer> pluginIds)
                                                                throws Exception

Disables the plugins and unschedules their jobs.

Parameters:

subject - user making the request

pluginIds - the plugins to be disabled

Returns:

the list of keys of the plugins that were disabled

Throws:

Exception - if failed to disable a plugin

deleteServerPlugins

List<org.rhq.core.domain.plugin.PluginKey> deleteServerPlugins(org.rhq.core.domain.auth.Subject subject,
                                                             List<Integer> pluginIds)
                                                               throws Exception

Removes the plugins from the system and unschedules their jobs.

Parameters:

subject - user making the request

pluginIds - the plugins to be undeployed

Returns:

the list of keys of plugins that were undeployed

Throws:

Exception - if failed to undeploy a plugin

invokeServerPluginControl

ControlResults invokeServerPluginControl(org.rhq.core.domain.auth.Subject subject,
                                       org.rhq.core.domain.plugin.PluginKey pluginKey,
                                       String controlName,
                                       org.rhq.core.domain.configuration.Configuration params)
                                         throws Exception

Invokes a control operation on a given plugin and returns the results. This method blocks until the plugin component completes the invocation.

Parameters:

subject - user making the request, must have the proper permissions

pluginKey - identifies the plugin whose control operation is to be invoked

controlName - identifies the name of the control operation to invoke

params - parameters to pass to the control operation; may be null

Returns:

the results of the invocation

Throws:

if - failed to obtain the plugin component and invoke the control. This usually means an abnormal error occurred - if the control operation merely failed to do what it needed to do, the error will be reported in the returned results, not as a thrown exception.

Exception