org.onosproject.rest.resources

Class RegionsWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.RegionsWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="regions")
public class RegionsWebResource
extends org.onosproject.rest.AbstractWebResource

Manages region and device membership.

Constructor Summary

Constructors

Constructor and Description
RegionsWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addDevices(String regionId, InputStream stream) Adds the specified collection of devices to the region.
javax.ws.rs.core.Response	createRegion(InputStream stream) Creates a new region using the supplied JSON input stream.
javax.ws.rs.core.Response	getRegionById(String regionId) Returns the region with the specified identifier.
javax.ws.rs.core.Response	getRegionDevices(String regionId) Returns the set of devices that belong to the specified region.
javax.ws.rs.core.Response	getRegions() Returns set of all regions.
javax.ws.rs.core.Response	removeDevices(String regionId, InputStream stream) Removes the specified collection of devices from the region.
javax.ws.rs.core.Response	removeRegion(String regionId) Removes the specified region using the given region identifier.
javax.ws.rs.core.Response	updateRegion(String regionId, InputStream stream) Updates the specified region using the supplied JSON input stream.

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

RegionsWebResource

public RegionsWebResource()

Method Detail

getRegions

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

Returns set of all regions.

Returns:

200 OK with set of all regions

onos model

Regions

getRegionById

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

Returns the region with the specified identifier.

Parameters:

regionId - region identifier

Returns:

200 OK with a region, 404 not found

onos model

Region

getRegionDevices

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

Returns the set of devices that belong to the specified region.

Parameters:

regionId - region identifier

Returns:

200 OK with set of devices that belong to the specified region

onos model

RegionDeviceIds

createRegion

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createRegion(InputStream stream)

Creates a new region using the supplied JSON input stream.

Parameters:

stream - region JSON stream

Returns:

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

onos model

RegionPost

updateRegion

@PUT
 @Path(value="{regionId}")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response updateRegion(@PathParam(value="regionId")
                                                                                                                   String regionId,
                                                                                                                   InputStream stream)

Updates the specified region using the supplied JSON input stream.

Parameters:

regionId - region identifier

stream - region JSON stream

Returns:

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

onos model

RegionPost

removeRegion

@DELETE
 @Path(value="{regionId}")
public javax.ws.rs.core.Response removeRegion(@PathParam(value="regionId")
                                                                                 String regionId)

Removes the specified region using the given region identifier.

Parameters:

regionId - region identifier

Returns:

204 NO CONTENT

addDevices

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

Adds the specified collection of devices to the region.

Parameters:

regionId - region identifier

stream - deviceIds JSON stream

Returns:

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

onos model

RegionDeviceIds

removeDevices

@DELETE
 @Path(value="{regionId}/devices")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response removeDevices(@PathParam(value="regionId")
                                                                                                                               String regionId,
                                                                                                                               InputStream stream)

Removes the specified collection of devices from the region.

Parameters:

regionId - region identifier

stream - deviceIds JSON stream

Returns:

204 NO CONTENT

onos model

RegionDeviceIds