org.rhq.enterprise.server.resource

Interface ResourceManagerRemote

All Known Subinterfaces:

ResourceManagerLocal

All Known Implementing Classes:

ResourceManagerBean

public interface ResourceManagerRemote

Author:

Jay Shaughnessy, Simeon Pinder, Asaf Shakarchi

Method Summary

Methods

Modifier and Type	Method and Description
List<Integer>	disableResources(org.rhq.core.domain.auth.Subject subject, int[] resourceIds) Set these resources to AvailabilityType.DISABLED.
List<Integer>	enableResources(org.rhq.core.domain.auth.Subject subject, int[] resourceIds) Set these resources enabled.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.resource.Resource>	findChildResources(org.rhq.core.domain.auth.Subject subject, int resourceId, org.rhq.core.domain.util.PageControl pageControl)
List<org.rhq.core.domain.resource.Resource>	findResourceLineage(org.rhq.core.domain.auth.Subject subject, int resourceId) Returns the lineage of the Resource with the specified id.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.resource.Resource>	findResourcesByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.ResourceCriteria criteria)
org.rhq.core.domain.resource.composite.ResourceAvailabilitySummary	getAvailabilitySummary(org.rhq.core.domain.auth.Subject subject, int resourceId) Returns a summary object that provides information about a resource's past availability history.
org.rhq.core.domain.measurement.ResourceAvailability	getLiveResourceAvailability(org.rhq.core.domain.auth.Subject subject, int resourceId) Returns the availability of the resource with the specified id.
org.rhq.core.domain.resource.Resource	getParentResource(org.rhq.core.domain.auth.Subject subject, int resourceId)
org.rhq.core.domain.resource.Resource	getResource(org.rhq.core.domain.auth.Subject subject, int resourceId) Returns the Resource with the specified id.
Map<Integer,String>	getResourcesAncestry(org.rhq.core.domain.auth.Subject subject, Integer[] resourceIds, org.rhq.core.domain.resource.ResourceAncestryFormat format) Resource.ancestry is an encoded value that holds the resource's parental ancestry.
void	uninventoryAllResourcesByAgent(org.rhq.core.domain.auth.Subject user, org.rhq.core.domain.resource.Agent doomedAgent) This will uninventory all resources managed by the given agent.
List<Integer>	uninventoryResources(org.rhq.core.domain.auth.Subject subject, int[] resourceIds) Removes these resources from inventory.
void	uninventoryResourcesOfResourceType(org.rhq.core.domain.auth.Subject subject, int resourceTypeId) Given a specific resource type, this will uninventory all resources of that type.
org.rhq.core.domain.resource.Resource	updateResource(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.resource.Resource resource) Update resource's editable properties (name, description, location).

Method Detail

getAvailabilitySummary

org.rhq.core.domain.resource.composite.ResourceAvailabilitySummary getAvailabilitySummary(org.rhq.core.domain.auth.Subject subject,
                                                                                        int resourceId)

Returns a summary object that provides information about a resource's past availability history.

Parameters:

subject -

resourceId -

Returns:

summary POJO

getLiveResourceAvailability

org.rhq.core.domain.measurement.ResourceAvailability getLiveResourceAvailability(org.rhq.core.domain.auth.Subject subject,
                                                                               int resourceId)

Returns the availability of the resource with the specified id. This performs a live check - a resource will be considered UNKNOWN if the agent cannot be contacted for any reason.

Parameters:

subject - The logged in user's subject.

resourceId - the id of a Resource in inventory.

Returns:

the resource availability - note that if the encapsulated availability type is null, the resource availability is UNKNOWN. As of RHQ 4.4 this does not return null but rather AvailabilityType.UNKNOWN.

getResource

org.rhq.core.domain.resource.Resource getResource(org.rhq.core.domain.auth.Subject subject,
                                                int resourceId)
                                                  throws ResourceNotFoundException,
                                                         PermissionException

Returns the Resource with the specified id.

Parameters:

subject - The logged in user's subject.

resourceId - the id of a Resource in inventory.

Returns:

the resource

Throws:

ResourceNotFoundException - if the resource represented by the resourceId parameter does not exist.

PermissionException - if the user does not have view permission for the resource

findResourceLineage

List<org.rhq.core.domain.resource.Resource> findResourceLineage(org.rhq.core.domain.auth.Subject subject,
                                                              int resourceId)

Returns the lineage of the Resource with the specified id. The lineage is represented as a List of Resources, with the first item being the root of the Resource's ancestry (or the Resource itself if it is a root Resource (i.e. a platform)) and the last item being the Resource itself. Since the lineage includes the Resource itself, the returned List will always contain at least one item.

Parameters:

subject - The logged in user's subject.

