org.rhq.enterprise.server.resource.metadata

Interface PluginManagerRemote

All Known Subinterfaces:

PluginManagerLocal

All Known Implementing Classes:

PluginManagerBean

public interface PluginManagerRemote

All the methods on this EJB require the Permission.MANAGE_SETTINGS permission.

Since:

4.11

Author:

Lukas Krejci

Method Summary

Methods

Modifier and Type	Method and Description
void	deletePlugins(org.rhq.core.domain.auth.Subject subject, List<Integer> pluginIds) This method puts the plugin into a deleted state and removes the plugin JAR file from the file system and schedules its eventual deletion from the database, too.
List<org.rhq.core.domain.plugin.Plugin>	deployUsingBytes(org.rhq.core.domain.auth.Subject subject, String pluginJarName, byte[] pluginJarBytes) Deploys a new agent plugin to RHQ asynchronously.
List<org.rhq.core.domain.plugin.Plugin>	deployUsingContentHandle(org.rhq.core.domain.auth.Subject subject, String pluginJarName, String handle) Deploys a new agent plugin to RHQ asynchronously using the content handle pointing to a previously uploaded file.
void	disablePlugins(org.rhq.core.domain.auth.Subject subject, List<Integer> pluginIds) Disables plugins by ID.
void	enablePlugins(org.rhq.core.domain.auth.Subject subject, List<Integer> pluginIds) Enables plugins by ID.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.plugin.Plugin>	findPluginsByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.PluginCriteria criteria) Returns a list of plugins by criteria.
boolean	isPluginUpdateOnAgentsFinished(org.rhq.core.domain.auth.Subject subject, String handle) Use this method to check whether given scheduled plugin update on agents finished.
String	schedulePluginUpdateOnAgents(org.rhq.core.domain.auth.Subject subject, long delayInMilliseconds) Instructs all the running and connected agents to update their plugins after a given delay.
void	update(org.rhq.core.domain.auth.Subject subject) Updates the plugins that might have been changed on the filesystem of the server.

Method Detail

update

void update(org.rhq.core.domain.auth.Subject subject)
            throws Exception

Updates the plugins that might have been changed on the filesystem of the server. This method will only return after the updates are complete.

Parameters:

subject - the authenticated user

Throws:

Exception

schedulePluginUpdateOnAgents

String schedulePluginUpdateOnAgents(org.rhq.core.domain.auth.Subject subject,
                                  long delayInMilliseconds)
                                    throws Exception

Instructs all the running and connected agents to update their plugins after a given delay. Be aware that in case there was a plugin update, the plugin containers of the agents will be restarted and thus there will be a short period of time when the agent will not be collecting any metrics, etc.

Note that by nature this is an asynchronous operation and the update is not finished by the time it returns. You can use the provided handle to periodically query the isPluginUpdateOnAgentsFinished(org.rhq.core.domain.auth.Subject, String) method using the supplied handle.

Parameters:

subject - the authenticated user

delayInMilliseconds - the number of milliseconds to wait before running the update on the agents

Returns:

returns a handle that can be used to retrieve info about the execution of the update

Throws:

Exception

See Also:

isPluginUpdateOnAgentsFinished(org.rhq.core.domain.auth.Subject, String)

isPluginUpdateOnAgentsFinished

boolean isPluginUpdateOnAgentsFinished(org.rhq.core.domain.auth.Subject subject,
                                     String handle)

Use this method to check whether given scheduled plugin update on agents finished.

This will return false until the update on all agents has truly finished.

Note that the schedule only updates the agents that are live at the time it is executed. The agents that will come live later will only update their plugins once they start and only if they are configured to do so (which is the default behavior). It is currently not possible to find out what versions of plugins agents use if they are NOT auto-updating themselves.

Parameters:

subject - the authenticated user

handle - the handle of the schedule

Returns:

true if the scheduled plugin update finished on all live agents, false if it has not finished yet.

See Also:

schedulePluginUpdateOnAgents(org.rhq.core.domain.auth.Subject, long)

deployUsingBytes

List<org.rhq.core.domain.plugin.Plugin> deployUsingBytes(org.rhq.core.domain.auth.Subject subject,
                                                       String pluginJarName,
                                                       byte[] pluginJarBytes)
                                                         throws Exception

Deploys a new agent plugin to RHQ asynchronously. Note that the deployUsingContentHandle(org.rhq.core.domain.auth.Subject, String, String) method is the preferred way of doing this because it avoids having to keep the whole of the plugin jar in memory.

In another words, use this method with caution because it may require a large amount of memory.

This method returns after the plugin is deployed. Because there might be other plugins pending to be deployed in the filesystem, this operation might result in more than just the single requested plugin being deployed. This is why this method returns a list instead of a single plugin corresponding to the provided jar..

Parameters:

subject - the authenticated user

pluginJarName - the name of the jar file which should be used to store the plugin on the filesystem

pluginJarBytes - the bytes of the plugin jar file

Throws:

Exception - on error

deployUsingContentHandle

List<org.rhq.core.domain.plugin.Plugin> deployUsingContentHandle(org.rhq.core.domain.auth.Subject subject,
                                                               String pluginJarName,
                                                               String handle)
                                                                 throws Exception

Deploys a new agent plugin to RHQ asynchronously using the content handle pointing to a previously uploaded file.

This method returns after the plugin is deployed. Because there might be other plugins pending to be deployed in the filesystem, this operation might result in more than just the single requested plugin being deployed. This is why this method returns a list instead of a single plugin corresponding to the provided jar..

Parameters:

subject - the authenticated user

pluginJarName - the name of the jar file which should be used to store the plugin on the filesystem

handle - the handle to the uploaded file

Throws:

Exception - on error

See Also:

ContentManagerRemote.createTemporaryContentHandle(), ContentManagerRemote.uploadContentFragment(String, byte[], int, int)

findPluginsByCriteria

org.rhq.core.domain.util.PageList<org.rhq.core.domain.plugin.Plugin> findPluginsByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                         org.rhq.core.domain.criteria.PluginCriteria criteria)

Returns a list of plugins by criteria.

enablePlugins

void enablePlugins(org.rhq.core.domain.auth.Subject subject,
                 List<Integer> pluginIds)
                   throws Exception

Enables plugins by ID.

Throws:

Exception

disablePlugins

void disablePlugins(org.rhq.core.domain.auth.Subject subject,
                  List<Integer> pluginIds)
                    throws Exception

Disables plugins by ID.

Throws:

Exception

deletePlugins

void deletePlugins(org.rhq.core.domain.auth.Subject subject,
                 List<Integer> pluginIds)
                   throws Exception

This method puts the plugin into a deleted state and removes the plugin JAR file from the file system and schedules its eventual deletion from the database, too.

Parameters:

subject - The user performing the deletion

pluginIds - The ids of the plugins to be deleted

Throws:

Exception - if an error occurs