org.onosproject.rest.resources

Class DevicesWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.DevicesWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="devices")
public class DevicesWebResource
extends org.onosproject.rest.AbstractWebResource

Manage inventory of infrastructure devices.

Constructor Summary

Constructors

Constructor and Description
DevicesWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getDevice(String id) Gets details of infrastructure device.
javax.ws.rs.core.Response	getDevicePorts(String id) Gets ports of infrastructure device.
javax.ws.rs.core.Response	getDevices() Gets all infrastructure devices.
javax.ws.rs.core.Response	removeDevice(String id) Removes infrastructure device.
javax.ws.rs.core.Response	setPortState(String id, String portId, InputStream stream) Changes the administrative state of a port.

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

DevicesWebResource

public DevicesWebResource()

Method Detail

getDevices

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

Gets all infrastructure devices. Returns array of all discovered infrastructure devices.

Returns:

200 OK with a collection of devices

onos model

DevicesGet

getDevice

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

Gets details of infrastructure device. Returns details of the specified infrastructure device.

Parameters:

id - device identifier

Returns:

200 OK with a device

onos model

DeviceGet

removeDevice

@DELETE
 @Path(value="{id}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response removeDevice(@PathParam(value="id")
                                                                                                                String id)

Removes infrastructure device. Administratively deletes the specified device from the inventory of known devices.

Parameters:

id - device identifier

Returns:

200 OK with the removed device

getDevicePorts

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

Gets ports of infrastructure device. Returns details of the specified infrastructure device.

Parameters:

id - device identifier

Returns:

200 OK with a collection of ports of the given device

onos model

DeviceGetPorts

setPortState

@POST
 @Path(value="{id}/portstate/{port_id}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response setPortState(@PathParam(value="id")
                                                                                                                                                                       String id,
                                                                                                                                                                       @PathParam(value="port_id")
                                                                                                                                                                       String portId,
                                                                                                                                                                       InputStream stream)

Changes the administrative state of a port.

Parameters:

id - device identifier

portId - port number

stream - input JSON

Returns:

200 OK if the port state was set to the given value

onos model

PortAdministrativeState