org.rhq.enterprise.server.rest

Class AbstractRestBean

java.lang.Object

org.rhq.enterprise.server.rest.AbstractRestBean

Direct Known Subclasses:

AlertDefinitionHandler, AlertDefinitionHandlerBean, AlertHandlerBean, ConfigurationHistoryHandler, ContentHandlerBean, EventHandlerBean, GroupHandlerBean, InventorySummaryHandler, MetricHandlerBean, OperationsHandlerBean, PlatformUtilizationHandler, PluginHandlerBean, RecentAlertHandler, RecentDriftHandler, RecentOperationsHandler, ReportsHandlerBean, ResourceHandlerBean, ResourceTypeHandlerBean, RootHandlerBean, StatusHandlerBean, SuspectMetricHandler, UserHandlerBean

public class AbstractRestBean
extends Object

Abstract base class for EJB classes that implement REST methods. For the cache and its eviction policies see standalone-full.xml (in the RHQ Server's AS7/standalone/configuration directory, as modified by the installer.)

Author:

Heiko W. Rupp, Jay Shaughnessy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractRestBean.CacheKey

Field Summary

Fields

Modifier and Type	Field and Description
protected org.infinispan.Cache<AbstractRestBean.CacheKey,Object>	cache
protected org.rhq.core.domain.auth.Subject	caller Subject of the caller that gets injected via SetCallerInterceptor
protected org.apache.commons.logging.Log	log
protected ResourceManagerLocal	resMgr
protected ResourceGroupManagerLocal	resourceGroupManager
protected String	wrappedCollectionJson
protected javax.ws.rs.core.MediaType	wrappedCollectionJsonType

Constructor Summary

Constructors

Constructor and Description
AbstractRestBean()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	createPagingHeader(javax.ws.rs.core.Response.ResponseBuilder builder, javax.ws.rs.core.UriInfo uriInfo, org.rhq.core.domain.util.PageList<?> resultList) Create the paging headers for collections and attach them to the passed builder.
protected Link	createUILink(javax.ws.rs.core.UriInfo uriInfo, UILinkTemplate template, Integer... entityId) Creates a link to the respective entry in coregui
protected org.rhq.core.domain.resource.group.ResourceGroup	fetchGroup(int groupId, boolean requireCompatible) Fetch the group with the passed id
protected org.rhq.core.domain.resource.Resource	fetchResource(int resourceId)
protected GroupRest	fillGroup(org.rhq.core.domain.resource.group.ResourceGroup group, javax.ws.rs.core.UriInfo uriInfo)
ResourceWithType	fillRWT(org.rhq.core.domain.resource.Resource res, javax.ws.rs.core.UriInfo uriInfo)
protected <T> T	getFromCache(AbstractRestBean.CacheKey key, Class<T> clazz) Retrieve an object from the cache if present or null otherwise.
protected <T> T	getFromCache(int id, Class<T> clazz) Retrieve an object from the cache.
protected Link	getLinkToGroup(org.rhq.core.domain.resource.group.ResourceGroup group, javax.ws.rs.core.UriInfo uriInfo, String rel)
protected Link	getLinkToResource(org.rhq.core.domain.resource.Resource res, javax.ws.rs.core.UriInfo uriInfo, String rel)
protected Link	getLinkToResourceType(org.rhq.core.domain.resource.ResourceType type, javax.ws.rs.core.UriInfo uriInfo, String rel)
protected MetricSchedule	getMetricScheduleInternal(javax.ws.rs.core.UriInfo uriInfo, org.rhq.core.domain.measurement.MeasurementSchedule schedule, org.rhq.core.domain.measurement.MeasurementDefinition definition)
protected <T> javax.ws.rs.core.Response.ResponseBuilder	paginate(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo, org.rhq.core.domain.util.PageList<?> pageList, List<T> results, Class<T> elementType) Creates a response builder with "ok" response containing the provided list and applied pagination as prescribed by the pageList.
protected <T> boolean	putToCache(AbstractRestBean.CacheKey key, T o) Put an object into the cache.
protected <T> boolean	putToCache(int id, Class<T> clazz, T o) Put an object into the cache identified by its type and id
protected <T> boolean	removeFromCache(int id, Class<T> clazz) Remove an item from the cache
protected String	renderTemplate(String templateName, Object objectToRender) Renders the passed object with the help of a freemarker template into a string.
protected void	setCachingHeader(javax.ws.rs.core.Response.ResponseBuilder builder, int maxAgeSecs) Set the caching header on the response
void	start()
protected javax.ws.rs.core.Response.ResponseBuilder	withMediaType(javax.ws.rs.core.Response.ResponseBuilder builder, javax.ws.rs.core.HttpHeaders headers)
protected <T> void	wrapForPaging(javax.ws.rs.core.Response.ResponseBuilder builder, javax.ws.rs.core.UriInfo uriInfo, org.rhq.core.domain.util.PageList<?> originalList, Collection<T> resultList) Wrap the passed collection #resultList in an object with paging information If you need no further "building" of the response apart from paginating, you should look into using the paginate(javax.ws.rs.core.HttpHeaders, javax.ws.rs.core.UriInfo, org.rhq.core.domain.util.PageList, java.util.List, Class).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected org.apache.commons.logging.Log log

wrappedCollectionJsonType

protected final javax.ws.rs.core.MediaType wrappedCollectionJsonType

wrappedCollectionJson

protected final String wrappedCollectionJson

See Also:

Constant Field Values

cache

protected org.infinispan.Cache<AbstractRestBean.CacheKey,Object> cache

caller

protected org.rhq.core.domain.auth.Subject caller

Subject of the caller that gets injected via SetCallerInterceptor

resMgr

protected ResourceManagerLocal resMgr

resourceGroupManager

protected ResourceGroupManagerLocal resourceGroupManager

Constructor Detail

AbstractRestBean

public AbstractRestBean()

Method Detail

start

@PostConstruct
public void start()

renderTemplate

protected String renderTemplate(String templateName,
                    Object objectToRender)

Renders the passed object with the help of a freemarker template into a string. Freemarket templates are searched in the class path in a directory called "/rest_templates". In the usual Maven tree structure, this is below src/main/resources/.

Parameters:

templateName - Template to use for rendering. If the template name does not end in .ftl, .ftl is appended.

objectToRender - Object to render via template

Returns:

Template filled with data from objectToRender

getFromCache

protected <T> T getFromCache(int id,
                 Class<T> clazz)

Retrieve an object from the cache. This is identified by its class and id

Parameters:

id - Id of the object to load.

clazz - Wanted return type

Returns:

Object if found and the caller has access to it.

See Also:

getFromCache(int, Class)

getFromCache

protected <T> T getFromCache(AbstractRestBean.CacheKey key,
                 Class<T> clazz)

Retrieve an object from the cache if present or null otherwise. We need to be careful here as we must not return objects the current caller has no access to. We do this by checking the "readers" attribute of the selected node to see if the caller has put the object there

Parameters:

key - FullyQualified name (=path in cache) of the object to retrieve

clazz - Return type

Returns:

The desired object if found and valid for the current caller. Null otherwise.

See Also:

putToCache(CacheKey, Object)

putToCache

protected <T> boolean putToCache(int id,
                     Class<T> clazz,
                     T o)

Put an object into the cache identified by its type and id

Parameters:

id - Id of the object to put

clazz - Type to put in

o - Object to put

Returns:

true if put was successful

See Also:

putToCache(CacheKey, Object)

putToCache

protected <T> boolean putToCache(AbstractRestBean.CacheKey key,
                     T o)

Put an object into the cache. We need to record the caller so that we can later check if the caller can access that object or not.

Parameters:

key - Fully qualified name (=path to object)

o - Object to put

Returns:

true if put was successful

See Also:

getFromCache(CacheKey, Class)

removeFromCache

protected <T> boolean removeFromCache(int id,
                          Class<T> clazz)

Remove an item from the cache

Parameters:

id - Id of the item

clazz - Type of object for that node

Returns:

true if object is no longer in cache

fillRWT

public ResourceWithType fillRWT(org.rhq.core.domain.resource.Resource res,
                       javax.ws.rs.core.UriInfo uriInfo)

getLinkToResource

protected Link getLinkToResource(org.rhq.core.domain.resource.Resource res,
                     javax.ws.rs.core.UriInfo uriInfo,
                     String rel)

getLinkToResourceType

protected Link getLinkToResourceType(org.rhq.core.domain.resource.ResourceType type,
                         javax.ws.rs.core.UriInfo uriInfo,
                         String rel)

getLinkToGroup

protected Link getLinkToGroup(org.rhq.core.domain.resource.group.ResourceGroup group,
                  javax.ws.rs.core.UriInfo uriInfo,
                  String rel)

fetchResource

protected org.rhq.core.domain.resource.Resource fetchResource(int resourceId)

withMediaType

protected javax.ws.rs.core.Response.ResponseBuilder withMediaType(javax.ws.rs.core.Response.ResponseBuilder builder,
                                                      javax.ws.rs.core.HttpHeaders headers)

paginate

protected <T> javax.ws.rs.core.Response.ResponseBuilder paginate(javax.ws.rs.core.HttpHeaders headers,
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     org.rhq.core.domain.util.PageList<?> pageList,
                                                     List<T> results,
                                                     Class<T> elementType)

Creates a response builder with "ok" response containing the provided list and applied pagination as prescribed by the pageList.

Type Parameters:

T - the type of the entities contained in the result list

Parameters:

headers - the http headers

uriInfo - uri info

pageList - the "original" list coming from the EJB layer containing the paging info

results - the result list with REST-ready entities

elementType - the type of the entities contained in the result list

Returns:

the builder for the response

createPagingHeader

protected void createPagingHeader(javax.ws.rs.core.Response.ResponseBuilder builder,
                      javax.ws.rs.core.UriInfo uriInfo,
                      org.rhq.core.domain.util.PageList<?> resultList)

Create the paging headers for collections and attach them to the passed builder. Those are represented as Link: http headers that carry the URL for the pages and the respective relation.
In addition a X-total-size header is created that contains the whole collection size.

If you need no further "building" of the response apart from paginating, you should look into using the paginate(javax.ws.rs.core.HttpHeaders, javax.ws.rs.core.UriInfo, org.rhq.core.domain.util.PageList, java.util.List, Class).

Parameters:

builder - The ResponseBuilder that receives the headers

uriInfo - The uriInfo of the incoming request to build the urls

resultList - The collection with its paging information

wrapForPaging

protected <T> void wrapForPaging(javax.ws.rs.core.Response.ResponseBuilder builder,
                     javax.ws.rs.core.UriInfo uriInfo,
                     org.rhq.core.domain.util.PageList<?> originalList,
                     Collection<T> resultList)

Wrap the passed collection #resultList in an object with paging information

If you need no further "building" of the response apart from paginating, you should look into using the paginate(javax.ws.rs.core.HttpHeaders, javax.ws.rs.core.UriInfo, org.rhq.core.domain.util.PageList, java.util.List, Class).

Parameters:

builder - ResonseBuilder to add the entity to

uriInfo - UriInfo to construct paging links

originalList - The original list to obtain the paging info from

resultList - The list of result items

fetchGroup

protected org.rhq.core.domain.resource.group.ResourceGroup fetchGroup(int groupId,
                                                          boolean requireCompatible)

Fetch the group with the passed id

Parameters:

groupId - id of the resource group

requireCompatible - Does the group have to be a compatible group?

Returns:

the group object if found

Throws:

StuffNotFoundException - if the group is not found (or not accessible by the caller)

BadArgumentException - if a compatible group is required, but the found one is not a compatible one

fillGroup

protected GroupRest fillGroup(org.rhq.core.domain.resource.group.ResourceGroup group,
                  javax.ws.rs.core.UriInfo uriInfo)

createUILink

protected Link createUILink(javax.ws.rs.core.UriInfo uriInfo,
                UILinkTemplate template,
                Integer... entityId)

Creates a link to the respective entry in coregui

Parameters:

uriInfo - The uriInfo object to build the final url from

template - Template to use

entityId - Ids of the various entities used in the template

Returns:

A Link object

getMetricScheduleInternal

protected MetricSchedule getMetricScheduleInternal(javax.ws.rs.core.UriInfo uriInfo,
                                       org.rhq.core.domain.measurement.MeasurementSchedule schedule,
                                       org.rhq.core.domain.measurement.MeasurementDefinition definition)

setCachingHeader

protected void setCachingHeader(javax.ws.rs.core.Response.ResponseBuilder builder,
                    int maxAgeSecs)

Set the caching header on the response

Parameters:

builder - Response builder to put the caching header on

maxAgeSecs - Max retention time on the client. Only set if the value is > 0