resourceId - the id of a Resource in inventory

Returns:

the lineage of the Resource with the specified id

Throws:

ResourceNotFoundException - if the resource represented by the resourceId parameter does not exist.

PermissionException - if the user does not have view permission for a resource in the lineage

updateResource

org.rhq.core.domain.resource.Resource updateResource(org.rhq.core.domain.auth.Subject subject,
                                                   org.rhq.core.domain.resource.Resource resource)

Update resource's editable properties (name, description, location).

Parameters:

subject - the logged in user

resource - the resource to update

Returns:

the updated resource

uninventoryAllResourcesByAgent

void uninventoryAllResourcesByAgent(org.rhq.core.domain.auth.Subject user,
                                  org.rhq.core.domain.resource.Agent doomedAgent)

This will uninventory all resources managed by the given agent. Since this also removes the platform resource, this will also remove the given agent as well.

Parameters:

user - the logged in user

doomedAgent - the agent to be deleted and whose resources are to be uninventoried

Since:

4.7

uninventoryResourcesOfResourceType

void uninventoryResourcesOfResourceType(org.rhq.core.domain.auth.Subject subject,
                                      int resourceTypeId)

Given a specific resource type, this will uninventory all resources of that type.

Parameters:

subject - the logged in user

resourceTypeId - identifies the type whose resources are to be uninventoried

Since:

4.7

uninventoryResources

List<Integer> uninventoryResources(org.rhq.core.domain.auth.Subject subject,
                                 int[] resourceIds)

Removes these resources from inventory. The resources may subsequently be rediscovered. Note that for each specified resource all children will also be removed, it it not necessary or recommended to specify more than one resource in the same ancestry line.

Parameters:

subject - The logged in user's subject.

resourceIds - The resources to uninventory.

Returns:

the resource ids of the uninventoried resources

findResourcesByCriteria

org.rhq.core.domain.util.PageList<org.rhq.core.domain.resource.Resource> findResourcesByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                               org.rhq.core.domain.criteria.ResourceCriteria criteria)

Parameters:

subject -

criteria -

Returns:

not null

findChildResources

org.rhq.core.domain.util.PageList<org.rhq.core.domain.resource.Resource> findChildResources(org.rhq.core.domain.auth.Subject subject,
                                                                                          int resourceId,
                                                                                          org.rhq.core.domain.util.PageControl pageControl)

Parameters:

subject -

resourceId -

pageControl -

Returns:

not null

getParentResource

org.rhq.core.domain.resource.Resource getParentResource(org.rhq.core.domain.auth.Subject subject,
                                                      int resourceId)
                                                        throws ResourceNotFoundException,
                                                               PermissionException

Parameters:

subject -

resourceId -

Returns:

the parent resource or null if the resource has no parent

Throws:

ResourceNotFoundException - if the resource does not exist

PermissionException - if the user does not have view permission for a resource in the lineage

getResourcesAncestry

Map<Integer,String> getResourcesAncestry(org.rhq.core.domain.auth.Subject subject,
                                       Integer[] resourceIds,
                                       org.rhq.core.domain.resource.ResourceAncestryFormat format)

Resource.ancestry is an encoded value that holds the resource's parental ancestry. It is not suitable for display. This method can be used to get decoded and formatted ancestry values for a set of resources. A typical usage would a criteria resource fetch, and then a subsequent call to this method for ancestry display, potentially for resource disambiguation purposes.

Parameters:

subject -

resourceIds -

format -

Returns:

A Map of ResourceIds to FormattedAncestryStrings, one entry for each unique, valid, resourceId passed in.

disableResources

List<Integer> disableResources(org.rhq.core.domain.auth.Subject subject,
                             int[] resourceIds)

Set these resources to AvailabilityType.DISABLED. While disabled resource availability reported from the agent is ignored. This is typically used for resources undergoing scheduled maintenance or whose avail state should be disregarded for some period.

The calling user must possess Permission.DELETE_RESOURCE permission on all of the provided resources.

Resources already disabled are ignored.

Parameters:

subject - The logged in user's subject.

resourceIds - The resources to disable.

Returns:

the disabled resource ids, not null

See Also:

enableResources(Subject, int[])

enableResources

List<Integer> enableResources(org.rhq.core.domain.auth.Subject subject,
                            int[] resourceIds)

Set these resources enabled. Resources already enabled are ignored. The availability will be set to UNKNOWN until the agent reports a new, live, availability. The agent will be requested to check availability for the enabled resources at its earliest convenience.

The calling user must possess Permission.DELETE_RESOURCE permission on all of the provided resources.

Parameters:

subject - The logged in user's subject.

resourceIds - The resources to enable.

Returns:

the enable resource ids, not null

See Also:

disableResources(Subject, int[])