org.onosproject.protocol.rest

Interface RestSBController

All Superinterfaces:

HttpSBController

public interface RestSBController
extends HttpSBController

Abstraction of an REST controller. Serves as a one stop shop for obtaining Rest southbound devices.

Method Summary

Modifier and Type	Method and Description
void	addProxiedDevice(org.onosproject.net.DeviceId deviceId, RestSBDevice proxy) Add a new association between a proxied device exposed to ONOS and a REST proxy server.
Set<org.onosproject.net.DeviceId>	getProxiedDevices(org.onosproject.net.DeviceId proxyId) Get all the proxied device exposed to ONOS ids under the same REST proxy server.
RestSBDevice	getProxySBDevice(org.onosproject.net.DeviceId deviceId) Get a REST proxied server given a device id.
void	removeProxiedDevice(org.onosproject.net.DeviceId deviceId) Remove the association between a proxied device exposed to ONOS and a REST proxy server.

Methods inherited from interface org.onosproject.protocol.http.HttpSBController

addDevice, delete, delete, get, get, getDevice, getDevice, getDevices, patch, patch, post, post, post, post, put, put, removeDevice

Method Detail

addProxiedDevice

void addProxiedDevice(org.onosproject.net.DeviceId deviceId,
                      RestSBDevice proxy)

Add a new association between a proxied device exposed to ONOS and a REST proxy server.

Parameters:

deviceId - REST device identifier

proxy - REST proxy device

removeProxiedDevice

void removeProxiedDevice(org.onosproject.net.DeviceId deviceId)

Remove the association between a proxied device exposed to ONOS and a REST proxy server.

Parameters:

deviceId - REST device identifier

getProxiedDevices

Set<org.onosproject.net.DeviceId> getProxiedDevices(org.onosproject.net.DeviceId proxyId)

Get all the proxied device exposed to ONOS ids under the same REST proxy server.

Parameters:

proxyId - REST proxy device identifier

Returns:

set of device ids under same proxy

getProxySBDevice

RestSBDevice getProxySBDevice(org.onosproject.net.DeviceId deviceId)

Get a REST proxied server given a device id.

Parameters:

deviceId - the id of proxied device exposed to ONOS

Returns:

the corresponding REST proxied device