org.onosproject.virtualbng

Class VbngResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.virtualbng.VbngResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="privateip")
public class VbngResource
extends org.onosproject.rest.AbstractWebResource

REST services to interact with the virtual BNG.

Constructor Summary

Constructors

Constructor and Description
VbngResource()

Method Summary

Modifier and Type	Method and Description
String	privateIpAddNotification(String privateIp, String mac, String hostName) Create a new virtual BNG connection.
javax.ws.rs.core.Response	privateIpDeleteNotification() Query virtual BNG map.
javax.ws.rs.core.Response	privateIpDeleteNotification(String privateIp) Delete a virtual BNG connection.

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

Constructor Detail

VbngResource

public VbngResource()

Method Detail

privateIpAddNotification

@POST
 @Path(value="{privateip}/{mac}/{hostname}")
public String privateIpAddNotification(@PathParam(value="privateip")
                                                                                          String privateIp,
                                                                                          @PathParam(value="mac")
                                                                                          String mac,
                                                                                          @PathParam(value="hostname")
                                                                                          String hostName)

Create a new virtual BNG connection.

Parameters:

privateIp - IP Address for the BNG private network

mac - MAC address for the host

hostName - name of the host

Returns:

public IP address for the new connection

privateIpDeleteNotification

@DELETE
 @Path(value="{privateip}")
public javax.ws.rs.core.Response privateIpDeleteNotification(@PathParam(value="privateip")
                                                                                                 String privateIp)

Delete a virtual BNG connection.

Parameters:

privateIp - IP Address for the BNG private network

Returns:

200 OK

privateIpDeleteNotification

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

Query virtual BNG map.

Returns:

IP Address map