org.onosproject.vtnweb.resources

Class PortPairGroupWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.vtnweb.resources.PortPairGroupWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="port_pair_groups")
public class PortPairGroupWebResource
extends org.onosproject.rest.AbstractWebResource

Query and program port pair group.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PORT_PAIR_GROUP_ID_EXIST
static String	PORT_PAIR_GROUP_ID_NOT_EXIST
static String	PORT_PAIR_GROUP_NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
PortPairGroupWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createPortPairGroup(InputStream stream) Creates a new port pair group.
javax.ws.rs.core.Response	deletePortPairGroup(String id) Delete details of a specified port pair group id.
javax.ws.rs.core.Response	getPortPairGroup(String id) Get details of a specified port pair group id.
javax.ws.rs.core.Response	getPortPairGroups() Get details of all port pair groups created.
javax.ws.rs.core.Response	updatePortPairGroup(String id, InputStream stream) Update details of a specified port pair group 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_GROUP_NOT_FOUND

public static final String PORT_PAIR_GROUP_NOT_FOUND

See Also:

Constant Field Values

PORT_PAIR_GROUP_ID_EXIST

public static final String PORT_PAIR_GROUP_ID_EXIST

See Also:

Constant Field Values

PORT_PAIR_GROUP_ID_NOT_EXIST

public static final String PORT_PAIR_GROUP_ID_NOT_EXIST

See Also:

Constant Field Values

Constructor Detail

PortPairGroupWebResource

public PortPairGroupWebResource()

Method Detail

getPortPairGroups

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

Get details of all port pair groups created.

Returns:

200 OK

getPortPairGroup

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

Get details of a specified port pair group id.

Parameters:

id - port pair group id

Returns:

200 OK, 404 if given identifier does not exist

createPortPairGroup

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

Creates a new port pair group.

Parameters:

stream - port pair group from JSON

Returns:

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

updatePortPairGroup

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

Update details of a specified port pair group id.

Parameters:

id - port pair group id

stream - port pair group from json

Returns:

200 OK, 404 if given identifier does not exist

deletePortPairGroup

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

Delete details of a specified port pair group id.

Parameters:

id - port pair group id

Returns:

204 NO CONTENT