org.onosproject.protocol.rest

Interface RestSBController

public interface RestSBController

Abstraction of an REST controller. Serves as a one stop shop for obtaining Rest southbound devices and (un)register listeners.

Method Summary

Modifier and Type	Method and Description
void	addDevice(RestSBDevice device) Adds a device to the device map.
boolean	delete(org.onosproject.net.DeviceId device, String request, InputStream payload, String mediaType) Does a REST DELETE request with specified parameters to the device.
InputStream	get(org.onosproject.net.DeviceId device, String request, String mediaType) Does a REST GET request with specified parameters to the device.
RestSBDevice	getDevice(org.onosproject.net.DeviceId deviceInfo) Returns a device by node identifier.
RestSBDevice	getDevice(org.onlab.packet.IpAddress ip, int port) Returns a device by Ip and Port.
Map<org.onosproject.net.DeviceId,RestSBDevice>	getDevices() Returns all the devices known to this controller.
boolean	patch(org.onosproject.net.DeviceId device, String request, InputStream payload, String mediaType) Does a REST PATCH request with specified parameters to the device.
boolean	post(org.onosproject.net.DeviceId device, String request, InputStream payload, String mediaType) Does a REST POST request with specified parameters to the device.
boolean	put(org.onosproject.net.DeviceId device, String request, InputStream payload, String mediaType) Does a REST PUT request with specified parameters to the device.
void	removeDevice(org.onosproject.net.DeviceId deviceId) Removes the device from the devices map.

Method Detail

getDevices

Map<org.onosproject.net.DeviceId,RestSBDevice> getDevices()

Returns all the devices known to this controller.

Returns:

map of devices

getDevice

RestSBDevice getDevice(org.onosproject.net.DeviceId deviceInfo)

Returns a device by node identifier.

Parameters:

deviceInfo - node identifier

Returns:

RestSBDevice rest device

getDevice

RestSBDevice getDevice(org.onlab.packet.IpAddress ip,
                       int port)

Returns a device by Ip and Port.

Parameters:

ip - device ip

port - device port

Returns:

RestSBDevice rest device

addDevice

void addDevice(RestSBDevice device)

Adds a device to the device map.

Parameters:

device - to be added

removeDevice

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

Removes the device from the devices map.

Parameters:

deviceId - to be removed

post

boolean post(org.onosproject.net.DeviceId device,
             String request,
             InputStream payload,
             String mediaType)

Does a REST POST request with specified parameters to the device.

Parameters:

device - device to make the request to

request - url of the request

payload - payload of the request as an InputStream

mediaType - type of content in the payload i.e. application/json

Returns:

true if operation returned 200, 201, 202, false otherwise

put

boolean put(org.onosproject.net.DeviceId device,
            String request,
            InputStream payload,
            String mediaType)

Does a REST PUT request with specified parameters to the device.

Parameters:

device - device to make the request to

request - resource path of the request

payload - payload of the request as an InputStream

mediaType - type of content in the payload i.e. application/json

Returns:

true if operation returned 200, 201, 202, false otherwise

get

InputStream get(org.onosproject.net.DeviceId device,
                String request,
                String mediaType)

Does a REST GET request with specified parameters to the device.

Parameters:

device - device to make the request to

request - url of the request

mediaType - format to retrieve the content in

Returns:

an inputstream of data from the reply.

patch

boolean patch(org.onosproject.net.DeviceId device,
              String request,
              InputStream payload,
              String mediaType)

Does a REST PATCH request with specified parameters to the device.

Parameters:

device - device to make the request to

request - url of the request

payload - payload of the request as an InputStream

mediaType - format to retrieve the content in

Returns:

true if operation returned 200, 201, 202, false otherwise

delete

boolean delete(org.onosproject.net.DeviceId device,
               String request,
               InputStream payload,
               String mediaType)

Does a REST DELETE request with specified parameters to the device.

Parameters:

device - device to make the request to

request - url of the request

payload - payload of the request as an InputStream

mediaType - type of content in the payload i.e. application/json

Returns:

true if operation returned 200 false otherwise