org.rhq.core.clientapi.agent.configuration
Interface ConfigurationAgentService

public interface ConfigurationAgentService

Interface to the plugin container for triggering configuration operations on the plugin's resources.

Method Summary

ConfigurationUpdateResponse	executeUpdateResourceConfigurationImmediately(ConfigurationUpdateRequest request) Configures a resource with the new set of configuration values found in the Configuration object within the given request.
Configuration	loadResourceConfiguration(int resourceId) Loads the current configuration for the given resource.
void	updateResourceConfiguration(ConfigurationUpdateRequest request) Configures a resource with the new set of configuration values found in the Configuration object within the given request.

Method Detail

updateResourceConfiguration

void updateResourceConfiguration(ConfigurationUpdateRequest request)

Configures a resource with the new set of configuration values found in the Configuration object within the given request. This configuration contains the entire configuration for the resource and not simply a series of changes to the existing values. The plugin responsible for managing the given resource must inform that resource that its configuration has changed to the given set of new values.

Note that this method should not throw any exceptions; instead, all error conditions should be indicated in the response object when sent back to the caller.

Parameters:

request - tells you the resource to configure and the full set of configuration values for the resource

executeUpdateResourceConfigurationImmediately

ConfigurationUpdateResponse executeUpdateResourceConfigurationImmediately(ConfigurationUpdateRequest request)
                                                                          throws PluginContainerException

Configures a resource with the new set of configuration values found in the Configuration object within the given request. This configuration contains the entire configuration for the resource and not simply a series of changes to the existing values. The plugin responsible for managing the given resource must inform that resource that its configuration has changed to the given set of new values.

Note that this method should not throw any exceptions for configuration errors; instead, all error conditions should be indicated in the response object when sent back to the caller. Any Runtime or Plugin Excpetions will still be thrown

Parameters:

request - tells you the resource to configure and the full set of configuration values for the resource

Returns:

ConfigurationUpdateResponse response object with the updated values and also any specific errors on a configuration

Throws:

PluginContainerException - if update fails due to an unrecoverable error, then a PluginContainerException is thrown.

loadResourceConfiguration

Configuration loadResourceConfiguration(int resourceId)
                                        throws PluginContainerException

Loads the current configuration for the given resource. This returns the entire set of configuration values for the resource.

Parameters:

resourceId - id of the resource to load

Returns:

current values of the entire configuration for the resource

Throws:

PluginContainerException - if a runtime or plugin error occurs a PluginContainerException is thrown