Package org.opennms.web.rest.v1

Class GraphRestService

java.lang.Object

org.opennms.web.rest.v1.OnmsRestService

org.opennms.web.rest.v1.GraphRestService

@Component("graphRestService")
@Path("graphs")
public class GraphRestService
extends OnmsRestService

Read-only API for retrieving graph definitions and determining the list of supported graphs on a particular resource.

Author:

jwhite

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GraphRestService.GraphResourceDTO
static class	GraphRestService.ResourceVisitor

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
GraphRestService()

Method Summary

Modifier and Type	Method	Description
PrefabGraph	getGraphByName(String graphName)
GraphNameCollection	getGraphNames()
GraphNameCollection	getGraphNamesForResource(String resourceId)
GraphRestService.GraphResourceDTO	getGraphResourcesForNode(String nodeCriteria, 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

GraphRestService

public GraphRestService()

Method Detail

getGraphNames

@GET
@Produces({"application/xml","application/json","application/atom+xml"})
@Transactional(readOnly=true)
public GraphNameCollection getGraphNames()

getGraphByName

@GET
@Path("{graphName}")
@Produces({"application/xml","application/json","application/atom+xml"})
@Transactional(readOnly=true)
public PrefabGraph getGraphByName(@PathParam("graphName")
                                  String graphName)

getGraphNamesForResource

@GET
@Path("for/{resourceId}")
@Produces({"application/xml","application/json","application/atom+xml"})
@Transactional(readOnly=true)
public GraphNameCollection getGraphNamesForResource(@PathParam("resourceId")
                                                    String resourceId)

getGraphResourcesForNode

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