diff options
author | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
---|---|---|
committer | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
commit | 13d05bc8458758ee39cb829098241e89616717ee (patch) | |
tree | 22a4d1ce65f15952f07a3df5af4b462b4697cb3a /framework/src/onos/web/api/src/main/java/org/onosproject/rest/resources/DevicesWebResource.java | |
parent | 6139282e1e93c2322076de4b91b1c85d0bc4a8b3 (diff) |
ONOS checkin based on commit tag e796610b1f721d02f9b0e213cf6f7790c10ecd60
Change-Id: Ife8810491034fe7becdba75dda20de4267bd15cd
Diffstat (limited to 'framework/src/onos/web/api/src/main/java/org/onosproject/rest/resources/DevicesWebResource.java')
-rw-r--r-- | framework/src/onos/web/api/src/main/java/org/onosproject/rest/resources/DevicesWebResource.java | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/framework/src/onos/web/api/src/main/java/org/onosproject/rest/resources/DevicesWebResource.java b/framework/src/onos/web/api/src/main/java/org/onosproject/rest/resources/DevicesWebResource.java new file mode 100644 index 00000000..05756e5a --- /dev/null +++ b/framework/src/onos/web/api/src/main/java/org/onosproject/rest/resources/DevicesWebResource.java @@ -0,0 +1,106 @@ +/* + * Copyright 2014-2015 Open Networking Laboratory + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.onosproject.rest.resources; + +import com.fasterxml.jackson.databind.node.ObjectNode; +import org.onosproject.net.Device; +import org.onosproject.net.Port; +import org.onosproject.net.device.DeviceAdminService; +import org.onosproject.net.device.DeviceService; +import org.onosproject.rest.AbstractWebResource; + +import javax.ws.rs.DELETE; +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.core.Response; +import java.util.List; + +import static com.google.common.base.Preconditions.checkNotNull; +import static org.onlab.util.Tools.nullIsNotFound; +import static org.onosproject.net.DeviceId.deviceId; + +/** + * Manage inventory of infrastructure devices. + */ +@Path("devices") +public class DevicesWebResource extends AbstractWebResource { + + public static final String DEVICE_NOT_FOUND = "Device is not found"; + + /** + * Get all infrastructure devices. + * Returns array of all discovered infrastructure devices. + * + * @return 200 OK + */ + @GET + public Response getDevices() { + Iterable<Device> devices = get(DeviceService.class).getDevices(); + return ok(encodeArray(Device.class, "devices", devices)).build(); + } + + /** + * Get details of infrastructure device. + * Returns details of the specified infrastructure device. + * + * @param id device identifier + * @return 200 OK + */ + @GET + @Path("{id}") + public Response getDevice(@PathParam("id") String id) { + Device device = nullIsNotFound(get(DeviceService.class).getDevice(deviceId(id)), + DEVICE_NOT_FOUND); + return ok(codec(Device.class).encode(device, this)).build(); + } + + /** + * Remove infrastructure device. + * Administratively deletes the specified device from the inventory of + * known devices. + * + * @param id device identifier + * @return 200 OK + */ + @DELETE + @Path("{id}") + public Response removeDevice(@PathParam("id") String id) { + Device device = nullIsNotFound(get(DeviceService.class).getDevice(deviceId(id)), + DEVICE_NOT_FOUND); + get(DeviceAdminService.class).removeDevice(deviceId(id)); + return ok(codec(Device.class).encode(device, this)).build(); + } + + /** + * Get ports of infrastructure device. + * Returns details of the specified infrastructure device. + * + * @param id device identifier + * @return 200 OK + */ + @GET + @Path("{id}/ports") + public Response getDevicePorts(@PathParam("id") String id) { + DeviceService service = get(DeviceService.class); + Device device = nullIsNotFound(service.getDevice(deviceId(id)), DEVICE_NOT_FOUND); + List<Port> ports = checkNotNull(service.getPorts(deviceId(id)), "Ports could not be retrieved"); + ObjectNode result = codec(Device.class).encode(device, this); + result.set("ports", codec(Port.class).encode(ports, this)); + return ok(result).build(); + } + +} |