org.rhq.enterprise.server.resource

Interface ResourceTypeManagerLocal

All Superinterfaces:

ResourceTypeManagerRemote

All Known Implementing Classes:

ResourceTypeManagerBean

public interface ResourceTypeManagerLocal
extends ResourceTypeManagerRemote

A manager that provides methods for creating, updating, deleting, and querying ResourceTypes.

Author:

Greg Hinkle, Ian Springer

Method Summary

Methods

Modifier and Type	Method and Description
boolean	ensureResourceType(org.rhq.core.domain.auth.Subject subject, Integer resourceTypeId, Integer[] resourceIds)
List<org.rhq.core.domain.resource.ResourceType>	getAllResourceTypeAncestors(org.rhq.core.domain.auth.Subject subject, int resourceTypeId)
List<org.rhq.core.domain.resource.ResourceType>	getAllResourceTypeDescendants(org.rhq.core.domain.auth.Subject subject, int resourceTypeId) Deprecated.
List<org.rhq.core.domain.resource.ResourceType>	getAllResourceTypesByCategory(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.resource.ResourceCategory category) Obtain ResourceTypes that match a given category or all if category is null.
List<org.rhq.core.domain.resource.ResourceType>	getChildResourceTypes(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.resource.ResourceType parent) Gets the list of resource types that are children of the specified resource type and that are viewable by the specified user.
List<org.rhq.core.domain.resource.ResourceType>	getChildResourceTypesByCategory(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.resource.Resource parentResource, org.rhq.core.domain.resource.ResourceCategory resourceCategory) Gets the list of resource types that are children of the specified resource type, that are in the specified resource category, and that are viewable by the specified user.
Map<Integer,SortedSet<org.rhq.core.domain.resource.ResourceType>>	getChildResourceTypesForResourceTypes(List<org.rhq.core.domain.resource.ResourceType> types) Return all ResourceTypes that are children of the passed ones
List<String>	getDuplicateTypeNames()
org.rhq.core.domain.resource.composite.ResourceFacets	getResourceFacets(int resourceTypeId) Return which facets are available for the passed return type.
org.rhq.core.domain.resource.ResourceType	getResourceTypeByNameAndPlugin(String name, String plugin)
Integer	getResourceTypeCountByPlugin(String plugin)
Map<String,Integer>	getResourceTypeCountsByGroup(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.resource.group.ResourceGroup group, boolean recursive)
HashMap<Integer,String>	getResourceTypeDescendantsWithOperations(org.rhq.core.domain.auth.Subject subject, int resourceTypeId)
List<Integer>	getResourceTypeIdsByPlugin(String plugin)
List<org.rhq.core.domain.resource.ResourceType>	getResourceTypesByPlugin(String pluginName)
List<org.rhq.core.domain.resource.ResourceType>	getResourceTypesForCompatibleGroups(org.rhq.core.domain.auth.Subject subject, String pluginName)
Map<Integer,org.rhq.core.domain.resource.composite.ResourceTypeTemplateCountComposite>	getTemplateCountCompositeMap()
List<org.rhq.core.domain.resource.ResourceType>	getUtilizedChildResourceTypesByCategory(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.resource.Resource parentResource, org.rhq.core.domain.resource.ResourceCategory resourceCategory)
List<String>	getUtilizedResourceTypeNamesByCategory(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.resource.ResourceCategory category, String nameFilter, String pluginName)
List<org.rhq.core.domain.resource.ResourceType>	getUtilizedResourceTypesByCategory(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.resource.ResourceCategory category, String nameFilter)
void	reloadResourceFacetsCache()
void	setResourceTypeIgnoreFlag(org.rhq.core.domain.auth.Subject subject, int resourceTypeId, boolean ignoreFlag) All this does is set the resource type's ignore flag to the given boolean value.
void	setResourceTypeMissingPolicy(org.rhq.core.domain.auth.Subject subject, int resourceTypeId, org.rhq.core.domain.resource.MissingPolicy policy) All this does is set the resource type's uninventoryMissing flag to the given boolean value.

Methods inherited from interface org.rhq.enterprise.server.resource.ResourceTypeManagerRemote

findResourceTypesByCriteria, getResourceTypeById, getResourceTypeByNameAndPlugin, setResourceTypeIgnoreFlagAndUninventoryResources

Method Detail

setResourceTypeIgnoreFlag

void setResourceTypeIgnoreFlag(org.rhq.core.domain.auth.Subject subject,
                             int resourceTypeId,
                             boolean ignoreFlag)

All this does is set the resource type's ignore flag to the given boolean value. DO NOT USE THIS - THIS IS FOR INTERNAL USE ONLY. You must use ResourceTypeManagerRemote.setResourceTypeIgnoreFlagAndUninventoryResources(Subject, int, boolean).

Parameters:

subject -

resourceTypeId -

ignoreFlag -

setResourceTypeMissingPolicy

void setResourceTypeMissingPolicy(org.rhq.core.domain.auth.Subject subject,
                                int resourceTypeId,
                                org.rhq.core.domain.resource.MissingPolicy policy)

All this does is set the resource type's uninventoryMissing flag to the given boolean value. DO NOT USE THIS - THIS IS FOR INTERNAL USE ONLY.

Parameters:

subject -

resourceTypeId -

policy -

getChildResourceTypes

List<org.rhq.core.domain.resource.ResourceType> getChildResourceTypes(org.rhq.core.domain.auth.Subject subject,
                                                                    org.rhq.core.domain.resource.ResourceType parent)

