org.onosproject.rest.resources

Class FlowsWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.FlowsWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="flows")
public class FlowsWebResource
extends org.onosproject.rest.AbstractWebResource

Query and program flow rules.

Constructor Summary

Constructors

Constructor and Description
FlowsWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createFlow(String deviceId, String appId, InputStream stream) Creates new flow rule.
javax.ws.rs.core.Response	createFlows(String appId, InputStream stream) Creates new flow rules.
javax.ws.rs.core.Response	deleteFlowByDeviceIdAndFlowId(String deviceId, long flowId) Removes flow rule.
javax.ws.rs.core.Response	deleteFlows(InputStream stream) Removes a batch of flow rules.
javax.ws.rs.core.Response	getFlowByAppId(String appId) Gets flow rules generated by an application.
javax.ws.rs.core.Response	getFlowByDeviceId(String deviceId) Gets flow entries of a device.
javax.ws.rs.core.Response	getFlowByDeviceIdAndFlowId(String deviceId, long flowId) Gets flow rules.
javax.ws.rs.core.Response	getFlows() Gets all flow entries.
javax.ws.rs.core.Response	getPendingFlows() Gets all pending flow entries.
javax.ws.rs.core.Response	getTableFlows(int tableId) Gets all flow entries for a table.
javax.ws.rs.core.Response	removeFlowByAppId(String appId) Removes flow rules by application 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

FlowsWebResource

public FlowsWebResource()

Method Detail

getFlows

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

Gets all flow entries. Returns array of all flow rules in the system.

Returns:

200 OK with a collection of flows

onos model

FlowEntries

getPendingFlows

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

Gets all pending flow entries. Returns array of all pending flow rules in the system.

Returns:

200 OK with a collection of flows

onos model

FlowEntries

getTableFlows

@GET
 @Produces(value="application/json")
 @Path(value="table/{tableId}")
public javax.ws.rs.core.Response getTableFlows(@PathParam(value="tableId")
                                                                                                                         int tableId)

Gets all flow entries for a table. Returns array of all flow rules for a table.

Parameters:

tableId - table identifier

Returns:

200 OK with a collection of flows

onos model

FlowEntries

createFlows

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createFlows(@QueryParam(value="appId")
                                                                                                                             String appId,
                                                                                                                             InputStream stream)

Creates new flow rules. Creates and installs a new flow rules.
Flow rule criteria and instruction description: https://wiki.onosproject.org/display/ONOS/Flow+Rules

Parameters:

appId - application id

stream - flow rules JSON

Returns:

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

onos model

FlowsBatchPost

getFlowByDeviceId

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

Gets flow entries of a device. Returns array of all flow rules for the specified device.

Parameters:

deviceId - device identifier

Returns:

200 OK with a collection of flows of given device

onos model

FlowEntries

getFlowByDeviceIdAndFlowId

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

Gets flow rules. Returns the flow entry specified by the device id and flow rule id.

Parameters:

deviceId - device identifier

flowId - flow rule identifier

Returns:

200 OK with a collection of flows of given device and flow

onos model

FlowEntries

getFlowByAppId

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

Gets flow rules generated by an application. Returns the flow rule specified by the application id.

Parameters:

appId - application identifier

Returns:

200 OK with a collection of flows of given application id

onos model

FlowRules

removeFlowByAppId

@DELETE
 @Produces(value="application/json")
 @Path(value="application/{appId}")
public javax.ws.rs.core.Response removeFlowByAppId(@PathParam(value="appId")
                                                                                                                                    String appId)

Removes flow rules by application ID. Removes a collection of flow rules generated by the given application.

Parameters:

appId - application identifier

Returns:

204 NO CONTENT

createFlow

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

Creates new flow rule. Creates and installs a new flow rule for the specified device.
Flow rule criteria and instruction description: https://wiki.onosproject.org/display/ONOS/Flow+Rules

Parameters:

deviceId - device identifier

appId - application identifier

stream - flow rule JSON

Returns:

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

onos model

FlowsPost

deleteFlowByDeviceIdAndFlowId

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

Removes flow rule. Removes the specified flow rule.

Parameters:

deviceId - device identifier

flowId - flow rule identifier

Returns:

204 NO CONTENT

deleteFlows

@DELETE
public javax.ws.rs.core.Response deleteFlows(InputStream stream)

Removes a batch of flow rules.

Parameters:

stream - stream for posted JSON

Returns:

204 NO CONTENT