org.rhq.enterprise.server.discovery

Interface DiscoveryBossRemote

All Known Subinterfaces:

DiscoveryBossLocal

All Known Implementing Classes:

DiscoveryBossBean

public interface DiscoveryBossRemote

The remote boss interface to the discovery subsystem.

Method Summary

Methods

Modifier and Type	Method and Description
void	ignoreResources(org.rhq.core.domain.auth.Subject subject, int[] resourceIds) Analogous to the GUI feature Ignore Resources in the auto discovery queue.
void	importResources(org.rhq.core.domain.auth.Subject subject, int[] resourceIds) Analogous to the GUI feature Import Resources in the auto discovery queue.
org.rhq.core.domain.resource.Resource	manuallyAddResource(org.rhq.core.domain.auth.Subject subject, int resourceTypeId, int parentResourceId, org.rhq.core.domain.configuration.Configuration pluginConfiguration) Manually Add the resource of the specified type to inventory using the specified plugin configuration (i.e.
void	unignoreAndImportResources(org.rhq.core.domain.auth.Subject subject, int[] resourceIds) This is used to specifically unignore previously ignored resources.
void	unignoreResources(org.rhq.core.domain.auth.Subject subject, int[] resourceIds) Analogous to the GUI feature Unignore Resources in the auto discovery queue.

Method Detail

importResources

void importResources(org.rhq.core.domain.auth.Subject subject,
                   int[] resourceIds)

Analogous to the GUI feature Import Resources in the auto discovery queue. Note, to query for Resources with a specific InventoryStatus, see ResourceManagerRemote.findResourcesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.ResourceCriteria).

Parameters:

subject -

resourceIds -

ignoreResources

void ignoreResources(org.rhq.core.domain.auth.Subject subject,
                   int[] resourceIds)

Analogous to the GUI feature Ignore Resources in the auto discovery queue. This can also ignore committed resources as well. Note, to query for Resources with a specific InventoryStatus, see ResourceManagerRemote.findResourcesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.ResourceCriteria).

Parameters:

subject -

resourceIds -

unignoreResources

void unignoreResources(org.rhq.core.domain.auth.Subject subject,
                     int[] resourceIds)

Analogous to the GUI feature Unignore Resources in the auto discovery queue. Note, to query for Resources with a specific InventoryStatus, see ResourceManagerRemote.findResourcesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.ResourceCriteria).

Parameters:

subject -

resourceIds -

unignoreAndImportResources

void unignoreAndImportResources(org.rhq.core.domain.auth.Subject subject,
                              int[] resourceIds)

This is used to specifically unignore previously ignored resources. This has the added feature of immediately importing those newly unignored resources. This should only be used for unignoring those resources that were previously committed but ignored. Note, to query for Resources with a specific InventoryStatus, see ResourceManagerRemote.findResourcesByCriteria(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.criteria.ResourceCriteria).

Parameters:

subject -

resourceIds -

Since:

4.7

manuallyAddResource

org.rhq.core.domain.resource.Resource manuallyAddResource(org.rhq.core.domain.auth.Subject subject,
                                                        int resourceTypeId,
                                                        int parentResourceId,
                                                        org.rhq.core.domain.configuration.Configuration pluginConfiguration)
                                                          throws Exception

Manually Add the resource of the specified type to inventory using the specified plugin configuration (i.e. connection properties). This will not only create a new resource, but it will also ensure the resource component is activated (and thus connects to the managed resource).

Parameters:

subject - the user making the request

resourceTypeId - the type of resource to be manually discovered

parentResourceId - the id of the resource that will be the parent of the manually discovered resource

pluginConfiguration - the properties that should be used to connect to the underlying managed resource

Returns:

The resource. Note that the resource may have existed already if given the provided pluginConfiguration leads to a previously defined resource.

Throws:

Exception - if connecting to the underlying managed resource failed due to invalid plugin configuration or if the manual discovery fails for any reason.