org.opennms.web.rest.v1

Class MeasurementsRestService

java.lang.Object

org.opennms.web.rest.v1.MeasurementsRestService

@Component
 @Scope(value="prototype")
 @Path(value="measurements")
public class MeasurementsRestService
extends Object

The Measurements API provides read-only access to values persisted by the collectors. Measurements are referenced by combination of resource id and attribute name. Calculations may then be performed on these measurements using JEXL expressions. Units of time, including timestamps are expressed in milliseconds. This API is designed to be similar to the one provided by Newts.

Author:

Jesse White , Dustin Frisch

Constructor Summary

Constructors

Constructor and Description
MeasurementsRestService()

Method Summary

Modifier and Type	Method and Description
protected static javax.ws.rs.WebApplicationException	getException(javax.ws.rs.core.Response.Status status, String msg, Object... params)
protected static javax.ws.rs.WebApplicationException	getException(javax.ws.rs.core.Response.Status status, Throwable t, String msg, Object... params)
List<FilterMetaData>	getFilterMetadata()
FilterMetaData	getFilterMetadata(String name)
QueryResponse	query(QueryRequest request) Retrieves the measurements of many resources and performs arbitrary calculations on these.
QueryResponse	simpleQuery(String resourceId, String attribute, long start, long end, long step, int maxrows, String fallbackAttribute, String aggregation) Retrieves the measurements for a single attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

MeasurementsRestService

public MeasurementsRestService()

Method Detail

getFilterMetadata

@GET
 @Path(value="filters")
 @Produces(value={"application/xml","application/json","application/atom+xml"})
public List<FilterMetaData> getFilterMetadata()

getFilterMetadata

@GET
 @Path(value="filters/{name}")
 @Produces(value={"application/xml","application/json","application/atom+xml"})
public FilterMetaData getFilterMetadata(@PathParam(value="name")
                                                                                                                                                            String name)

simpleQuery

@GET
 @Path(value="{resourceId}/{attribute}")
 @Consumes(value={"application/xml","application/json","application/atom+xml"})
 @Produces(value={"application/xml","application/json","application/atom+xml"})
 @Transactional(readOnly=true)
public QueryResponse simpleQuery(@PathParam(value="resourceId")
                                                                                                                                                                                                                                                                              String resourceId,
                                                                                                                                                                                                                                                                              @PathParam(value="attribute")
                                                                                                                                                                                                                                                                              String attribute,
                                                                                                                                                                                                                                                                              @DefaultValue(value="-14400000") @QueryParam(value="start")
                                                                                                                                                                                                                                                                              long start,
                                                                                                                                                                                                                                                                              @DefaultValue(value="0") @QueryParam(value="end")
                                                                                                                                                                                                                                                                              long end,
                                                                                                                                                                                                                                                                              @DefaultValue(value="300000") @QueryParam(value="step")
                                                                                                                                                                                                                                                                              long step,
                                                                                                                                                                                                                                                                              @DefaultValue(value="0") @QueryParam(value="maxrows")
                                                                                                                                                                                                                                                                              int maxrows,
                                                                                                                                                                                                                                                                              @DefaultValue(value="") @QueryParam(value="fallback-attribute")
                                                                                                                                                                                                                                                                              String fallbackAttribute,
                                                                                                                                                                                                                                                                              @DefaultValue(value="AVERAGE") @QueryParam(value="aggregation")
                                                                                                                                                                                                                                                                              String aggregation)

Retrieves the measurements for a single attribute.

query

@POST
 @Path(value="/")
 @Consumes(value={"application/xml","application/json","application/atom+xml"})
 @Produces(value={"application/xml","application/json","application/atom+xml"})
 @Transactional(readOnly=true)
public QueryResponse query(QueryRequest request)

Retrieves the measurements of many resources and performs arbitrary calculations on these. This a read-only query, however we use a POST instead of GET since the request parameters are difficult to express in a query string.

getException

protected static javax.ws.rs.WebApplicationException getException(javax.ws.rs.core.Response.Status status,
                                                                  String msg,
                                                                  Object... params)
                                                           throws javax.ws.rs.WebApplicationException

Throws:

javax.ws.rs.WebApplicationException

getException

protected static javax.ws.rs.WebApplicationException getException(javax.ws.rs.core.Response.Status status,
                                                                  Throwable t,
                                                                  String msg,
                                                                  Object... params)
                                                           throws javax.ws.rs.WebApplicationException

Throws:

javax.ws.rs.WebApplicationException