Package org.onosproject.vpls.rest

Class VplsWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.vpls.rest.VplsWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path("vpls")
public class VplsWebResource
extends org.onosproject.rest.AbstractWebResource

Query and program Vplss.

Constructor Summary

Constructors

Constructor	Description
VplsWebResource()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addInterfaces(String vplsName, InputStream stream)	Add new interfaces.
javax.ws.rs.core.Response	createVpls(InputStream stream)	Creates new vpls.
javax.ws.rs.core.Response	deleteInterface(String vplsName, String interfaceName)	Removes a specified interface.
javax.ws.rs.core.Response	deleteVpls(String vplsName)	Removes the specified vpls.
javax.ws.rs.core.Response	getVpls(String vplsName)	Gets Vpls.
javax.ws.rs.core.Response	getVplss()	Gets all Vplss.

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

VplsWebResource

public VplsWebResource()

Method Detail

getVplss

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

Gets all Vplss. Returns array of all Vplss in the system.

Returns:

200 OK with a collection of Vplss

onos model

Vplss

getVpls

@GET
@Produces("application/json")
@Path("{vplsName}")
public javax.ws.rs.core.Response getVpls(@PathParam("vplsName")
                                         String vplsName)

Gets Vpls. Returns a Vpls by vplsName.

Parameters:

vplsName - vpls name

Returns:

200 OK with a vpls, return 404 if no entry has been found

onos model

Vpls

createVpls

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

Creates new vpls. Creates and installs a new Vplps.

Parameters:

stream - Vpls JSON

Returns:

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

onos model

VplsPost

addInterfaces

@POST
@Path("interfaces/{vplsName}")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response addInterfaces(@PathParam("vplsName")
                                               String vplsName,
                                               InputStream stream)

Add new interfaces. Add new interfaces to a Vpls.

Parameters:

stream - interfaces JSON

vplsName - Vpls name

Returns:

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

onos model

InterfacesPost

deleteVpls

@DELETE
@Path("{vplsName}")
public javax.ws.rs.core.Response deleteVpls(@PathParam("vplsName")
                                            String vplsName)

Removes the specified vpls.

Parameters:

vplsName - Vpls name

Returns:

204 NO CONTENT

deleteInterface

@DELETE
@Path("interface/{vplsName}/{interfaceName}")
public javax.ws.rs.core.Response deleteInterface(@PathParam("vplsName")
                                                 String vplsName,
                                                 @PathParam("interfaceName")
                                                 String interfaceName)

Removes a specified interface.

Parameters:

vplsName - Vpls name

interfaceName - interface name

Returns:

204 NO CONTENT