org.onosproject.rest.resources

Class GroupsWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.GroupsWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="groups")
public class GroupsWebResource
extends org.onosproject.rest.AbstractWebResource

Query and program group rules.

Constructor Summary

Constructors

Constructor and Description
GroupsWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addBucket(String deviceIdString, String appCookieString, InputStream stream) Adds buckets to an existing group.
javax.ws.rs.core.Response	createGroup(String deviceId, InputStream stream) Create new group rule.
javax.ws.rs.core.Response	deleteBuckets(String deviceIdString, String appCookieString, String bucketIds) Removes buckets from an existing group.
javax.ws.rs.core.Response	deleteGroupByDeviceIdAndAppCookie(String deviceId, String appCookie) Removes the specified group.
javax.ws.rs.core.Response	getGroupByDeviceIdAndAppCookie(String deviceId, String appCookie) Returns a group with the given deviceId and appCookie.
javax.ws.rs.core.Response	getGroups() Returns all groups of all devices.
javax.ws.rs.core.Response	getGroupsByDeviceId(String deviceId) Returns all groups associated with the given device.

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

GroupsWebResource

public GroupsWebResource()

Method Detail

getGroups

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

Returns all groups of all devices.

Returns:

200 OK with array of all the groups in the system

onos model

Groups

getGroupsByDeviceId

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

Returns all groups associated with the given device.

Parameters:

deviceId - device identifier

Returns:

200 OK with array of all the groups in the system

onos model

Groups

getGroupByDeviceIdAndAppCookie

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

Returns a group with the given deviceId and appCookie.

Parameters:

deviceId - device identifier

appCookie - group key

Returns:

200 OK with a group entry in the system

onos model

Group

createGroup

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

Create new group rule. Creates and installs a new group rule for the specified device.

Parameters:

deviceId - device identifier

stream - group rule JSON

Returns:

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

onos model

GroupsPost

deleteGroupByDeviceIdAndAppCookie

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

Removes the specified group.

Parameters:

deviceId - device identifier

appCookie - application cookie to be used for lookup

Returns:

204 NO CONTENT

addBucket

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

Adds buckets to an existing group.

Parameters:

deviceIdString - device identifier

appCookieString - application cookie

stream - buckets JSON

Returns:

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

onos model

GroupsBucketsPost

deleteBuckets

@DELETE
 @Path(value="{deviceId}/{appCookie}/buckets/{bucketIds}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response deleteBuckets(@PathParam(value="deviceId")
                                                                                                                                                                                            String deviceIdString,
                                                                                                                                                                                            @PathParam(value="appCookie")
                                                                                                                                                                                            String appCookieString,
                                                                                                                                                                                            @PathParam(value="bucketIds")
                                                                                                                                                                                            String bucketIds)

Removes buckets from an existing group.

Parameters:

deviceIdString - device identifier

appCookieString - application cookie

bucketIds - comma separated list of identifiers of buckets to remove from this group

Returns:

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