org.onosproject.vtnweb.resources

Class PortChainWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.vtnweb.resources.PortChainWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="port_chains")
public class PortChainWebResource
extends org.onosproject.rest.AbstractWebResource

Query and program port chain.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PORT_CHAIN_ID_EXIST
static String	PORT_CHAIN_ID_NOT_EXIST
static String	PORT_CHAIN_NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
PortChainWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createPortChain(InputStream stream) Creates a new port chain.
javax.ws.rs.core.Response	deletePortPain(String id) Delete details of a specified port chain id.
javax.ws.rs.core.Response	getPortChains() Get details of all port chains created.
javax.ws.rs.core.Response	getPortPain(String id) Get details of a specified port chain id.
javax.ws.rs.core.Response	updatePortPain(String id, InputStream stream) Update details of a specified port chain 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, setServiceDirectory

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

Field Detail

PORT_CHAIN_NOT_FOUND

public static final String PORT_CHAIN_NOT_FOUND

See Also:

Constant Field Values

PORT_CHAIN_ID_EXIST

public static final String PORT_CHAIN_ID_EXIST

See Also:

Constant Field Values

PORT_CHAIN_ID_NOT_EXIST

public static final String PORT_CHAIN_ID_NOT_EXIST

See Also:

Constant Field Values

Constructor Detail

PortChainWebResource

public PortChainWebResource()

Method Detail

getPortChains

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

Get details of all port chains created.

Returns:

200 OK

getPortPain

@GET
 @Path(value="{chain_id}")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response getPortPain(@PathParam(value="chain_id")
                                                                                                                                                       String id)

Get details of a specified port chain id.

Parameters:

id - port chain id

Returns:

200 OK, 404 if given identifier does not exist

createPortChain

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

Creates a new port chain.

Parameters:

stream - port chain from JSON

Returns:

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

updatePortPain

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

Update details of a specified port chain id.

Parameters:

id - port chain id

stream - port chain json

Returns:

200 OK, 404 if given identifier does not exist

deletePortPain

@Path(value="{chain_id}")
 @DELETE
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response deletePortPain(@PathParam(value="chain_id")
                                                                                                                                                             String id)

Delete details of a specified port chain id.

Parameters:

id - port chain id

Returns:

204 NO CONTENT