org.onosproject.rest.resources

Class MetersWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.MetersWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="meters")
public class MetersWebResource
extends org.onosproject.rest.AbstractWebResource

Query and program meter rules.

Constructor Summary

Constructors

Constructor and Description
MetersWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createMeter(String deviceId, InputStream stream) Creates new meter rule.
javax.ws.rs.core.Response	deleteMeterByDeviceIdAndMeterId(String deviceId, String meterId) Removes the specified meter.
javax.ws.rs.core.Response	getMeterByDeviceIdAndMeterId(String deviceId, String meterId) Returns a meter by the meter id.
javax.ws.rs.core.Response	getMeters() Returns all meters of all devices.
javax.ws.rs.core.Response	getMetersByDeviceId(String deviceId) Returns a collection of meters by the device id.

Methods inherited from class org.onosproject.rest.AbstractWebResource

codec, encodeArray, getService, mapper, newArray, newObject

Methods inherited from class org.onlab.rest.BaseResource

get, ok

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.codec.CodecContext

decode, encode

Constructor Detail

MetersWebResource

public MetersWebResource()

Method Detail

getMeters

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getMeters()

Returns all meters of all devices.

Returns:

200 OK with array of all the meters in the system

onos model

Meters

getMetersByDeviceId

@GET
 @Produces(value="application/json")
 @Path(value="{deviceId}")
public javax.ws.rs.core.Response getMetersByDeviceId(@PathParam(value="deviceId")
                                                                                                                          String deviceId)

Returns a collection of meters by the device id.

Parameters:

deviceId - device identifier

Returns:

200 OK with array of meters which belongs to specified device

onos model

Meters

getMeterByDeviceIdAndMeterId

@GET
 @Produces(value="application/json")
 @Path(value="{deviceId}/{meterId}")
public javax.ws.rs.core.Response getMeterByDeviceIdAndMeterId(@PathParam(value="deviceId")
                                                                                                                                             String deviceId,
                                                                                                                                             @PathParam(value="meterId")
                                                                                                                                             String meterId)

Returns a meter by the meter id.

Parameters:

deviceId - device identifier

meterId - meter identifier

Returns:

200 OK with a meter, return 404 if no entry has been found

onos model

Meter

createMeter

@POST
 @Path(value="{deviceId}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createMeter(@PathParam(value="deviceId")
                                                                                                                                                        String deviceId,
                                                                                                                                                        InputStream stream)

Creates new meter rule. Creates and installs a new meter rule for the specified device.

Parameters:

deviceId - device identifier

stream - meter rule JSON

Returns:

status of the request - CREATED if the JSON is correct, BAD_REQUEST if the JSON is invalid

onos model

MeterPost

deleteMeterByDeviceIdAndMeterId

@DELETE
 @Path(value="{deviceId}/{meterId}")
public javax.ws.rs.core.Response deleteMeterByDeviceIdAndMeterId(@PathParam(value="deviceId")
                                                                                                              String deviceId,
                                                                                                              @PathParam(value="meterId")
                                                                                                              String meterId)

Removes the specified meter.

Parameters:

deviceId - device identifier

meterId - meter identifier

Returns:

204 NO CONTENT