Gets the list of resource types that are children of the specified resource type and that are viewable by the specified user.

Parameters:

subject - an authz subject

parent - a resource type

Returns:

the list of resource types that are children of the specified resource type and that are viewable by the specified user

getChildResourceTypesByCategory

List<org.rhq.core.domain.resource.ResourceType> getChildResourceTypesByCategory(org.rhq.core.domain.auth.Subject subject,
                                                                              org.rhq.core.domain.resource.Resource parentResource,
                                                                              org.rhq.core.domain.resource.ResourceCategory resourceCategory)

Gets the list of resource types that are children of the specified resource type, that are in the specified resource category, and that are viewable by the specified user.

Parameters:

subject - an authz subject

parentResource - the parent resource

resourceCategory - a resource category

Returns:

the list of resource types that are children of the specified resource type, that are in the specified resource category, and that are viewable by the specified user

getUtilizedChildResourceTypesByCategory

List<org.rhq.core.domain.resource.ResourceType> getUtilizedChildResourceTypesByCategory(org.rhq.core.domain.auth.Subject subject,
                                                                                      org.rhq.core.domain.resource.Resource parentResource,
                                                                                      org.rhq.core.domain.resource.ResourceCategory resourceCategory)

getUtilizedResourceTypesByCategory

List<org.rhq.core.domain.resource.ResourceType> getUtilizedResourceTypesByCategory(org.rhq.core.domain.auth.Subject subject,
                                                                                 org.rhq.core.domain.resource.ResourceCategory category,
                                                                                 String nameFilter)

getUtilizedResourceTypeNamesByCategory

List<String> getUtilizedResourceTypeNamesByCategory(org.rhq.core.domain.auth.Subject subject,
                                                  org.rhq.core.domain.resource.ResourceCategory category,
                                                  String nameFilter,
                                                  String pluginName)

getResourceTypesForCompatibleGroups

List<org.rhq.core.domain.resource.ResourceType> getResourceTypesForCompatibleGroups(org.rhq.core.domain.auth.Subject subject,
                                                                                  String pluginName)

getResourceTypeCountsByGroup

Map<String,Integer> getResourceTypeCountsByGroup(org.rhq.core.domain.auth.Subject subject,
                                               org.rhq.core.domain.resource.group.ResourceGroup group,
                                               boolean recursive)

ensureResourceType

boolean ensureResourceType(org.rhq.core.domain.auth.Subject subject,
                         Integer resourceTypeId,
                         Integer[] resourceIds)
                           throws ResourceTypeNotFoundException

Throws:

ResourceTypeNotFoundException

getResourceFacets

org.rhq.core.domain.resource.composite.ResourceFacets getResourceFacets(int resourceTypeId)

Return which facets are available for the passed return type. This is e.g. used to determine which tabs (Monitor, Inventory, ...) can be displayed for a resource of a certain type

reloadResourceFacetsCache

void reloadResourceFacetsCache()

getAllResourceTypesByCategory

List<org.rhq.core.domain.resource.ResourceType> getAllResourceTypesByCategory(org.rhq.core.domain.auth.Subject subject,
                                                                            org.rhq.core.domain.resource.ResourceCategory category)

Obtain ResourceTypes that match a given category or all if category is null. Note that the caller needs to have Permission.MANAGE_SETTING in order to successfully call this method.

Parameters:

subject - subject of the caller

category - the category to check for. If this is null, entries from all cateories will be returned.

Returns:

a List of ResourceTypes

See Also:

Permission, ResourceCategory

getChildResourceTypesForResourceTypes

Map<Integer,SortedSet<org.rhq.core.domain.resource.ResourceType>> getChildResourceTypesForResourceTypes(List<org.rhq.core.domain.resource.ResourceType> types)

Return all ResourceTypes that are children of the passed ones

Parameters:

types - List of ResourceTypes

Returns:

SortedSet of ResourceTypes. If nothing is found, then this set is empty

getTemplateCountCompositeMap

Map<Integer,org.rhq.core.domain.resource.composite.ResourceTypeTemplateCountComposite> getTemplateCountCompositeMap()

getResourceTypesByPlugin

List<org.rhq.core.domain.resource.ResourceType> getResourceTypesByPlugin(String pluginName)

getResourceTypeIdsByPlugin

List<Integer> getResourceTypeIdsByPlugin(String plugin)

getResourceTypeCountByPlugin

Integer getResourceTypeCountByPlugin(String plugin)

getDuplicateTypeNames

List<String> getDuplicateTypeNames()

getResourceTypeByNameAndPlugin

org.rhq.core.domain.resource.ResourceType getResourceTypeByNameAndPlugin(String name,
                                                                       String plugin)

getResourceTypeDescendantsWithOperations

HashMap<Integer,String> getResourceTypeDescendantsWithOperations(org.rhq.core.domain.auth.Subject subject,
                                                               int resourceTypeId)

getAllResourceTypeAncestors

List<org.rhq.core.domain.resource.ResourceType> getAllResourceTypeAncestors(org.rhq.core.domain.auth.Subject subject,
                                                                          int resourceTypeId)

getAllResourceTypeDescendants

@Deprecated
List<org.rhq.core.domain.resource.ResourceType> getAllResourceTypeDescendants(org.rhq.core.domain.auth.Subject subject,
                                                                                       int resourceTypeId)

Deprecated.