org.onosproject.rest.resources

Class DeviceKeyWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.DeviceKeyWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="keys")
public class DeviceKeyWebResource
extends org.onosproject.rest.AbstractWebResource

Query and Manage Device Keys.

Constructor Summary

Constructors

Constructor and Description
DeviceKeyWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addDeviceKey(InputStream stream) Adds a new device key from the JSON input stream.
javax.ws.rs.core.Response	getDeviceKey(String id) Gets a single device key by device key unique identifier.
javax.ws.rs.core.Response	getDeviceKeys() Gets all device keys.
javax.ws.rs.core.Response	removeDeviceKey(String id) Removes a device key by device key identifier.

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

DeviceKeyWebResource

public DeviceKeyWebResource()

Method Detail

getDeviceKeys

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

Gets all device keys. Returns array of all device keys.

Returns:

200 OK with a collection of device keys

onos model

Devicekeys

getDeviceKey

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

Gets a single device key by device key unique identifier. Returns the specified device key.

Parameters:

id - device key identifier

Returns:

200 OK with a device key, 404 not found

onos model

Devicekey

addDeviceKey

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

Adds a new device key from the JSON input stream.

Parameters:

stream - device key JSON stream

Returns:

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

onos model

Devicekey

removeDeviceKey

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

Removes a device key by device key identifier.

Parameters:

id - device key identifier

Returns:

200 OK with a removed device key, 404 not found