org.onosproject.rest.resources

Class VirtualNetworkWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.VirtualNetworkWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="vnets")
public class VirtualNetworkWebResource
extends org.onosproject.rest.AbstractWebResource

Query and Manage Virtual Network elements.

Constructor Summary

Constructors

Constructor and Description
VirtualNetworkWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createVirtualDevice(long networkId, InputStream stream) Creates a virtual device from the JSON input stream.
javax.ws.rs.core.Response	createVirtualHost(long networkId, InputStream stream) Creates a virtual network host from the JSON input stream.
javax.ws.rs.core.Response	createVirtualLink(long networkId, InputStream stream) Creates a virtual network link from the JSON input stream.
javax.ws.rs.core.Response	createVirtualNetwork(InputStream stream) Creates a virtual network from the JSON input stream.
javax.ws.rs.core.Response	createVirtualPort(long networkId, String virtDeviceId, InputStream stream) Creates a virtual network port in a virtual device in a virtual network.
javax.ws.rs.core.Response	getVirtualDevices(long networkId) Returns all virtual network devices in a virtual network.
javax.ws.rs.core.Response	getVirtualHosts(long networkId) Returns all virtual network hosts in a virtual network.
javax.ws.rs.core.Response	getVirtualLinks(long networkId) Returns all virtual network links in a virtual network.
javax.ws.rs.core.Response	getVirtualNetworkById(String tenantId) Returns the virtual networks with the specified tenant identifier.
javax.ws.rs.core.Response	getVirtualNetworks() Returns all virtual networks.
javax.ws.rs.core.Response	getVirtualPorts(long networkId, String deviceId) Returns all virtual network ports in a virtual device in a virtual network.
javax.ws.rs.core.Response	removeVirtualDevice(long networkId, String deviceId) Removes the virtual network device from the virtual network.
javax.ws.rs.core.Response	removeVirtualHost(long networkId, InputStream stream) Removes the virtual network host from the JSON input stream.
javax.ws.rs.core.Response	removeVirtualLink(long networkId, InputStream stream) Removes the virtual network link from the JSON input stream.
javax.ws.rs.core.Response	removeVirtualNetwork(long networkId) Removes the virtual network with the specified network identifier.
javax.ws.rs.core.Response	removeVirtualPort(long networkId, String deviceId, long portNum) Removes the virtual network port from the virtual device in a virtual network.

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

VirtualNetworkWebResource

public VirtualNetworkWebResource()

Method Detail

getVirtualNetworks

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

Returns all virtual networks.

Returns:

200 OK with set of virtual networks

onos model

VirtualNetworks

getVirtualNetworkById

@GET
 @Produces(value="application/json")
 @Path(value="{tenantId}")
public javax.ws.rs.core.Response getVirtualNetworkById(@PathParam(value="tenantId")
                                                                                                                            String tenantId)

Returns the virtual networks with the specified tenant identifier.

Parameters:

tenantId - tenant identifier

Returns:

200 OK with a virtual network, 404 not found

onos model

VirtualNetworks

createVirtualNetwork

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

Creates a virtual network from the JSON input stream.

Parameters:

stream - tenant identifier JSON stream

Returns:

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

onos model

TenantId

removeVirtualNetwork

@DELETE
 @Path(value="{networkId}")
public javax.ws.rs.core.Response removeVirtualNetwork(@PathParam(value="networkId")
                                                                                          long networkId)

Removes the virtual network with the specified network identifier.

Parameters:

networkId - network identifier

Returns:

204 NO CONTENT

getVirtualDevices

@GET
 @Produces(value="application/json")
 @Path(value="{networkId}/devices")
public javax.ws.rs.core.Response getVirtualDevices(@PathParam(value="networkId")
                                                                                                                                 long networkId)

Returns all virtual network devices in a virtual network.

Parameters:

networkId - network identifier

Returns:

200 OK with set of virtual devices, 404 not found

onos model

VirtualDevices

createVirtualDevice

@POST
 @Path(value="{networkId}/devices")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createVirtualDevice(@PathParam(value="networkId")
                                                                                                                                                                         long networkId,
                                                                                                                                                                         InputStream stream)

Creates a virtual device from the JSON input stream.

Parameters:

networkId - network identifier

stream - virtual device JSON stream

Returns:

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

onos model

VirtualDevice

removeVirtualDevice

@DELETE
 @Path(value="{networkId}/devices/{deviceId}")
