org.rhq.core.clientapi.agent.inventory

Interface ResourceFactoryAgentService

public interface ResourceFactoryAgentService

Plugin container interface for performing create and delete resource operations.

Author:

Jason Dobies

Method Summary

Methods

Modifier and Type	Method and Description
void	createResource(CreateResourceRequest request) Requests that a resource be created.
void	deleteResource(DeleteResourceRequest request) This method is responsible for destroying an actual resource.
CreateResourceResponse	executeCreateResourceImmediately(CreateResourceRequest request) Requests that a resource be created.
DeleteResourceResponse	executeDeleteResourceImmediately(DeleteResourceRequest request) Requests that a resource be destroyed.

Method Detail

createResource

void createResource(CreateResourceRequest request)
                    throws PluginContainerException

Requests that a resource be created. The result of this creation will asynchronously be sent to a registered instance of ResourceFactoryServerService. The parameter requestId will be used to correlate the response call with this request.

Parameters:

request - contains all of the information necessary to create the resource; cannot be null

Throws:

PluginContainerException - if the plugin container cannot be reached or fails before forwarding the creation request to the appropriate plugin

executeCreateResourceImmediately

CreateResourceResponse executeCreateResourceImmediately(CreateResourceRequest request)
                                                        throws PluginContainerException

Requests that a resource be created. This method will execute synchronously and return the results of the create.

Parameters:

request - contains all of the information necessary to create the resource; cannot be null

Returns:

response object detailing the results of the operation

Throws:

PluginContainerException - if the plugin container cannot be reached or fails before forwarding the creation request to the appropriate plugin

deleteResource

void deleteResource(DeleteResourceRequest request)
                    throws PluginContainerException

This method is responsible for destroying an actual resource. For example, if the resource to be deleted is a JBossAS 4.0 Data Source, this method will effectively delete the -ds.xml file.

Parameters:

request - contains all of the information necessary to delete the resource; cannot be null

Throws:

PluginContainerException - if the plugin container cannot be reached or fails before forwarding the creation request to the appropriate plugin

executeDeleteResourceImmediately

DeleteResourceResponse executeDeleteResourceImmediately(DeleteResourceRequest request)
                                                        throws PluginContainerException

Requests that a resource be destroyed. This method will execute synchronously and return the result of the delete operation.

Parameters:

request - contains all of the information necessary to delete the resource; cannot be null

Returns:

response object detailing the results of the operation

Throws:

PluginContainerException - if the plugin container cannot be reached or fails before forwarding the delete request to the appropriate plugin