org.opennms.web.rest.v1

Class ResourceRestService

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.ResourceRestService

@Component(value="resourceRestService")
 @Path(value="resources")
public class ResourceRestService
extends OnmsRestService

Read-only API for retrieving resources.

Author:

jwhite

Nested Class Summary

Nested classes/interfaces inherited from class org.opennms.web.rest.v1.OnmsRestService

OnmsRestService.ComparisonOperation

Field Summary

Fields inherited from class org.opennms.web.rest.v1.OnmsRestService

DEFAULT_LIMIT

Constructor Summary

Constructors

Constructor and Description
ResourceRestService()

Method Summary

Modifier and Type	Method and Description
void	deleteResourceById(String resourceId)
ResourceDTO	getResourceById(String resourceId, int depth)
ResourceDTO	getResourceForNode(String nodeCriteria, int depth)
ResourceDTOCollection	getResources(int depth)

Methods inherited from class org.opennms.web.rest.v1.OnmsRestService

applyQueryFilters, applyQueryFilters, getBadRequestResponse, getBeanWrapperForClass, getException, getException, getNumericValue, getRedirectUri, readLock, readUnlock, removeParameter, removeParameter, setProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceRestService

public ResourceRestService()

Method Detail

getResources

@GET
 @Produces(value={"application/xml","application/json","application/atom+xml"})
 @Transactional(readOnly=true)
public ResourceDTOCollection getResources(@DefaultValue(value="1") @QueryParam(value="depth")
                                                                                                                                                              int depth)

getResourceById

@GET
 @Path(value="{resourceId}")
 @Produces(value={"application/xml","application/json","application/atom+xml"})
 @Transactional(readOnly=true)
public ResourceDTO getResourceById(@PathParam(value="resourceId")
                                                                                                                                                                                    String resourceId,
                                                                                                                                                                                    @DefaultValue(value="-1") @QueryParam(value="depth")
                                                                                                                                                                                    int depth)

deleteResourceById

@DELETE
 @Path(value="{resourceId}")
 @Transactional(readOnly=false)
public void deleteResourceById(@PathParam(value="resourceId")
                                                                                                    String resourceId)

getResourceForNode

@GET
 @Path(value="fornode/{nodeCriteria}")
 @Produces(value={"application/xml","application/json","application/atom+xml"})
 @Transactional(readOnly=true)
public ResourceDTO getResourceForNode(@PathParam(value="nodeCriteria")
                                                                                                                                                                                                 String nodeCriteria,
                                                                                                                                                                                                 @DefaultValue(value="-1") @QueryParam(value="depth")
                                                                                                                                                                                                 int depth)