Jian Li | 5c41123 | 2015-12-16 15:29:16 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014-2015 Open Networking Laboratory |
| 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; |
| 37 | import javax.ws.rs.core.MediaType; |
| 38 | import javax.ws.rs.core.Response; |
| 39 | import java.io.IOException; |
| 40 | import java.io.InputStream; |
| 41 | import java.net.URI; |
| 42 | import java.net.URISyntaxException; |
| 43 | |
| 44 | import static org.onlab.util.Tools.nullIsNotFound; |
| 45 | import static org.slf4j.LoggerFactory.getLogger; |
| 46 | |
| 47 | /** |
| 48 | * Query and program meter rules. |
| 49 | */ |
| 50 | @Path("meters") |
| 51 | public class MetersWebResource extends AbstractWebResource { |
| 52 | private final Logger log = getLogger(getClass()); |
| 53 | public static final String DEVICE_INVALID = "Invalid deviceId in meter creation request"; |
| 54 | |
| 55 | final MeterService meterService = get(MeterService.class); |
| 56 | final ObjectNode root = mapper().createObjectNode(); |
| 57 | final ArrayNode metersNode = root.putArray("meters"); |
| 58 | |
| 59 | /** |
| 60 | * Returns all meters of all devices. |
| 61 | * |
| 62 | * @return array of all the meters in the system |
| 63 | * @onos.rsModel Meters |
| 64 | */ |
| 65 | @GET |
| 66 | @Produces(MediaType.APPLICATION_JSON) |
| 67 | public Response getMeters() { |
| 68 | final Iterable<Meter> meters = meterService.getAllMeters(); |
| 69 | if (meters != null) { |
| 70 | meters.forEach(meter -> metersNode.add(codec(Meter.class).encode(meter, this))); |
| 71 | } |
| 72 | return ok(root).build(); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Returns a meter by the meter id. |
| 77 | * |
| 78 | * @param deviceId device identifier |
| 79 | * @return array of all the groups in the system |
| 80 | * @onos.rsModel Meter |
| 81 | */ |
| 82 | @GET |
| 83 | @Produces(MediaType.APPLICATION_JSON) |
| 84 | @Path("{deviceId}/{meterId}") |
| 85 | public Response getMeterByDeviceIdAndMeterId(@PathParam("deviceId") String deviceId, |
| 86 | @PathParam("meterId") String meterId) { |
| 87 | DeviceId did = DeviceId.deviceId(deviceId); |
| 88 | MeterId mid = MeterId.meterId(Long.valueOf(meterId)); |
| 89 | |
| 90 | final Meter meter = nullIsNotFound(meterService.getMeter(did, mid), |
| 91 | "Meter is not found for " + mid.id()); |
| 92 | |
| 93 | metersNode.add(codec(Meter.class).encode(meter, this)); |
| 94 | return ok(root).build(); |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Create new meter rule. Creates and installs a new meter rule for the |
| 99 | * specified device. |
| 100 | * |
| 101 | * @param deviceId device identifier |
| 102 | * @param stream meter rule JSON |
| 103 | * @return status of the request - CREATED if the JSON is correct, |
| 104 | * BAD_REQUEST if the JSON is invalid |
| 105 | * @onos.rsModel MeterPost |
| 106 | */ |
| 107 | @POST |
| 108 | @Path("{deviceId}") |
| 109 | @Consumes(MediaType.APPLICATION_JSON) |
| 110 | @Produces(MediaType.APPLICATION_JSON) |
| 111 | public Response createMeter(@PathParam("deviceId") String deviceId, |
| 112 | InputStream stream) { |
| 113 | URI location; |
| 114 | try { |
| 115 | ObjectNode jsonTree = (ObjectNode) mapper().readTree(stream); |
| 116 | JsonNode specifiedDeviceId = jsonTree.get("deviceId"); |
| 117 | |
| 118 | if (specifiedDeviceId != null && |
| 119 | !specifiedDeviceId.asText().equals(deviceId)) { |
| 120 | throw new IllegalArgumentException(DEVICE_INVALID); |
| 121 | } |
| 122 | jsonTree.put("deviceId", deviceId); |
| 123 | final Meter tmpMeter = codec(Meter.class).decode(jsonTree, this); |
| 124 | final MeterRequest meterRequest = meterToMeterRequest(tmpMeter, "ADD"); |
| 125 | final Meter meter = meterService.submit(meterRequest); |
| 126 | location = new URI(Long.toString(meter.id().id())); |
| 127 | } catch (IOException | URISyntaxException ex) { |
| 128 | throw new IllegalArgumentException(ex); |
| 129 | } |
| 130 | |
| 131 | return Response |
| 132 | .created(location) |
| 133 | .build(); |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Removes the specified meter. |
| 138 | * |
| 139 | * @param deviceId device identifier |
| 140 | * @param meterId meter identifier |
| 141 | */ |
| 142 | @DELETE |
| 143 | @Produces(MediaType.APPLICATION_JSON) |
| 144 | @Path("{deviceId}/{meterId}") |
| 145 | public void deleteMeterByDeviceIdAndMeterId(@PathParam("deviceId") String deviceId, |
| 146 | @PathParam("meterId") String meterId) { |
| 147 | DeviceId did = DeviceId.deviceId(deviceId); |
| 148 | MeterId mid = MeterId.meterId(Long.valueOf(meterId)); |
| 149 | final Meter tmpMeter = meterService.getMeter(did, mid); |
| 150 | if (tmpMeter != null) { |
| 151 | final MeterRequest meterRequest = meterToMeterRequest(tmpMeter, "REMOVE"); |
| 152 | meterService.withdraw(meterRequest, tmpMeter.id()); |
| 153 | } |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * Convert a meter instance to meterRequest instance with a certain operation. |
| 158 | * |
| 159 | * @param meter meter instance |
| 160 | * @param operation operation |
| 161 | * @return converted meterRequest instance |
| 162 | */ |
| 163 | private MeterRequest meterToMeterRequest(Meter meter, String operation) { |
| 164 | MeterRequest.Builder builder; |
| 165 | MeterRequest meterRequest; |
| 166 | |
| 167 | if (meter == null) { |
| 168 | return null; |
| 169 | } |
| 170 | |
| 171 | if (meter.isBurst()) { |
| 172 | builder = DefaultMeterRequest.builder() |
| 173 | .fromApp(meter.appId()) |
| 174 | .forDevice(meter.deviceId()) |
| 175 | .withUnit(meter.unit()) |
| 176 | .withBands(meter.bands()) |
| 177 | .burst(); |
| 178 | } else { |
| 179 | builder = DefaultMeterRequest.builder() |
| 180 | .fromApp(meter.appId()) |
| 181 | .forDevice(meter.deviceId()) |
| 182 | .withUnit(meter.unit()) |
| 183 | .withBands(meter.bands()); |
| 184 | } |
| 185 | |
| 186 | switch (operation) { |
| 187 | case "ADD": |
| 188 | meterRequest = builder.add(); |
| 189 | break; |
| 190 | case "REMOVE": |
| 191 | meterRequest = builder.remove(); |
| 192 | break; |
| 193 | default: |
| 194 | log.warn("Invalid operation {}.", operation); |
| 195 | return null; |
| 196 | } |
| 197 | |
| 198 | return meterRequest; |
| 199 | } |
| 200 | } |