Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
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; |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 21 | import org.onosproject.core.ApplicationId; |
| 22 | import org.onosproject.core.CoreService; |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 23 | import org.onosproject.net.DeviceId; |
Yoonseon Han | 59ecdf3 | 2016-09-28 14:18:59 -0700 | [diff] [blame] | 24 | import org.onosproject.net.device.DeviceService; |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 25 | import org.onosproject.net.meter.DefaultMeterRequest; |
| 26 | import org.onosproject.net.meter.Meter; |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 27 | import org.onosproject.net.meter.MeterCellId; |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 28 | import org.onosproject.net.meter.MeterId; |
| 29 | import org.onosproject.net.meter.MeterRequest; |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 30 | import org.onosproject.net.meter.MeterScope; |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 31 | import org.onosproject.net.meter.MeterService; |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 32 | import org.onosproject.net.pi.model.PiMeterId; |
| 33 | import org.onosproject.net.pi.runtime.PiMeterCellId; |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 34 | import org.onosproject.rest.AbstractWebResource; |
| 35 | import org.slf4j.Logger; |
| 36 | |
| 37 | import javax.ws.rs.Consumes; |
| 38 | import javax.ws.rs.DELETE; |
| 39 | import javax.ws.rs.GET; |
| 40 | import javax.ws.rs.POST; |
| 41 | import javax.ws.rs.Path; |
| 42 | import javax.ws.rs.PathParam; |
| 43 | import javax.ws.rs.Produces; |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 44 | import javax.ws.rs.core.Context; |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 45 | import javax.ws.rs.core.MediaType; |
| 46 | import javax.ws.rs.core.Response; |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 47 | import javax.ws.rs.core.UriBuilder; |
| 48 | import javax.ws.rs.core.UriInfo; |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 49 | import java.io.IOException; |
| 50 | import java.io.InputStream; |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 51 | |
| 52 | import static org.onlab.util.Tools.nullIsNotFound; |
Ray Milkey | 86ee5e8 | 2018-04-02 15:33:07 -0700 | [diff] [blame] | 53 | import static org.onlab.util.Tools.readTreeFromStream; |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 54 | import static org.slf4j.LoggerFactory.getLogger; |
| 55 | |
| 56 | /** |
| 57 | * Query and program meter rules. |
| 58 | */ |
| 59 | @Path("meters") |
| 60 | public class MetersWebResource extends AbstractWebResource { |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 61 | |
| 62 | @Context |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 63 | private UriInfo uriInfo; |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 64 | |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 65 | private final Logger log = getLogger(getClass()); |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 66 | private static final String DEVICE_INVALID = "Invalid deviceId in meter creation request"; |
| 67 | private static final String METER_NOT_FOUND = "Meter is not found for "; |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 68 | |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 69 | private final ObjectNode root = mapper().createObjectNode(); |
| 70 | private final ArrayNode metersNode = root.putArray("meters"); |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 71 | |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 72 | private static final String REST_APP_ID = "org.onosproject.rest"; |
| 73 | private ApplicationId applicationId; |
| 74 | |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 75 | /** |
| 76 | * Returns all meters of all devices. |
| 77 | * |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 78 | * @return 200 OK with array of all the meters in the system |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 79 | * @onos.rsModel Meters |
| 80 | */ |
| 81 | @GET |
| 82 | @Produces(MediaType.APPLICATION_JSON) |
| 83 | public Response getMeters() { |
Andrea Campanella | 0ab52ba | 2020-06-10 13:24:38 +0200 | [diff] [blame] | 84 | MeterService meterService = get(MeterService.class); |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 85 | final Iterable<Meter> meters = meterService.getAllMeters(); |
| 86 | if (meters != null) { |
| 87 | meters.forEach(meter -> metersNode.add(codec(Meter.class).encode(meter, this))); |
| 88 | } |
| 89 | return ok(root).build(); |
| 90 | } |
| 91 | |
| 92 | /** |
Jian Li | a4faf4f | 2016-01-06 00:22:52 -0800 | [diff] [blame] | 93 | * Returns a collection of meters by the device id. |
| 94 | * |
| 95 | * @param deviceId device identifier |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 96 | * @return 200 OK with array of meters which belongs to specified device |
Jian Li | a4faf4f | 2016-01-06 00:22:52 -0800 | [diff] [blame] | 97 | * @onos.rsModel Meters |
| 98 | */ |
| 99 | @GET |
| 100 | @Produces(MediaType.APPLICATION_JSON) |
| 101 | @Path("{deviceId}") |
| 102 | public Response getMetersByDeviceId(@PathParam("deviceId") String deviceId) { |
| 103 | DeviceId did = DeviceId.deviceId(deviceId); |
Andrea Campanella | 0ab52ba | 2020-06-10 13:24:38 +0200 | [diff] [blame] | 104 | MeterService meterService = get(MeterService.class); |
Jian Li | a4faf4f | 2016-01-06 00:22:52 -0800 | [diff] [blame] | 105 | final Iterable<Meter> meters = meterService.getMeters(did); |
| 106 | if (meters != null) { |
| 107 | meters.forEach(meter -> metersNode.add(codec(Meter.class).encode(meter, this))); |
| 108 | } |
| 109 | return ok(root).build(); |
| 110 | } |
| 111 | |
| 112 | /** |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 113 | * Returns a meter by the meter id. |
| 114 | * |
| 115 | * @param deviceId device identifier |
Jian Li | dfba739 | 2016-01-22 16:46:58 -0800 | [diff] [blame] | 116 | * @param meterId meter identifier |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 117 | * @return 200 OK with a meter, return 404 if no entry has been found |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 118 | * @onos.rsModel Meter |
| 119 | */ |
| 120 | @GET |
| 121 | @Produces(MediaType.APPLICATION_JSON) |
| 122 | @Path("{deviceId}/{meterId}") |
| 123 | public Response getMeterByDeviceIdAndMeterId(@PathParam("deviceId") String deviceId, |
| 124 | @PathParam("meterId") String meterId) { |
| 125 | DeviceId did = DeviceId.deviceId(deviceId); |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 126 | MeterCellId mid = MeterId.meterId(Long.valueOf(meterId)); |
Andrea Campanella | 0ab52ba | 2020-06-10 13:24:38 +0200 | [diff] [blame] | 127 | MeterService meterService = get(MeterService.class); |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 128 | final Meter meter = nullIsNotFound(meterService.getMeter(did, mid), |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 129 | METER_NOT_FOUND + mid); |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 130 | |
| 131 | metersNode.add(codec(Meter.class).encode(meter, this)); |
| 132 | return ok(root).build(); |
| 133 | } |
| 134 | |
| 135 | /** |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 136 | * Returns a meter by the meter cell id. |
| 137 | * |
| 138 | * @param deviceId device identifier |
| 139 | * @param scope scope identifier |
| 140 | * @param index index |
| 141 | * @return 200 OK with a meter, return 404 if no entry has been found |
| 142 | * @onos.rsModel Meter |
| 143 | */ |
| 144 | @GET |
| 145 | @Produces(MediaType.APPLICATION_JSON) |
| 146 | @Path("{deviceId}/{scope}/{index}") |
| 147 | public Response getMeterByDeviceIdAndMeterCellId(@PathParam("deviceId") String deviceId, |
| 148 | @PathParam("scope") String scope, |
| 149 | @PathParam("index") String index) { |
| 150 | DeviceId did = DeviceId.deviceId(deviceId); |
| 151 | MeterScope meterScope = MeterScope.of(scope); |
| 152 | long meterIndex = Long.parseLong(index); |
| 153 | MeterCellId meterCellId; |
| 154 | if (meterScope.equals(MeterScope.globalScope())) { |
| 155 | meterCellId = MeterId.meterId(meterIndex); |
| 156 | } else { |
| 157 | meterCellId = PiMeterCellId.ofIndirect(PiMeterId.of(meterScope.id()), meterIndex); |
| 158 | } |
| 159 | |
| 160 | MeterService meterService = get(MeterService.class); |
| 161 | final Meter meter = nullIsNotFound(meterService.getMeter(did, meterCellId), |
| 162 | METER_NOT_FOUND + meterCellId); |
| 163 | |
| 164 | metersNode.add(codec(Meter.class).encode(meter, this)); |
| 165 | return ok(root).build(); |
| 166 | } |
| 167 | |
| 168 | /** |
| 169 | * Returns a collection of meters by the device id and meter scope. |
| 170 | * |
| 171 | * @param deviceId device identifier |
| 172 | * @param scope scope identifier |
| 173 | * @return 200 OK with array of meters which belongs to specified device |
| 174 | * @onos.rsModel Meters |
| 175 | */ |
| 176 | @GET |
| 177 | @Produces(MediaType.APPLICATION_JSON) |
| 178 | @Path("scope/{deviceId}/{scope}") |
| 179 | public Response getMetersByDeviceIdAndScope(@PathParam("deviceId") String deviceId, |
| 180 | @PathParam("scope") String scope) { |
| 181 | DeviceId did = DeviceId.deviceId(deviceId); |
| 182 | MeterScope meterScope = MeterScope.of(scope); |
| 183 | MeterService meterService = get(MeterService.class); |
| 184 | final Iterable<Meter> meters = meterService.getMeters(did, meterScope); |
| 185 | if (meters != null) { |
| 186 | meters.forEach(meter -> metersNode.add(codec(Meter.class).encode(meter, this))); |
| 187 | } |
| 188 | return ok(root).build(); |
| 189 | } |
| 190 | |
| 191 | /** |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 192 | * Creates new meter rule. Creates and installs a new meter rule for the |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 193 | * specified device. |
| 194 | * |
| 195 | * @param deviceId device identifier |
| 196 | * @param stream meter rule JSON |
| 197 | * @return status of the request - CREATED if the JSON is correct, |
| 198 | * BAD_REQUEST if the JSON is invalid |
| 199 | * @onos.rsModel MeterPost |
| 200 | */ |
| 201 | @POST |
| 202 | @Path("{deviceId}") |
| 203 | @Consumes(MediaType.APPLICATION_JSON) |
| 204 | @Produces(MediaType.APPLICATION_JSON) |
| 205 | public Response createMeter(@PathParam("deviceId") String deviceId, |
| 206 | InputStream stream) { |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 207 | try { |
Ray Milkey | 86ee5e8 | 2018-04-02 15:33:07 -0700 | [diff] [blame] | 208 | ObjectNode jsonTree = readTreeFromStream(mapper(), stream); |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 209 | JsonNode specifiedDeviceId = jsonTree.get("deviceId"); |
| 210 | |
Yoonseon Han | 59ecdf3 | 2016-09-28 14:18:59 -0700 | [diff] [blame] | 211 | if ((specifiedDeviceId != null && |
| 212 | !specifiedDeviceId.asText().equals(deviceId)) || |
| 213 | get(DeviceService.class).getDevice(DeviceId.deviceId(deviceId)) |
| 214 | == null) { |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 215 | throw new IllegalArgumentException(DEVICE_INVALID); |
| 216 | } |
Yoonseon Han | 59ecdf3 | 2016-09-28 14:18:59 -0700 | [diff] [blame] | 217 | |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 218 | jsonTree.put("deviceId", deviceId); |
Yoonseon Han | 59ecdf3 | 2016-09-28 14:18:59 -0700 | [diff] [blame] | 219 | final MeterRequest meterRequest = codec(MeterRequest.class) |
| 220 | .decode(jsonTree, this); |
| 221 | |
Andrea Campanella | 0ab52ba | 2020-06-10 13:24:38 +0200 | [diff] [blame] | 222 | MeterService meterService = get(MeterService.class); |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 223 | final Meter meter = meterService.submit(meterRequest); |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 224 | |
| 225 | UriBuilder locationBuilder = uriInfo.getBaseUriBuilder() |
| 226 | .path("meters") |
| 227 | .path(deviceId) |
| 228 | .path(Long.toString(meter.id().id())); |
| 229 | return Response |
| 230 | .created(locationBuilder.build()) |
| 231 | .build(); |
| 232 | } catch (IOException ex) { |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 233 | throw new IllegalArgumentException(ex); |
| 234 | } |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 235 | } |
| 236 | |
| 237 | /** |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 238 | * Removes the meter by device id and meter id. |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 239 | * |
| 240 | * @param deviceId device identifier |
| 241 | * @param meterId meter identifier |
Jian Li | c2a542b | 2016-05-10 11:48:19 -0700 | [diff] [blame] | 242 | * @return 204 NO CONTENT |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 243 | */ |
| 244 | @DELETE |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 245 | @Path("{deviceId}/{meterId}") |
Jian Li | c2a542b | 2016-05-10 11:48:19 -0700 | [diff] [blame] | 246 | public Response deleteMeterByDeviceIdAndMeterId(@PathParam("deviceId") String deviceId, |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 247 | @PathParam("meterId") String meterId) { |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 248 | DeviceId did = DeviceId.deviceId(deviceId); |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 249 | MeterCellId mid = MeterId.meterId(Long.valueOf(meterId)); |
| 250 | MeterRequest meterRequest = deleteRequest(did); |
Andrea Campanella | 0ab52ba | 2020-06-10 13:24:38 +0200 | [diff] [blame] | 251 | |
| 252 | MeterService meterService = get(MeterService.class); |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 253 | meterService.withdraw(meterRequest, mid); |
| 254 | |
Jian Li | c2a542b | 2016-05-10 11:48:19 -0700 | [diff] [blame] | 255 | return Response.noContent().build(); |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 256 | } |
| 257 | |
| 258 | /** |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 259 | * Removes the meter by the device id and meter cell id. |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 260 | * |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 261 | * @param deviceId device identifier |
| 262 | * @param scope scope identifier |
| 263 | * @param index index |
| 264 | * @return 204 NO CONTENT |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 265 | */ |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 266 | @DELETE |
| 267 | @Path("{deviceId}/{scope}/{index}") |
| 268 | public Response deleteMeterByDeviceIdAndMeterCellId(@PathParam("deviceId") String deviceId, |
| 269 | @PathParam("scope") String scope, |
| 270 | @PathParam("index") String index) { |
| 271 | DeviceId did = DeviceId.deviceId(deviceId); |
| 272 | MeterScope meterScope = MeterScope.of(scope); |
| 273 | long meterIndex = Long.parseLong(index); |
| 274 | MeterCellId meterCellId; |
| 275 | if (meterScope.equals(MeterScope.globalScope())) { |
| 276 | meterCellId = MeterId.meterId(meterIndex); |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 277 | } else { |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 278 | meterCellId = PiMeterCellId.ofIndirect(PiMeterId.of(meterScope.id()), meterIndex); |
| 279 | } |
| 280 | MeterRequest meterRequest = deleteRequest(did); |
| 281 | |
| 282 | MeterService meterService = get(MeterService.class); |
| 283 | meterService.withdraw(meterRequest, meterCellId); |
| 284 | |
| 285 | return Response.noContent().build(); |
| 286 | } |
| 287 | |
| 288 | private MeterRequest deleteRequest(DeviceId did) { |
| 289 | CoreService coreService = getService(CoreService.class); |
| 290 | if (applicationId == null) { |
| 291 | applicationId = coreService.registerApplication(REST_APP_ID); |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 292 | } |
| 293 | |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame^] | 294 | return DefaultMeterRequest.builder() |
| 295 | .forDevice(did) |
| 296 | .fromApp(applicationId) |
| 297 | .remove(); |
Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 298 | } |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 299 | } |