org.rhq.enterprise.server.rest
Interface ResourceHandlerLocal

All Known Implementing Classes:

ResourceHandlerBean

public interface ResourceHandlerLocal

Interface class that describes the REST interface

Author:

Heiko W. Rupp

Field Summary

static String

NO_RESOURCE_FOR_ID

Method Summary

javax.ws.rs.core.Response	createPlatform(String name, StringValue type, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	createResource(String name, StringValue type, String plugin, int parentId, javax.ws.rs.core.UriInfo uriInfo)
List<Link>	getAlertsForResource(int resourceId)
javax.ws.rs.core.Response	getAvailability(int resourceId, javax.ws.rs.core.HttpHeaders headers)
javax.ws.rs.core.Response	getAvailabilityHistory(int resourceId, long start, long end, javax.ws.rs.core.HttpHeaders headers)
javax.ws.rs.core.Response	getChildren(int id, javax.ws.rs.core.Request request, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo)
ResourceWithChildren	getHierarchy(int baseResourceId)
javax.ws.rs.core.Response	getPlatforms(javax.ws.rs.core.Request request, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	getResource(int id, javax.ws.rs.core.Request request, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	getSchedules(int resourceId, String scheduleType, boolean enabledOnly, String name, javax.ws.rs.core.Request request, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uriInfo)
void	reportAvailability(int resourceId, AvailabilityRest avail)

Field Detail

NO_RESOURCE_FOR_ID

static final String NO_RESOURCE_FOR_ID

See Also:

Constant Field Values

Method Detail

getResource

@AddLinks
@LinkResources(value=@LinkResource(rel="children",value=ResourceWithType.class))
javax.ws.rs.core.Response getResource(int id,
                                                                                                @Context
                                                                                                javax.ws.rs.core.Request request,
                                                                                                @Context
                                                                                                javax.ws.rs.core.HttpHeaders headers,
                                                                                                @Context
                                                                                                javax.ws.rs.core.UriInfo uriInfo)

getPlatforms

javax.ws.rs.core.Response getPlatforms(@Context
                                       javax.ws.rs.core.Request request,
                                       @Context
                                       javax.ws.rs.core.HttpHeaders headers,
                                       @Context
                                       javax.ws.rs.core.UriInfo uriInfo)

getHierarchy

ResourceWithChildren getHierarchy(int baseResourceId)

getAvailability

javax.ws.rs.core.Response getAvailability(int resourceId,
                                          @Context
                                          javax.ws.rs.core.HttpHeaders headers)

getAvailabilityHistory

javax.ws.rs.core.Response getAvailabilityHistory(int resourceId,
                                                 long start,
                                                 long end,
                                                 @Context
                                                 javax.ws.rs.core.HttpHeaders headers)

reportAvailability

void reportAvailability(int resourceId,
                        AvailabilityRest avail)

getSchedules

@LinkResource(rel="schedules",
              value=MetricSchedule.class)
javax.ws.rs.core.Response getSchedules(int resourceId,
                                                                        String scheduleType,
                                                                        boolean enabledOnly,
                                                                        String name,
                                                                        @Context
                                                                        javax.ws.rs.core.Request request,
                                                                        @Context
                                                                        javax.ws.rs.core.HttpHeaders headers,
                                                                        @Context
                                                                        javax.ws.rs.core.UriInfo uriInfo)

getChildren

@LinkResource(rel="children",
              value=ResourceWithType.class)
javax.ws.rs.core.Response getChildren(int id,
                                                                         @Context
                                                                         javax.ws.rs.core.Request request,
                                                                         @Context
                                                                         javax.ws.rs.core.HttpHeaders headers,
                                                                         @Context
                                                                         javax.ws.rs.core.UriInfo uriInfo)

getAlertsForResource

@AddLinks
List<Link> getAlertsForResource(int resourceId)

createPlatform

javax.ws.rs.core.Response createPlatform(String name,
                                         StringValue type,
                                         @Context
                                         javax.ws.rs.core.UriInfo uriInfo)

createResource

javax.ws.rs.core.Response createResource(String name,
                                         StringValue type,
                                         String plugin,
                                         int parentId,
                                         @Context
                                         javax.ws.rs.core.UriInfo uriInfo)