Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -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 | */ |
Jonathan Hart | 9bb32ab | 2015-05-05 18:17:31 -0700 | [diff] [blame] | 16 | package org.onosproject.rest.resources; |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 17 | |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 18 | import com.fasterxml.jackson.databind.JsonNode; |
| 19 | import com.fasterxml.jackson.databind.node.ArrayNode; |
| 20 | import com.fasterxml.jackson.databind.node.ObjectNode; |
Ray Milkey | 460f9b0 | 2016-03-29 11:56:19 -0700 | [diff] [blame] | 21 | import com.google.common.collect.ArrayListMultimap; |
| 22 | import com.google.common.collect.ListMultimap; |
Ray Milkey | d43fe45 | 2015-05-29 09:35:12 -0700 | [diff] [blame] | 23 | import org.onlab.util.ItemNotFoundException; |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 24 | import org.onosproject.app.ApplicationService; |
| 25 | import org.onosproject.core.ApplicationId; |
Ray Milkey | d43fe45 | 2015-05-29 09:35:12 -0700 | [diff] [blame] | 26 | import org.onosproject.net.Device; |
| 27 | import org.onosproject.net.DeviceId; |
| 28 | import org.onosproject.net.device.DeviceService; |
| 29 | import org.onosproject.net.flow.FlowEntry; |
| 30 | import org.onosproject.net.flow.FlowRule; |
| 31 | import org.onosproject.net.flow.FlowRuleService; |
| 32 | import org.onosproject.rest.AbstractWebResource; |
| 33 | |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 34 | import javax.ws.rs.Consumes; |
| 35 | import javax.ws.rs.DELETE; |
| 36 | import javax.ws.rs.GET; |
| 37 | import javax.ws.rs.POST; |
| 38 | import javax.ws.rs.Path; |
| 39 | import javax.ws.rs.PathParam; |
| 40 | import javax.ws.rs.Produces; |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 41 | import javax.ws.rs.QueryParam; |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 42 | import javax.ws.rs.core.Context; |
| 43 | import javax.ws.rs.core.MediaType; |
| 44 | import javax.ws.rs.core.Response; |
| 45 | import javax.ws.rs.core.UriBuilder; |
| 46 | import javax.ws.rs.core.UriInfo; |
| 47 | import java.io.IOException; |
| 48 | import java.io.InputStream; |
Ray Milkey | 460f9b0 | 2016-03-29 11:56:19 -0700 | [diff] [blame] | 49 | import java.util.ArrayList; |
Thomas Vachuska | a1ae5e1 | 2016-03-28 10:36:30 -0700 | [diff] [blame] | 50 | import java.util.List; |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 51 | import java.util.stream.StreamSupport; |
Ray Milkey | d43fe45 | 2015-05-29 09:35:12 -0700 | [diff] [blame] | 52 | |
Ray Milkey | 131c068 | 2016-10-18 11:12:50 -0700 | [diff] [blame] | 53 | import static org.onlab.util.Tools.nullIsIllegal; |
Ray Milkey | 460f9b0 | 2016-03-29 11:56:19 -0700 | [diff] [blame] | 54 | import static org.onlab.util.Tools.nullIsNotFound; |
Ray Milkey | 86ee5e8 | 2018-04-02 15:33:07 -0700 | [diff] [blame] | 55 | import static org.onlab.util.Tools.readTreeFromStream; |
Ray Milkey | 460f9b0 | 2016-03-29 11:56:19 -0700 | [diff] [blame] | 56 | |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 57 | /** |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 58 | * Query and program flow rules. |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 59 | */ |
| 60 | |
| 61 | @Path("flows") |
| 62 | public class FlowsWebResource extends AbstractWebResource { |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 63 | |
| 64 | @Context |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 65 | private UriInfo uriInfo; |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 66 | |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 67 | private static final String DEVICE_NOT_FOUND = "Device is not found"; |
| 68 | private static final String FLOW_NOT_FOUND = "Flow is not found"; |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 69 | private static final String APP_ID_NOT_FOUND = "Application Id is not found"; |
Ray Milkey | 131c068 | 2016-10-18 11:12:50 -0700 | [diff] [blame] | 70 | private static final String FLOW_ARRAY_REQUIRED = "Flows array was not specified"; |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 71 | private static final String FLOWS = "flows"; |
| 72 | private static final String DEVICE_ID = "deviceId"; |
| 73 | private static final String FLOW_ID = "flowId"; |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 74 | |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 75 | private final FlowRuleService service = get(FlowRuleService.class); |
| 76 | private final ObjectNode root = mapper().createObjectNode(); |
| 77 | private final ArrayNode flowsNode = root.putArray(FLOWS); |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 78 | |
| 79 | /** |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 80 | * Gets all flow entries. Returns array of all flow rules in the system. |
| 81 | * |
| 82 | * @return 200 OK with a collection of flows |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 83 | * @onos.rsModel FlowEntries |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 84 | */ |
| 85 | @GET |
| 86 | @Produces(MediaType.APPLICATION_JSON) |
| 87 | public Response getFlows() { |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 88 | final Iterable<Device> devices = get(DeviceService.class).getDevices(); |
| 89 | for (final Device device : devices) { |
Phaneendra Manda | aec654c | 2015-09-23 19:02:23 +0530 | [diff] [blame] | 90 | final Iterable<FlowEntry> flowEntries = service.getFlowEntries(device.id()); |
| 91 | if (flowEntries != null) { |
| 92 | for (final FlowEntry entry : flowEntries) { |
Thomas Vachuska | 8683e01 | 2015-03-18 18:03:33 -0700 | [diff] [blame] | 93 | flowsNode.add(codec(FlowEntry.class).encode(entry, this)); |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 94 | } |
| 95 | } |
| 96 | } |
| 97 | |
Ray Milkey | 3f02569 | 2015-01-26 11:15:41 -0800 | [diff] [blame] | 98 | return ok(root).build(); |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 99 | } |
| 100 | |
rsahot036 | 851105e | 2018-04-30 16:25:05 -0400 | [diff] [blame] | 101 | /** |
| 102 | * Gets all pending flow entries. Returns array of all pending flow rules in the system. |
| 103 | * |
| 104 | * @return 200 OK with a collection of flows |
| 105 | * @onos.rsModel FlowEntries |
| 106 | */ |
| 107 | @GET |
| 108 | @Produces(MediaType.APPLICATION_JSON) |
| 109 | @Path("pending") |
| 110 | public Response getPendingFlows() { |
| 111 | final Iterable<Device> devices = get(DeviceService.class).getDevices(); |
| 112 | for (final Device device : devices) { |
| 113 | final Iterable<FlowEntry> flowEntries = service.getFlowEntries(device.id()); |
| 114 | if (flowEntries != null) { |
| 115 | for (final FlowEntry entry : flowEntries) { |
| 116 | if ((entry.state() == FlowEntry.FlowEntryState.PENDING_ADD) || |
| 117 | (entry.state() == FlowEntry.FlowEntryState.PENDING_REMOVE)) { |
| 118 | flowsNode.add(codec(FlowEntry.class).encode(entry, this)); |
| 119 | } |
| 120 | } |
| 121 | } |
| 122 | } |
| 123 | |
| 124 | return ok(root).build(); |
| 125 | } |
| 126 | |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 127 | /** |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 128 | * Creates new flow rules. Creates and installs a new flow rules.<br> |
Jonathan Hart | f09a13a | 2017-01-26 09:52:14 -0800 | [diff] [blame] | 129 | * Flow rule criteria and instruction description: |
| 130 | * https://wiki.onosproject.org/display/ONOS/Flow+Rules |
Thomas Vachuska | a1ae5e1 | 2016-03-28 10:36:30 -0700 | [diff] [blame] | 131 | * |
Ray Milkey | bb23e0b | 2016-08-02 17:00:21 -0700 | [diff] [blame] | 132 | * @param appId application id |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 133 | * @param stream flow rules JSON |
Thomas Vachuska | a1ae5e1 | 2016-03-28 10:36:30 -0700 | [diff] [blame] | 134 | * @return status of the request - CREATED if the JSON is correct, |
| 135 | * BAD_REQUEST if the JSON is invalid |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 136 | * @onos.rsModel FlowsBatchPost |
Thomas Vachuska | a1ae5e1 | 2016-03-28 10:36:30 -0700 | [diff] [blame] | 137 | */ |
| 138 | @POST |
| 139 | @Consumes(MediaType.APPLICATION_JSON) |
| 140 | @Produces(MediaType.APPLICATION_JSON) |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 141 | public Response createFlows(@QueryParam("appId") String appId, InputStream stream) { |
Thomas Vachuska | a1ae5e1 | 2016-03-28 10:36:30 -0700 | [diff] [blame] | 142 | try { |
Ray Milkey | 86ee5e8 | 2018-04-02 15:33:07 -0700 | [diff] [blame] | 143 | ObjectNode jsonTree = readTreeFromStream(mapper(), stream); |
Ray Milkey | 131c068 | 2016-10-18 11:12:50 -0700 | [diff] [blame] | 144 | ArrayNode flowsArray = nullIsIllegal((ArrayNode) jsonTree.get(FLOWS), |
| 145 | FLOW_ARRAY_REQUIRED); |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 146 | |
Jonathan Hart | 9b80da8 | 2016-11-10 21:46:15 +0000 | [diff] [blame] | 147 | if (appId != null) { |
| 148 | flowsArray.forEach(flowJson -> ((ObjectNode) flowJson).put("appId", appId)); |
| 149 | } |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 150 | |
Thomas Vachuska | a1ae5e1 | 2016-03-28 10:36:30 -0700 | [diff] [blame] | 151 | List<FlowRule> rules = codec(FlowRule.class).decode(flowsArray, this); |
Ray Milkey | 131c068 | 2016-10-18 11:12:50 -0700 | [diff] [blame] | 152 | |
Thomas Vachuska | a1ae5e1 | 2016-03-28 10:36:30 -0700 | [diff] [blame] | 153 | service.applyFlowRules(rules.toArray(new FlowRule[rules.size()])); |
Ray Milkey | 460f9b0 | 2016-03-29 11:56:19 -0700 | [diff] [blame] | 154 | rules.forEach(flowRule -> { |
| 155 | ObjectNode flowNode = mapper().createObjectNode(); |
| 156 | flowNode.put(DEVICE_ID, flowRule.deviceId().toString()) |
Jayasree Ghosh | 28e1b3e | 2016-06-16 05:38:50 +0530 | [diff] [blame] | 157 | .put(FLOW_ID, Long.toString(flowRule.id().value())); |
Ray Milkey | 460f9b0 | 2016-03-29 11:56:19 -0700 | [diff] [blame] | 158 | flowsNode.add(flowNode); |
| 159 | }); |
Thomas Vachuska | a1ae5e1 | 2016-03-28 10:36:30 -0700 | [diff] [blame] | 160 | } catch (IOException ex) { |
| 161 | throw new IllegalArgumentException(ex); |
| 162 | } |
Ray Milkey | 460f9b0 | 2016-03-29 11:56:19 -0700 | [diff] [blame] | 163 | return Response.ok(root).build(); |
Thomas Vachuska | a1ae5e1 | 2016-03-28 10:36:30 -0700 | [diff] [blame] | 164 | } |
| 165 | |
| 166 | /** |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 167 | * Gets flow entries of a device. Returns array of all flow rules for the |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 168 | * specified device. |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 169 | * |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 170 | * @param deviceId device identifier |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 171 | * @return 200 OK with a collection of flows of given device |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 172 | * @onos.rsModel FlowEntries |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 173 | */ |
| 174 | @GET |
| 175 | @Produces(MediaType.APPLICATION_JSON) |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 176 | // TODO: we need to add "/device" suffix to the path to differentiate with appId |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 177 | @Path("{deviceId}") |
| 178 | public Response getFlowByDeviceId(@PathParam("deviceId") String deviceId) { |
Phaneendra Manda | aec654c | 2015-09-23 19:02:23 +0530 | [diff] [blame] | 179 | final Iterable<FlowEntry> flowEntries = |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 180 | service.getFlowEntries(DeviceId.deviceId(deviceId)); |
| 181 | |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 182 | if (flowEntries == null || !flowEntries.iterator().hasNext()) { |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 183 | throw new ItemNotFoundException(DEVICE_NOT_FOUND); |
| 184 | } |
Phaneendra Manda | aec654c | 2015-09-23 19:02:23 +0530 | [diff] [blame] | 185 | for (final FlowEntry entry : flowEntries) { |
Thomas Vachuska | 8683e01 | 2015-03-18 18:03:33 -0700 | [diff] [blame] | 186 | flowsNode.add(codec(FlowEntry.class).encode(entry, this)); |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 187 | } |
Ray Milkey | 3f02569 | 2015-01-26 11:15:41 -0800 | [diff] [blame] | 188 | return ok(root).build(); |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 189 | } |
| 190 | |
| 191 | /** |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 192 | * Gets flow rules. Returns the flow entry specified by the device id and |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 193 | * flow rule id. |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 194 | * |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 195 | * @param deviceId device identifier |
| 196 | * @param flowId flow rule identifier |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 197 | * @return 200 OK with a collection of flows of given device and flow |
| 198 | * @onos.rsModel FlowEntries |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 199 | */ |
| 200 | @GET |
| 201 | @Produces(MediaType.APPLICATION_JSON) |
| 202 | @Path("{deviceId}/{flowId}") |
| 203 | public Response getFlowByDeviceIdAndFlowId(@PathParam("deviceId") String deviceId, |
| 204 | @PathParam("flowId") long flowId) { |
Phaneendra Manda | aec654c | 2015-09-23 19:02:23 +0530 | [diff] [blame] | 205 | final Iterable<FlowEntry> flowEntries = |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 206 | service.getFlowEntries(DeviceId.deviceId(deviceId)); |
| 207 | |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 208 | if (flowEntries == null || !flowEntries.iterator().hasNext()) { |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 209 | throw new ItemNotFoundException(DEVICE_NOT_FOUND); |
| 210 | } |
Phaneendra Manda | aec654c | 2015-09-23 19:02:23 +0530 | [diff] [blame] | 211 | for (final FlowEntry entry : flowEntries) { |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 212 | if (entry.id().value() == flowId) { |
Thomas Vachuska | 8683e01 | 2015-03-18 18:03:33 -0700 | [diff] [blame] | 213 | flowsNode.add(codec(FlowEntry.class).encode(entry, this)); |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 214 | } |
| 215 | } |
Ray Milkey | 3f02569 | 2015-01-26 11:15:41 -0800 | [diff] [blame] | 216 | return ok(root).build(); |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 217 | } |
Ray Milkey | d43fe45 | 2015-05-29 09:35:12 -0700 | [diff] [blame] | 218 | |
| 219 | /** |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 220 | * Gets flow rules generated by an application. |
| 221 | * Returns the flow rule specified by the application id. |
| 222 | * |
| 223 | * @param appId application identifier |
| 224 | * @return 200 OK with a collection of flows of given application id |
| 225 | * @onos.rsModel FlowRules |
| 226 | */ |
| 227 | @GET |
| 228 | @Produces(MediaType.APPLICATION_JSON) |
| 229 | @Path("application/{appId}") |
| 230 | public Response getFlowByAppId(@PathParam("appId") String appId) { |
| 231 | final ApplicationService appService = get(ApplicationService.class); |
| 232 | final ApplicationId idInstant = nullIsNotFound(appService.getId(appId), APP_ID_NOT_FOUND); |
Bharath Thiruveedula | 99849dc | 2016-11-17 22:04:38 +0530 | [diff] [blame] | 233 | final Iterable<FlowEntry> flowEntries = service.getFlowEntriesById(idInstant); |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 234 | |
Bharath Thiruveedula | 99849dc | 2016-11-17 22:04:38 +0530 | [diff] [blame] | 235 | flowEntries.forEach(flow -> flowsNode.add(codec(FlowEntry.class).encode(flow, this))); |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 236 | return ok(root).build(); |
| 237 | } |
| 238 | |
Bharath Thiruveedula | 99849dc | 2016-11-17 22:04:38 +0530 | [diff] [blame] | 239 | |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 240 | /** |
| 241 | * Removes flow rules by application ID. |
| 242 | * Removes a collection of flow rules generated by the given application. |
| 243 | * |
| 244 | * @param appId application identifier |
| 245 | * @return 204 NO CONTENT |
| 246 | */ |
| 247 | @DELETE |
| 248 | @Produces(MediaType.APPLICATION_JSON) |
| 249 | @Path("application/{appId}") |
| 250 | public Response removeFlowByAppId(@PathParam("appId") String appId) { |
| 251 | final ApplicationService appService = get(ApplicationService.class); |
| 252 | final ApplicationId idInstant = nullIsNotFound(appService.getId(appId), APP_ID_NOT_FOUND); |
| 253 | service.removeFlowRulesById(idInstant); |
| 254 | return Response.noContent().build(); |
| 255 | } |
| 256 | |
| 257 | /** |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 258 | * Creates new flow rule. Creates and installs a new flow rule for the |
Andrea Campanella | 881f29f | 2016-03-03 19:18:42 -0800 | [diff] [blame] | 259 | * specified device. <br> |
Jonathan Hart | f09a13a | 2017-01-26 09:52:14 -0800 | [diff] [blame] | 260 | * Flow rule criteria and instruction description: |
| 261 | * https://wiki.onosproject.org/display/ONOS/Flow+Rules |
Andrea Campanella | 881f29f | 2016-03-03 19:18:42 -0800 | [diff] [blame] | 262 | * |
Madan Jampani | 0dbac7a | 2015-06-25 10:37:45 -0700 | [diff] [blame] | 263 | * @param deviceId device identifier |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 264 | * @param appId application identifier |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 265 | * @param stream flow rule JSON |
Ray Milkey | eb5c717 | 2015-06-23 14:59:27 -0700 | [diff] [blame] | 266 | * @return status of the request - CREATED if the JSON is correct, |
Ray Milkey | d43fe45 | 2015-05-29 09:35:12 -0700 | [diff] [blame] | 267 | * BAD_REQUEST if the JSON is invalid |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 268 | * @onos.rsModel FlowsPost |
Ray Milkey | d43fe45 | 2015-05-29 09:35:12 -0700 | [diff] [blame] | 269 | */ |
| 270 | @POST |
Ray Milkey | eb5c717 | 2015-06-23 14:59:27 -0700 | [diff] [blame] | 271 | @Path("{deviceId}") |
Ray Milkey | d43fe45 | 2015-05-29 09:35:12 -0700 | [diff] [blame] | 272 | @Consumes(MediaType.APPLICATION_JSON) |
| 273 | @Produces(MediaType.APPLICATION_JSON) |
Ray Milkey | eb5c717 | 2015-06-23 14:59:27 -0700 | [diff] [blame] | 274 | public Response createFlow(@PathParam("deviceId") String deviceId, |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 275 | @QueryParam("appId") String appId, |
Ray Milkey | eb5c717 | 2015-06-23 14:59:27 -0700 | [diff] [blame] | 276 | InputStream stream) { |
Ray Milkey | d43fe45 | 2015-05-29 09:35:12 -0700 | [diff] [blame] | 277 | try { |
Ray Milkey | 86ee5e8 | 2018-04-02 15:33:07 -0700 | [diff] [blame] | 278 | ObjectNode jsonTree = readTreeFromStream(mapper(), stream); |
Ray Milkey | 5d915f4 | 2015-08-13 10:27:53 -0700 | [diff] [blame] | 279 | JsonNode specifiedDeviceId = jsonTree.get("deviceId"); |
Ray Milkey | eb5c717 | 2015-06-23 14:59:27 -0700 | [diff] [blame] | 280 | if (specifiedDeviceId != null && |
| 281 | !specifiedDeviceId.asText().equals(deviceId)) { |
| 282 | throw new IllegalArgumentException( |
| 283 | "Invalid deviceId in flow creation request"); |
| 284 | } |
Ray Milkey | 5d915f4 | 2015-08-13 10:27:53 -0700 | [diff] [blame] | 285 | jsonTree.put("deviceId", deviceId); |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 286 | |
Jonathan Hart | 9b80da8 | 2016-11-10 21:46:15 +0000 | [diff] [blame] | 287 | if (appId != null) { |
| 288 | jsonTree.put("appId", appId); |
| 289 | } |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 290 | |
Ray Milkey | 5d915f4 | 2015-08-13 10:27:53 -0700 | [diff] [blame] | 291 | FlowRule rule = codec(FlowRule.class).decode(jsonTree, this); |
Ray Milkey | d43fe45 | 2015-05-29 09:35:12 -0700 | [diff] [blame] | 292 | service.applyFlowRules(rule); |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 293 | UriBuilder locationBuilder = uriInfo.getBaseUriBuilder() |
| 294 | .path("flows") |
| 295 | .path(deviceId) |
Ray Milkey | 90289b0 | 2016-03-31 15:23:28 -0700 | [diff] [blame] | 296 | .path(Long.toString(rule.id().value())); |
Jian Li | 9d61649 | 2016-03-09 10:52:49 -0800 | [diff] [blame] | 297 | |
| 298 | return Response |
| 299 | .created(locationBuilder.build()) |
| 300 | .build(); |
| 301 | } catch (IOException ex) { |
Ray Milkey | 5d915f4 | 2015-08-13 10:27:53 -0700 | [diff] [blame] | 302 | throw new IllegalArgumentException(ex); |
Ray Milkey | d43fe45 | 2015-05-29 09:35:12 -0700 | [diff] [blame] | 303 | } |
Ray Milkey | eb5c717 | 2015-06-23 14:59:27 -0700 | [diff] [blame] | 304 | } |
| 305 | |
| 306 | /** |
Jian Li | 2907ad2 | 2016-05-12 23:08:54 -0700 | [diff] [blame] | 307 | * Removes flow rule. Removes the specified flow rule. |
Ray Milkey | eb5c717 | 2015-06-23 14:59:27 -0700 | [diff] [blame] | 308 | * |
Thomas Vachuska | 0fa2aa1 | 2015-08-18 12:53:04 -0700 | [diff] [blame] | 309 | * @param deviceId device identifier |
| 310 | * @param flowId flow rule identifier |
Jian Li | c2a542b | 2016-05-10 11:48:19 -0700 | [diff] [blame] | 311 | * @return 204 NO CONTENT |
Ray Milkey | eb5c717 | 2015-06-23 14:59:27 -0700 | [diff] [blame] | 312 | */ |
| 313 | @DELETE |
Ray Milkey | eb5c717 | 2015-06-23 14:59:27 -0700 | [diff] [blame] | 314 | @Path("{deviceId}/{flowId}") |
Jian Li | c2a542b | 2016-05-10 11:48:19 -0700 | [diff] [blame] | 315 | public Response deleteFlowByDeviceIdAndFlowId(@PathParam("deviceId") String deviceId, |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 316 | @PathParam("flowId") long flowId) { |
Phaneendra Manda | aec654c | 2015-09-23 19:02:23 +0530 | [diff] [blame] | 317 | final Iterable<FlowEntry> flowEntries = |
Ray Milkey | eb5c717 | 2015-06-23 14:59:27 -0700 | [diff] [blame] | 318 | service.getFlowEntries(DeviceId.deviceId(deviceId)); |
| 319 | |
Phaneendra Manda | aec654c | 2015-09-23 19:02:23 +0530 | [diff] [blame] | 320 | if (!flowEntries.iterator().hasNext()) { |
Ray Milkey | eb5c717 | 2015-06-23 14:59:27 -0700 | [diff] [blame] | 321 | throw new ItemNotFoundException(DEVICE_NOT_FOUND); |
| 322 | } |
| 323 | |
Phaneendra Manda | aec654c | 2015-09-23 19:02:23 +0530 | [diff] [blame] | 324 | StreamSupport.stream(flowEntries.spliterator(), false) |
Ray Milkey | eb5c717 | 2015-06-23 14:59:27 -0700 | [diff] [blame] | 325 | .filter(entry -> entry.id().value() == flowId) |
| 326 | .forEach(service::removeFlowRules); |
Jian Li | c2a542b | 2016-05-10 11:48:19 -0700 | [diff] [blame] | 327 | return Response.noContent().build(); |
Ray Milkey | d43fe45 | 2015-05-29 09:35:12 -0700 | [diff] [blame] | 328 | } |
| 329 | |
Ray Milkey | 460f9b0 | 2016-03-29 11:56:19 -0700 | [diff] [blame] | 330 | /** |
| 331 | * Removes a batch of flow rules. |
Ray Milkey | bee3509 | 2016-04-12 10:01:26 -0700 | [diff] [blame] | 332 | * |
| 333 | * @param stream stream for posted JSON |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 334 | * @return 204 NO CONTENT |
Ray Milkey | 460f9b0 | 2016-03-29 11:56:19 -0700 | [diff] [blame] | 335 | */ |
| 336 | @DELETE |
Jian Li | c2a542b | 2016-05-10 11:48:19 -0700 | [diff] [blame] | 337 | public Response deleteFlows(InputStream stream) { |
Ray Milkey | 460f9b0 | 2016-03-29 11:56:19 -0700 | [diff] [blame] | 338 | ListMultimap<DeviceId, Long> deviceMap = ArrayListMultimap.create(); |
| 339 | List<FlowEntry> rulesToRemove = new ArrayList<>(); |
| 340 | |
| 341 | try { |
Ray Milkey | 86ee5e8 | 2018-04-02 15:33:07 -0700 | [diff] [blame] | 342 | ObjectNode jsonTree = readTreeFromStream(mapper(), stream); |
Ray Milkey | 460f9b0 | 2016-03-29 11:56:19 -0700 | [diff] [blame] | 343 | |
| 344 | JsonNode jsonFlows = jsonTree.get("flows"); |
| 345 | |
| 346 | jsonFlows.forEach(node -> { |
| 347 | DeviceId deviceId = |
| 348 | DeviceId.deviceId( |
| 349 | nullIsNotFound(node.get(DEVICE_ID), |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 350 | DEVICE_NOT_FOUND).asText()); |
Ray Milkey | 460f9b0 | 2016-03-29 11:56:19 -0700 | [diff] [blame] | 351 | long flowId = nullIsNotFound(node.get(FLOW_ID), |
Jian Li | cc730a6 | 2016-05-10 16:36:16 -0700 | [diff] [blame] | 352 | FLOW_NOT_FOUND).asLong(); |
Ray Milkey | 460f9b0 | 2016-03-29 11:56:19 -0700 | [diff] [blame] | 353 | deviceMap.put(deviceId, flowId); |
| 354 | |
| 355 | }); |
| 356 | } catch (IOException ex) { |
| 357 | throw new IllegalArgumentException(ex); |
| 358 | } |
| 359 | |
| 360 | deviceMap.keySet().forEach(deviceId -> { |
| 361 | List<Long> flowIds = deviceMap.get(deviceId); |
| 362 | Iterable<FlowEntry> entries = service.getFlowEntries(deviceId); |
| 363 | flowIds.forEach(flowId -> { |
| 364 | StreamSupport.stream(entries.spliterator(), false) |
| 365 | .filter(entry -> flowId == entry.id().value()) |
| 366 | .forEach(rulesToRemove::add); |
| 367 | }); |
| 368 | }); |
| 369 | |
| 370 | service.removeFlowRules(rulesToRemove.toArray(new FlowEntry[0])); |
Jian Li | c2a542b | 2016-05-10 11:48:19 -0700 | [diff] [blame] | 371 | return Response.noContent().build(); |
Ray Milkey | 460f9b0 | 2016-03-29 11:56:19 -0700 | [diff] [blame] | 372 | } |
Ray Milkey | 4f5de00 | 2014-12-17 19:26:11 -0800 | [diff] [blame] | 373 | } |