org.onosproject.rest.resources

Class IntentsWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.IntentsWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="intents")
public class IntentsWebResource
extends org.onosproject.rest.AbstractWebResource

Query, submit and withdraw network intents.

Constructor Summary

Constructors

Constructor and Description
IntentsWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createIntent(InputStream stream) Submits a new intent.
javax.ws.rs.core.Response	deleteIntentById(String appId, String key) Withdraws intent.
javax.ws.rs.core.Response	getIntentById(String appId, String key) Gets intent by application and key.
javax.ws.rs.core.Response	getIntentFlowsById(String appId, String key) Gets all related flow entries created by a particular intent.
javax.ws.rs.core.Response	getIntents() Gets all intents.
javax.ws.rs.core.Response	getIntentSummary() Gets Summary of all intents.
javax.ws.rs.core.Response	getIntentWithInstallable(String appId, String key) Gets intent installables by application ID and key.

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

IntentsWebResource

public IntentsWebResource()

Method Detail

getIntents

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

Gets all intents. Returns array containing all the intents in the system.

Returns:

200 OK with array of all the intents in the system

onos model

Intents

getIntentSummary

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

Gets Summary of all intents. Returns Summary of the intents in the system.

Returns:

200 OK with Summary of all the intents in the system

onos model

Minisummary

getIntentWithInstallable

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

Gets intent installables by application ID and key.

Parameters:

appId - application identifier

key - intent key

Returns:

200 OK with array of the intent installables

onos model

Intents

getIntentById

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

Gets intent by application and key. Returns details of the specified intent.

Parameters:

appId - application identifier

key - intent key

Returns:

200 OK with intent data

onos model

Intents

getIntentFlowsById

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

Gets all related flow entries created by a particular intent. Returns all flow entries of the specified intent.

Parameters:

appId - application identifier

key - intent key

Returns:

200 OK with intent data

onos model

Relatedflows

createIntent

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

Submits a new intent. Creates and submits intent from the JSON request.

Parameters:

stream - input JSON

Returns:

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

onos model

IntentHost

deleteIntentById

@DELETE
 @Path(value="{appId}/{key}")
public javax.ws.rs.core.Response deleteIntentById(@PathParam(value="appId")
                                                                                        String appId,
                                                                                        @PathParam(value="key")
                                                                                        String key)

Withdraws intent. Withdraws the specified intent from the system.

Parameters:

appId - application identifier

key - intent key

Returns:

204 NO CONTENT