org.rhq.enterprise.server.rest

Class AbstractRestBean

java.lang.Object

org.rhq.enterprise.server.rest.AbstractRestBean

Direct Known Subclasses:

AlertDefinitionHandler, AlertDefinitionHandlerBean, AlertHandlerBean, ConfigurationHistoryHandler, EventHandlerBean, GroupHandlerBean, InventorySummaryHandler, MetricHandlerBean, OperationsHandlerBean, PlatformUtilizationHandler, RecentAlertHandler, RecentDriftHandler, RecentOperationsHandler, ReportsHandlerBean, ResourceHandlerBean, 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.infinispan.manager.CacheContainer	container

Constructor Summary

Constructors

Constructor and Description
AbstractRestBean()

Method Summary

Methods

Modifier and Type	Method and Description
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 org.rhq.core.domain.resource.Resource	getResourceFromCache(int resourceid)
protected List<org.rhq.core.domain.resource.Resource>	getResourcesFromCacheByParentId(int pid)
protected void	putResourceToCache(org.rhq.core.domain.resource.Resource res)
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.
void	start()

Methods inherited from class java.lang.Object

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

Field Detail

container

protected org.infinispan.manager.CacheContainer container

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

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)

putResourceToCache

protected void putResourceToCache(org.rhq.core.domain.resource.Resource res)

getResourcesFromCacheByParentId

protected List<org.rhq.core.domain.resource.Resource> getResourcesFromCacheByParentId(int pid)

getResourceFromCache

protected org.rhq.core.domain.resource.Resource getResourceFromCache(int resourceid)

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)

fetchResource

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

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)