Package org.opennms.web.rest.v1

Class ResourceRestService

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.ResourceRestService

@Component("resourceRestService")
@Path("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	Description
ResourceRestService()

Method Summary

Modifier and Type	Method	Description
void	deleteResourceById(String resourceId)
ResourceDTO	getResourceById(String resourceId, int depth)
ResourceDTO	getResourceForNode(String nodeCriteria, int depth)
ResourceDTOCollection	getResources(int depth)
javax.ws.rs.core.Response	saveResourcesWithId(String[] resources)
List<ResourceDTO>	select(String nodes, String filterRules, String nodeSubresources, String stringProperties)	Selects nodes and parts of there resource information.

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({"application/xml","application/json","application/atom+xml"})
@Transactional(readOnly=true)
public ResourceDTOCollection getResources(@DefaultValue("1") @QueryParam("depth")
                                          int depth)

getResourceById

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

deleteResourceById

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

getResourceForNode

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

select

@GET
@Path("select")
@Produces({"application/xml","application/json","application/atom+xml"})
@Transactional(readOnly=true)
public List<ResourceDTO> select(@DefaultValue("") @QueryParam("nodes")
                                String nodes,
                                @DefaultValue("") @QueryParam("filterRules")
                                String filterRules,
                                @DefaultValue("") @QueryParam("nodeSubresources")
                                String nodeSubresources,
                                @DefaultValue("") @QueryParam("stringProperties")
                                String stringProperties)

Selects nodes and parts of there resource information.

• If no nodeSubresources criteria is given then all subresources are returned but their nested content is not included.
• If no stringProperties criteria is given then all string properties are included.

Parameters:

nodes - Comma separated list of node ids; both, database ids and foreign ids are supported

filterRules - Comma separated list of rule names for selecting nodes

nodeSubresources - Comma separated list of subresource names (the part after the dot)

stringProperties - Comma separated list of property names

Returns:

saveResourcesWithId

@POST
@Path("generateId")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response saveResourcesWithId(String[] resources)