org.onosproject.rest.resources

Class FlowObjectiveWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.FlowObjectiveWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="flowobjectives")
public class FlowObjectiveWebResource
extends org.onosproject.rest.AbstractWebResource

Manage flow objectives.

Constructor Summary

Constructors

Constructor and Description
FlowObjectiveWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createFilteringObjective(String appId, String deviceId, InputStream stream) Creates and installs a new filtering objective for the specified device.
javax.ws.rs.core.Response	createForwardingObjective(String appId, String deviceId, InputStream stream) Creates and installs a new forwarding objective for the specified device.
javax.ws.rs.core.Response	createNextObjective(String appId, String deviceId, InputStream stream) Creates and installs a new next objective for the specified device.
javax.ws.rs.core.Response	getNextId() Returns the globally unique nextId.
javax.ws.rs.core.Response	initPolicy(InputStream stream) Installs the filtering rules onto the specified 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

FlowObjectiveWebResource

public FlowObjectiveWebResource()

Method Detail

createFilteringObjective

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

Creates and installs a new filtering objective for the specified device.

Parameters:

appId - application identifier

deviceId - device identifier

stream - filtering objective JSON

Returns:

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

onos model

FilteringObjective

createForwardingObjective

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

Creates and installs a new forwarding objective for the specified device.

Parameters:

appId - application identifier

deviceId - device identifier

stream - forwarding objective JSON

Returns:

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

onos model

ForwardingObjective

createNextObjective

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

Creates and installs a new next objective for the specified device.

Parameters:

appId - application identifier

deviceId - device identifier

stream - next objective JSON

Returns:

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

onos model

NextObjective

getNextId

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

Returns the globally unique nextId.

Returns:

200 OK with next identifier

onos model

NextId

initPolicy

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

Installs the filtering rules onto the specified device.

Parameters:

stream - filtering rule JSON

Returns:

200 OK

onos model

ObjectivePolicy