org.rhq.enterprise.server.discovery

Interface DiscoveryBossLocal

All Superinterfaces:

DiscoveryBossRemote

All Known Implementing Classes:

DiscoveryBossBean

public interface DiscoveryBossLocal
extends DiscoveryBossRemote

The boss interface to the discovery subsystem.

Method Summary

Methods

Modifier and Type	Method and Description
org.rhq.core.domain.discovery.MergeResourceResponse	addResource(org.rhq.core.domain.resource.Resource resource, int ownerSubjectId) Adds the specified resource to inventory, *auto-committing it*.
org.rhq.core.domain.discovery.PlatformSyncInfo	getPlatformSyncInfo(org.rhq.core.domain.resource.Agent knownAgent) Just get the top level server info for the agent's platform.
List<org.rhq.core.domain.resource.Resource>	getQueuedPlatformChildServers(org.rhq.core.domain.auth.Subject user, org.rhq.core.domain.resource.InventoryStatus status, org.rhq.core.domain.resource.Resource platform) Given a platform resource, this returns all of its child server resources that have been auto-discovered and have the given status.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.resource.Resource>	getQueuedPlatforms(org.rhq.core.domain.auth.Subject user, EnumSet<org.rhq.core.domain.resource.InventoryStatus> statuses, org.rhq.core.domain.util.PageControl pc) This returns all platform resources that either have the given status themselves or one or more of their child servers have that status.
Map<org.rhq.core.domain.resource.Resource,List<org.rhq.core.domain.resource.Resource>>	getQueuedPlatformsAndServers(org.rhq.core.domain.auth.Subject user, EnumSet<org.rhq.core.domain.resource.InventoryStatus> statuses, org.rhq.core.domain.util.PageControl pc) Deprecated. unused, remove when doing a deprecation cleanup
Map<org.rhq.core.domain.resource.Resource,List<org.rhq.core.domain.resource.Resource>>	getQueuedPlatformsAndServers(org.rhq.core.domain.auth.Subject user, org.rhq.core.domain.util.PageControl pc) Deprecated. used only by portal war, should be removed when possible.
Collection<org.rhq.core.domain.discovery.ResourceSyncInfo>	getResourceSyncInfo(int resourceId)
org.rhq.core.domain.resource.ImportResourceResponse	manuallyAddResource(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.resource.ImportResourceRequest importResourceRequest) Manually Add the resource to inventory using the type and plugin configuration (i.e.
org.rhq.core.domain.discovery.MergeInventoryReportResults	mergeInventoryReport(InventoryReport report) When agents send up results from their discovery components (which notifies the server about newly discovered resources), this method will eventually be called in order to process those inventory reports.
void	mergeResourceInNewTransaction(List<org.rhq.core.domain.resource.Resource> resourceBatch, org.rhq.core.domain.resource.Agent agent, Map<org.rhq.core.domain.resource.Resource,Set<org.rhq.enterprise.server.discovery.DiscoveryBossBean.PostMergeAction>> postMergeActions) Exists for transactional boundary reasons only.
void	updateAgentInventoryStatus(String platformsList, String serversList)
void	updateInventoryStatus(org.rhq.core.domain.auth.Subject user, List<org.rhq.core.domain.resource.Resource> platforms, List<org.rhq.core.domain.resource.Resource> servers, org.rhq.core.domain.resource.InventoryStatus status) This method is used to change the inventory status of a set of platforms and servers (e.g.
void	updateInventoryStatusInNewTransaction(org.rhq.core.domain.auth.Subject user, List<org.rhq.core.domain.resource.Resource> platforms, List<org.rhq.core.domain.resource.Resource> servers, org.rhq.core.domain.resource.InventoryStatus status) This is used internally.
boolean	updateResourceVersion(int resourceId, String version) Updates the version of the specified Resource in inventory, if it is indeed in inventory.
Set<ResourceUpgradeResponse>	upgradeResources(Set<ResourceUpgradeRequest> upgradeRequests) Upgrades the data of the resources according to the provided reports.

Methods inherited from interface org.rhq.enterprise.server.discovery.DiscoveryBossRemote

ignoreResources, importResources, manuallyAddResource, unignoreAndImportResources, unignoreResources

Method Detail

mergeInventoryReport

org.rhq.core.domain.discovery.MergeInventoryReportResults mergeInventoryReport(InventoryReport report)
                                                                               throws InvalidInventoryReportException

When agents send up results from their discovery components (which notifies the server about newly discovered resources), this method will eventually be called in order to process those inventory reports.

Parameters:

report - the inventory report to be merged

Returns:

the server's response, which will include the information necessary for the agent to start synchronizing its inventory with the server's inventory. This can return null in one specific case - if this is a brand new agent and it is currently initializing for the very first time.

Throws:

InvalidInventoryReportException - if the inventory report is invalid

mergeResourceInNewTransaction

void mergeResourceInNewTransaction(List<org.rhq.core.domain.resource.Resource> resourceBatch,
                                 org.rhq.core.domain.resource.Agent agent,
                                 Map<org.rhq.core.domain.resource.Resource,Set<org.rhq.enterprise.server.discovery.DiscoveryBossBean.PostMergeAction>> postMergeActions)
                                   throws InvalidInventoryReportException

Exists for transactional boundary reasons only.

Merge In the provided batch of resources. The list of resources must provide a parent before its child.

Parameters:

resourceBatch - a batch of resources

agent - the agent managing the resources

postMergeActions - a series of actions to perform on newly committed resources.

Throws:

InvalidInventoryReportException

getPlatformSyncInfo

org.rhq.core.domain.discovery.PlatformSyncInfo getPlatformSyncInfo(org.rhq.core.domain.resource.Agent knownAgent)

Just get the top level server info for the agent's platform. Then, each top level server can be individually synced

Parameters:

knownAgent - the agent for the platform we want to sync with

Returns:

null if platform not found

getResourceSyncInfo

Collection<org.rhq.core.domain.discovery.ResourceSyncInfo> getResourceSyncInfo(int resourceId)

Parameters:

resourceId - the root resourceId on which we want to sync

Returns:

null if resource not found, otherwise the entire tree rooted at the specified resource, as an unordered collection. Although not strictly a Set (to save on computation) this collection should not contain duplicates.

getQueuedPlatformsAndServers

@Deprecated
Map<org.rhq.core.domain.resource.Resource,List<org.rhq.core.domain.resource.Resource>> getQueuedPlatformsAndServers(org.rhq.core.domain.auth.Subject user,
                                                                                                                             org.rhq.core.domain.util.PageControl pc)

Deprecated. used only by portal war, should be removed when possible.

Returns a map of platforms (the keys) and their servers (the values) that are in the auto-discovery queue but not yet imported into inventory. Note that only servers whose direct parent is the platform will appear in the returned data. Embedded servers (i.e. servers that are children of other servers) will be automatically imported when you import their parent server.

Parameters:

user - the user that wants to see the data

pc - used to define the size of the returned map - will determine how many platforms are returned

Returns:

the platforms and servers that need to be imported or ignored

getQueuedPlatformsAndServers

@Deprecated
Map<org.rhq.core.domain.resource.Resource,List<org.rhq.core.domain.resource.Resource>> getQueuedPlatformsAndServers(org.rhq.core.domain.auth.Subject user,
                                                                                                                             EnumSet<org.rhq.core.domain.resource.InventoryStatus> statuses,
                                                                                                                             org.rhq.core.domain.util.PageControl pc)

Deprecated. unused, remove when doing a deprecation cleanup

Like the above method, but can find ignored, committed or both

Parameters:

user - the subject

statuses - the inventory status'

pc - page control

Returns:

the queued platforms and servers

getQueuedPlatforms

org.rhq.core.domain.util.PageList<org.rhq.core.domain.resource.Resource> getQueuedPlatforms(org.rhq.core.domain.auth.Subject user,
                                                                                          EnumSet<org.rhq.core.domain.resource.InventoryStatus> statuses,
                                                                                          org.rhq.core.domain.util.PageControl pc)

This returns all platform resources that either have the given status themselves or one or more of their child servers have that status. Use this to find those platforms that need to be shown in the auto-discovery pages (i.e. those that need to be committed to inventory). Can use this to find platforms that have servers that are ignored.

Parameters:

user - the user that wants to see the data

statuses - the statuses that platform or its child servers must have

pc - pagination controls

Returns:

the platforms

See Also:

getQueuedPlatformChildServers(org.rhq.core.domain.auth.Subject, org.rhq.core.domain.resource.InventoryStatus, org.rhq.core.domain.resource.Resource)

getQueuedPlatformChildServers

List<org.rhq.core.domain.resource.Resource> getQueuedPlatformChildServers(org.rhq.core.domain.auth.Subject user,
                                                                        org.rhq.core.domain.resource.InventoryStatus status,
                                                                        org.rhq.core.domain.resource.Resource platform)

Given a platform resource, this returns all of its child server resources that have been auto-discovered and have the given status.

Parameters:

user - the user that wants to see the data

status - the status that platform or its child servers must have

platform - the resource whose auto-discovered child servers must have the given status

Returns:

the give platform's top-level server children that have the given status

updateInventoryStatus

void updateInventoryStatus(org.rhq.core.domain.auth.Subject user,
                         List<org.rhq.core.domain.resource.Resource> platforms,
                         List<org.rhq.core.domain.resource.Resource> servers,
                         org.rhq.core.domain.resource.InventoryStatus status)

This method is used to change the inventory status of a set of platforms and servers (e.g. when users import new resources into inventory).

Parameters:

user - the user that wants to change the status

platforms - identifies the platforms that are to be updated

servers - identifies the servers that are to be updated

status - the new status the given resources will have

updateInventoryStatusInNewTransaction

void updateInventoryStatusInNewTransaction(org.rhq.core.domain.auth.Subject user,
                                         List<org.rhq.core.domain.resource.Resource> platforms,
                                         List<org.rhq.core.domain.resource.Resource> servers,
                                         org.rhq.core.domain.resource.InventoryStatus status)

This is used internally. Never call this yourself without knowing what you do. See updateInventoryStatus(Subject, List, List, InventoryStatus) for the "public" version.

Parameters:

user - the user that wants to change the status

platforms - identifies the platforms that are to be updated

servers - identifies the servers that are to be updated

status - the new status the given resources will have

manuallyAddResource

org.rhq.core.domain.resource.ImportResourceResponse manuallyAddResource(org.rhq.core.domain.auth.Subject subject,
                                                                      org.rhq.core.domain.resource.ImportResourceRequest importResourceRequest)
                                                                        throws InvalidPluginConfigurationClientException,
                                                                               PluginContainerException

Manually Add the resource to inventory using the type and plugin configuration (i.e. connection properties) specified in importResourceRequest. 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

importResourceRequest - the request

Returns:

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

Throws:

InvalidPluginConfigurationClientException - if connecting to the underlying managed resource failed due to an invalid plugin configuration

PluginContainerException - if the manual discovery fails for any other reason

addResource

org.rhq.core.domain.discovery.MergeResourceResponse addResource(org.rhq.core.domain.resource.Resource resource,
                                                              int ownerSubjectId)

Adds the specified resource to inventory, *auto-committing it*.

Parameters:

resource - the resource to be merged

ownerSubjectId - the user who should be the owner of the new Resource

Returns:

a response containing the merged resource, as well as whether the resource already existed in inventory

updateResourceVersion

boolean updateResourceVersion(int resourceId,
                            String version)

Updates the version of the specified Resource in inventory, if it is indeed in inventory. If the resource is already in inventory and its version is already version, then this method does nothing and returns true.

Parameters:

resourceId - the id of the Resource to be updated

version - the new version

Returns:

true if the Resource was in inventory and its version is now that of version. false if the Resource was not in inventory

upgradeResources

Set<ResourceUpgradeResponse> upgradeResources(Set<ResourceUpgradeRequest> upgradeRequests)

Upgrades the data of the resources according to the provided reports. The server is free to ignore or modify the requests and will provide the true changes made to the resources on the server-side in the result of this method.

Parameters:

upgradeRequests - contains the information about the upgrade of individual resources.

Returns:

details on what resources have been upgraded with what data.

updateAgentInventoryStatus

void updateAgentInventoryStatus(String platformsList,
                              String serversList)