Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.rest.resources; |
| 17 | |
| 18 | import com.fasterxml.jackson.databind.JsonNode; |
| 19 | import com.fasterxml.jackson.databind.node.ArrayNode; |
| 20 | import com.fasterxml.jackson.databind.node.ObjectNode; |
| 21 | import org.onosproject.net.DeviceId; |
| 22 | import org.onosproject.net.meter.DefaultMeterRequest; |
| 23 | import org.onosproject.net.meter.Meter; |
| 24 | import org.onosproject.net.meter.MeterId; |
| 25 | import org.onosproject.net.meter.MeterRequest; |
| 26 | import org.onosproject.net.meter.MeterService; |
| 27 | import org.onosproject.rest.AbstractWebResource; |
| 28 | import org.slf4j.Logger; |
| 29 | |
| 30 | import javax.ws.rs.Consumes; |
| 31 | import javax.ws.rs.DELETE; |
| 32 | import javax.ws.rs.GET; |
| 33 | import javax.ws.rs.POST; |
| 34 | import javax.ws.rs.Path; |
| 35 | import javax.ws.rs.PathParam; |
| 36 | import javax.ws.rs.Produces; |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 37 | import javax.ws.rs.core.Context; |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 38 | import javax.ws.rs.core.MediaType; |
| 39 | import javax.ws.rs.core.Response; |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 40 | import javax.ws.rs.core.UriBuilder; |
| 41 | import javax.ws.rs.core.UriInfo; |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 42 | import java.io.IOException; |
| 43 | import java.io.InputStream; |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 44 | |
| 45 | import static org.onlab.util.Tools.nullIsNotFound; |
| 46 | import static org.slf4j.LoggerFactory.getLogger; |
| 47 | |
| 48 | /** |
| 49 | * Query and program meter rules. |
| 50 | */ |
| 51 | @Path("meters") |
| 52 | public class MetersWebResource extends AbstractWebResource { |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 53 | |
| 54 | @Context |
| 55 | UriInfo uriInfo; |
| 56 | |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 57 | private final Logger log = getLogger(getClass()); |
| 58 | public static final String DEVICE_INVALID = "Invalid deviceId in meter creation request"; |
Jian Li | 5e5734f | 2016-01-06 00:33:43 -0800 | [diff] [blame] | 59 | public static final String METER_NOT_FOUND = "Meter is not found for "; |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 60 | |
| 61 | final MeterService meterService = get(MeterService.class); |
| 62 | final ObjectNode root = mapper().createObjectNode(); |
| 63 | final ArrayNode metersNode = root.putArray("meters"); |
| 64 | |
| 65 | /** |
| 66 | * Returns all meters of all devices. |
| 67 | * |
| 68 | * @return array of all the meters in the system |
| 69 | * @onos.rsModel Meters |
| 70 | */ |
| 71 | @GET |
| 72 | @Produces(MediaType.APPLICATION_JSON) |
| 73 | public Response getMeters() { |
| 74 | final Iterable<Meter> meters = meterService.getAllMeters(); |
| 75 | if (meters != null) { |
| 76 | meters.forEach(meter -> metersNode.add(codec(Meter.class).encode(meter, this))); |
| 77 | } |
| 78 | return ok(root).build(); |
| 79 | } |
| 80 | |
| 81 | /** |
Jian Li | a4faf4f | 2016-01-06 00:22:52 -0800 | [diff] [blame] | 82 | * Returns a collection of meters by the device id. |
| 83 | * |
| 84 | * @param deviceId device identifier |
| 85 | * @return array of meters which belongs to specified device |
| 86 | * @onos.rsModel Meters |
| 87 | */ |
| 88 | @GET |
| 89 | @Produces(MediaType.APPLICATION_JSON) |
| 90 | @Path("{deviceId}") |
| 91 | public Response getMetersByDeviceId(@PathParam("deviceId") String deviceId) { |
| 92 | DeviceId did = DeviceId.deviceId(deviceId); |
| 93 | final Iterable<Meter> meters = meterService.getMeters(did); |
| 94 | if (meters != null) { |
| 95 | meters.forEach(meter -> metersNode.add(codec(Meter.class).encode(meter, this))); |
| 96 | } |
| 97 | return ok(root).build(); |
| 98 | } |
| 99 | |
| 100 | /** |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 101 | * Returns a meter by the meter id. |
| 102 | * |
| 103 | * @param deviceId device identifier |
Jian Li | dfba739 | 2016-01-22 16:46:58 -0800 | [diff] [blame] | 104 | * @param meterId meter identifier |
Jian Li | a4faf4f | 2016-01-06 00:22:52 -0800 | [diff] [blame] | 105 | * @return a meter, return 404 if no entry has been found |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 106 | * @onos.rsModel Meter |
| 107 | */ |
| 108 | @GET |
| 109 | @Produces(MediaType.APPLICATION_JSON) |
| 110 | @Path("{deviceId}/{meterId}") |
| 111 | public Response getMeterByDeviceIdAndMeterId(@PathParam("deviceId") String deviceId, |
| 112 | @PathParam("meterId") String meterId) { |
| 113 | DeviceId did = DeviceId.deviceId(deviceId); |
| 114 | MeterId mid = MeterId.meterId(Long.valueOf(meterId)); |
| 115 | |
| 116 | final Meter meter = nullIsNotFound(meterService.getMeter(did, mid), |
Jian Li | 5e5734f | 2016-01-06 00:33:43 -0800 | [diff] [blame] | 117 | METER_NOT_FOUND + mid.id()); |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 118 | |
| 119 | metersNode.add(codec(Meter.class).encode(meter, this)); |
| 120 | return ok(root).build(); |
| 121 | } |
| 122 | |
| 123 | /** |
| 124 | * Create new meter rule. Creates and installs a new meter rule for the |
| 125 | * specified device. |
| 126 | * |
| 127 | * @param deviceId device identifier |
| 128 | * @param stream meter rule JSON |
| 129 | * @return status of the request - CREATED if the JSON is correct, |
| 130 | * BAD_REQUEST if the JSON is invalid |
| 131 | * @onos.rsModel MeterPost |
| 132 | */ |
| 133 | @POST |
| 134 | @Path("{deviceId}") |
| 135 | @Consumes(MediaType.APPLICATION_JSON) |
| 136 | @Produces(MediaType.APPLICATION_JSON) |
| 137 | public Response createMeter(@PathParam("deviceId") String deviceId, |
| 138 | InputStream stream) { |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 139 | try { |
| 140 | ObjectNode jsonTree = (ObjectNode) mapper().readTree(stream); |
| 141 | JsonNode specifiedDeviceId = jsonTree.get("deviceId"); |
| 142 | |
| 143 | if (specifiedDeviceId != null && |
| 144 | !specifiedDeviceId.asText().equals(deviceId)) { |
| 145 | throw new IllegalArgumentException(DEVICE_INVALID); |
| 146 | } |
| 147 | jsonTree.put("deviceId", deviceId); |
Jian Li | 9567896 | 2016-01-26 17:17:52 -0800 | [diff] [blame] | 148 | final MeterRequest meterRequest = codec(MeterRequest.class).decode(jsonTree, this); |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 149 | final Meter meter = meterService.submit(meterRequest); |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 150 | |
| 151 | UriBuilder locationBuilder = uriInfo.getBaseUriBuilder() |
| 152 | .path("meters") |
| 153 | .path(deviceId) |
| 154 | .path(Long.toString(meter.id().id())); |
| 155 | return Response |
| 156 | .created(locationBuilder.build()) |
| 157 | .build(); |
| 158 | } catch (IOException ex) { |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 159 | throw new IllegalArgumentException(ex); |
| 160 | } |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 161 | } |
| 162 | |
| 163 | /** |
| 164 | * Removes the specified meter. |
| 165 | * |
| 166 | * @param deviceId device identifier |
| 167 | * @param meterId meter identifier |
Jian Li | c2a542b | 2016-05-10 11:48:19 -0700 | [diff] [blame] | 168 | * @return 204 NO CONTENT |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 169 | */ |
| 170 | @DELETE |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 171 | @Path("{deviceId}/{meterId}") |
Jian Li | c2a542b | 2016-05-10 11:48:19 -0700 | [diff] [blame] | 172 | public Response deleteMeterByDeviceIdAndMeterId(@PathParam("deviceId") String deviceId, |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 173 | @PathParam("meterId") String meterId) { |
| 174 | DeviceId did = DeviceId.deviceId(deviceId); |
| 175 | MeterId mid = MeterId.meterId(Long.valueOf(meterId)); |
| 176 | final Meter tmpMeter = meterService.getMeter(did, mid); |
| 177 | if (tmpMeter != null) { |
| 178 | final MeterRequest meterRequest = meterToMeterRequest(tmpMeter, "REMOVE"); |
| 179 | meterService.withdraw(meterRequest, tmpMeter.id()); |
| 180 | } |
Jian Li | c2a542b | 2016-05-10 11:48:19 -0700 | [diff] [blame] | 181 | return Response.noContent().build(); |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 182 | } |
| 183 | |
| 184 | /** |
| 185 | * Convert a meter instance to meterRequest instance with a certain operation. |
| 186 | * |
| 187 | * @param meter meter instance |
| 188 | * @param operation operation |
| 189 | * @return converted meterRequest instance |
| 190 | */ |
| 191 | private MeterRequest meterToMeterRequest(Meter meter, String operation) { |
| 192 | MeterRequest.Builder builder; |
| 193 | MeterRequest meterRequest; |
| 194 | |
| 195 | if (meter == null) { |
| 196 | return null; |
| 197 | } |
| 198 | |
| 199 | if (meter.isBurst()) { |
| 200 | builder = DefaultMeterRequest.builder() |
| 201 | .fromApp(meter.appId()) |
| 202 | .forDevice(meter.deviceId()) |
| 203 | .withUnit(meter.unit()) |
| 204 | .withBands(meter.bands()) |
| 205 | .burst(); |
| 206 | } else { |
| 207 | builder = DefaultMeterRequest.builder() |
| 208 | .fromApp(meter.appId()) |
| 209 | .forDevice(meter.deviceId()) |
| 210 | .withUnit(meter.unit()) |
| 211 | .withBands(meter.bands()); |
| 212 | } |
| 213 | |
| 214 | switch (operation) { |
| 215 | case "ADD": |
| 216 | meterRequest = builder.add(); |
| 217 | break; |
| 218 | case "REMOVE": |
| 219 | meterRequest = builder.remove(); |
| 220 | break; |
| 221 | default: |
| 222 | log.warn("Invalid operation {}.", operation); |
| 223 | return null; |
| 224 | } |
| 225 | |
| 226 | return meterRequest; |
| 227 | } |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 228 | } |