org.onosproject.vtnweb.resources

Class PortPairWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.vtnweb.resources.PortPairWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="port_pairs")
public class PortPairWebResource
extends org.onosproject.rest.AbstractWebResource

Query and program port pair.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PORT_PAIR_ID_EXIST
static String	PORT_PAIR_ID_NOT_EXIST
static String	PORT_PAIR_NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
PortPairWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createPortPair(InputStream stream) Creates a new port pair.
javax.ws.rs.core.Response	deletePortPair(String id) Delete details of a specified port pair id.
javax.ws.rs.core.Response	getPortPair(String id) Get details of a specified port pair id.
javax.ws.rs.core.Response	getPortPairs() Get details of all port pairs created.
javax.ws.rs.core.Response	updatePortPair(String id, InputStream stream) Update details of a specified port pair 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_PAIR_NOT_FOUND

public static final String PORT_PAIR_NOT_FOUND

See Also:

Constant Field Values

PORT_PAIR_ID_EXIST

public static final String PORT_PAIR_ID_EXIST

See Also:

Constant Field Values

PORT_PAIR_ID_NOT_EXIST

public static final String PORT_PAIR_ID_NOT_EXIST

See Also:

Constant Field Values

Constructor Detail

PortPairWebResource

public PortPairWebResource()

Method Detail

getPortPairs

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

Get details of all port pairs created.

Returns:

200 OK

getPortPair

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

Get details of a specified port pair id.

Parameters:

id - port pair id

Returns:

200 OK, 404 if given identifier does not exist

createPortPair

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

Creates a new port pair.

Parameters:

stream - port pair from JSON

Returns:

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

updatePortPair

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

Update details of a specified port pair id.

Parameters:

id - port pair id

stream - port pair from json

Returns:

200 OK, 404 if the given identifier does not exist

deletePortPair

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

Delete details of a specified port pair id.

Parameters:

id - port pair id

Returns:

204 NO CONTENT