public javax.ws.rs.core.Response removeVirtualDevice(@PathParam(value="networkId")
                                                                                                            long networkId,
                                                                                                            @PathParam(value="deviceId")
                                                                                                            String deviceId)

Removes the virtual network device from the virtual network.

Parameters:

networkId - network identifier

deviceId - device identifier

Returns:

204 NO CONTENT

getVirtualPorts

@GET
 @Produces(value="application/json")
 @Path(value="{networkId}/devices/{deviceId}/ports")
public javax.ws.rs.core.Response getVirtualPorts(@PathParam(value="networkId")
                                                                                                                                                long networkId,
                                                                                                                                                @PathParam(value="deviceId")
                                                                                                                                                String deviceId)

Returns all virtual network ports in a virtual device in a virtual network.

Parameters:

networkId - network identifier

deviceId - virtual device identifier

Returns:

200 OK with set of virtual ports, 404 not found

onos model

VirtualPorts

createVirtualPort

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="{networkId}/devices/{deviceId}/ports")
public javax.ws.rs.core.Response createVirtualPort(@PathParam(value="networkId")
                                                                                                                                                                                        long networkId,
                                                                                                                                                                                        @PathParam(value="deviceId")
                                                                                                                                                                                        String virtDeviceId,
                                                                                                                                                                                        InputStream stream)

Creates a virtual network port in a virtual device in a virtual network.

Parameters:

networkId - network identifier

virtDeviceId - virtual device identifier

stream - virtual port JSON stream

Returns:

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

onos model

VirtualPort

removeVirtualPort

@DELETE
 @Path(value="{networkId}/devices/{deviceId}/ports/{portNum}")
public javax.ws.rs.core.Response removeVirtualPort(@PathParam(value="networkId")
                                                                                                                          long networkId,
                                                                                                                          @PathParam(value="deviceId")
                                                                                                                          String deviceId,
                                                                                                                          @PathParam(value="portNum")
                                                                                                                          long portNum)

Removes the virtual network port from the virtual device in a virtual network.

Parameters:

networkId - network identifier

deviceId - virtual device identifier

portNum - virtual port number

Returns:

204 NO CONTENT

getVirtualLinks

@GET
 @Produces(value="application/json")
 @Path(value="{networkId}/links")
public javax.ws.rs.core.Response getVirtualLinks(@PathParam(value="networkId")
                                                                                                                             long networkId)

Returns all virtual network links in a virtual network.

Parameters:

networkId - network identifier

Returns:

200 OK with set of virtual network links

onos model

VirtualLinks

createVirtualLink

@POST
 @Path(value="{networkId}/links")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createVirtualLink(@PathParam(value="networkId")
                                                                                                                                                                     long networkId,
                                                                                                                                                                     InputStream stream)

Creates a virtual network link from the JSON input stream.

Parameters:

networkId - network identifier

stream - virtual link JSON stream

Returns:

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

onos model

VirtualLink

removeVirtualLink

@DELETE
 @Path(value="{networkId}/links")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response removeVirtualLink(@PathParam(value="networkId")
                                                                                                                                  long networkId,
                                                                                                                                  InputStream stream)

Removes the virtual network link from the JSON input stream.

Parameters:

networkId - network identifier

stream - virtual link JSON stream

Returns:

204 NO CONTENT

onos model

VirtualLink

getVirtualHosts

@GET
 @Produces(value="application/json")
 @Path(value="{networkId}/hosts")
public javax.ws.rs.core.Response getVirtualHosts(@PathParam(value="networkId")
                                                                                                                             long networkId)

Returns all virtual network hosts in a virtual network.

Parameters:

networkId - network identifier

Returns:

200 OK with set of virtual network hosts

onos model

VirtualHosts

createVirtualHost

@POST
 @Path(value="{networkId}/hosts")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createVirtualHost(@PathParam(value="networkId")
                                                                                                                                                                     long networkId,
                                                                                                                                                                     InputStream stream)

Creates a virtual network host from the JSON input stream.

Parameters:

networkId - network identifier

stream - virtual host JSON stream

Returns:

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

onos model

VirtualHostPut

removeVirtualHost

@DELETE
 @Path(value="{networkId}/hosts")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response removeVirtualHost(@PathParam(value="networkId")
                                                                                                                                  long networkId,
                                                                                                                                  InputStream stream)

Removes the virtual network host from the JSON input stream.

Parameters:

networkId - network identifier

stream - virtual host JSON stream

Returns:

204 NO CONTENT

onos model

VirtualHost