Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [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 | |
| 17 | package org.onosproject.ui.impl; |
| 18 | |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 19 | import com.fasterxml.jackson.databind.node.ArrayNode; |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 20 | import com.fasterxml.jackson.databind.node.ObjectNode; |
Simon Hunt | abd16f6 | 2015-05-01 13:14:40 -0700 | [diff] [blame] | 21 | import com.google.common.base.Strings; |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 22 | import com.google.common.collect.ImmutableSet; |
Simon Hunt | 36b658d | 2017-07-14 16:20:11 -0700 | [diff] [blame] | 23 | import org.onosproject.app.ApplicationService; |
| 24 | import org.onosproject.core.Application; |
Viswanath KSP | d1212c7 | 2016-10-21 01:03:35 +0530 | [diff] [blame] | 25 | import org.onosproject.core.ApplicationId; |
| 26 | import org.onosproject.core.DefaultApplicationId; |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 27 | import org.onosproject.net.DeviceId; |
| 28 | import org.onosproject.net.flow.FlowEntry; |
Viswanath KSP | d1212c7 | 2016-10-21 01:03:35 +0530 | [diff] [blame] | 29 | import org.onosproject.net.flow.FlowRule; |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 30 | import org.onosproject.net.flow.FlowRuleService; |
Deepa Vaddireddy | f3932c0 | 2017-02-09 17:32:28 +0530 | [diff] [blame] | 31 | import org.onosproject.net.flow.TrafficTreatment; |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 32 | import org.onosproject.net.flow.criteria.Criterion; |
| 33 | import org.onosproject.net.flow.instructions.Instruction; |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 34 | import org.onosproject.net.flow.instructions.Instructions; |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 35 | import org.onosproject.ui.RequestHandler; |
Simon Hunt | a0ddb02 | 2015-05-01 09:53:01 -0700 | [diff] [blame] | 36 | import org.onosproject.ui.UiMessageHandler; |
Bri Prebilic Cole | 9467a23 | 2015-05-06 16:59:05 -0700 | [diff] [blame] | 37 | import org.onosproject.ui.table.CellFormatter; |
Simon Hunt | 3d1b065 | 2015-05-05 17:27:24 -0700 | [diff] [blame] | 38 | import org.onosproject.ui.table.TableModel; |
Simon Hunt | abd16f6 | 2015-05-01 13:14:40 -0700 | [diff] [blame] | 39 | import org.onosproject.ui.table.TableRequestHandler; |
Bri Prebilic Cole | 9467a23 | 2015-05-06 16:59:05 -0700 | [diff] [blame] | 40 | import org.onosproject.ui.table.cell.EnumFormatter; |
Simon Hunt | 3e4ccaf | 2016-01-12 19:59:54 -0800 | [diff] [blame] | 41 | import org.onosproject.ui.table.cell.HexLongFormatter; |
Simon Hunt | be60dde | 2016-01-13 12:26:56 -0800 | [diff] [blame] | 42 | import org.onosproject.ui.table.cell.NumberFormatter; |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 43 | |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 44 | import java.util.Collection; |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 45 | import java.util.List; |
Simon Hunt | 36b658d | 2017-07-14 16:20:11 -0700 | [diff] [blame] | 46 | import java.util.Map; |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 47 | import java.util.Set; |
Simon Hunt | 36b658d | 2017-07-14 16:20:11 -0700 | [diff] [blame] | 48 | import java.util.stream.Collectors; |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 49 | |
Deepa Vaddireddy | f3932c0 | 2017-02-09 17:32:28 +0530 | [diff] [blame] | 50 | |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 51 | /** |
| 52 | * Message handler for flow view related messages. |
| 53 | */ |
Simon Hunt | a0ddb02 | 2015-05-01 09:53:01 -0700 | [diff] [blame] | 54 | public class FlowViewMessageHandler extends UiMessageHandler { |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 55 | |
| 56 | private static final String FLOW_DATA_REQ = "flowDataRequest"; |
Simon Hunt | abd16f6 | 2015-05-01 13:14:40 -0700 | [diff] [blame] | 57 | private static final String FLOW_DATA_RESP = "flowDataResponse"; |
| 58 | private static final String FLOWS = "flows"; |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 59 | |
Viswanath KSP | d1212c7 | 2016-10-21 01:03:35 +0530 | [diff] [blame] | 60 | private static final String FLOW_DETAILS_REQ = "flowDetailsRequest"; |
| 61 | private static final String FLOW_DETAILS_RESP = "flowDetailsResponse"; |
| 62 | private static final String DETAILS = "details"; |
| 63 | private static final String FLOW_PRIORITY = "priority"; |
| 64 | |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 65 | private static final String DEV_ID = "devId"; |
| 66 | |
Simon Hunt | abd16f6 | 2015-05-01 13:14:40 -0700 | [diff] [blame] | 67 | private static final String ID = "id"; |
Viswanath KSP | d1212c7 | 2016-10-21 01:03:35 +0530 | [diff] [blame] | 68 | private static final String FLOW_ID = "flowId"; |
Simon Hunt | abd16f6 | 2015-05-01 13:14:40 -0700 | [diff] [blame] | 69 | private static final String APP_ID = "appId"; |
Simon Hunt | 36b658d | 2017-07-14 16:20:11 -0700 | [diff] [blame] | 70 | private static final String APP_NAME = "appName"; |
Simon Hunt | abd16f6 | 2015-05-01 13:14:40 -0700 | [diff] [blame] | 71 | private static final String GROUP_ID = "groupId"; |
| 72 | private static final String TABLE_ID = "tableId"; |
| 73 | private static final String PRIORITY = "priority"; |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 74 | private static final String SELECTOR_C = "selector_c"; // for table column |
Simon Hunt | abd16f6 | 2015-05-01 13:14:40 -0700 | [diff] [blame] | 75 | private static final String SELECTOR = "selector"; |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 76 | private static final String TREATMENT_C = "treatment_c"; // for table column |
Simon Hunt | abd16f6 | 2015-05-01 13:14:40 -0700 | [diff] [blame] | 77 | private static final String TREATMENT = "treatment"; |
| 78 | private static final String TIMEOUT = "timeout"; |
| 79 | private static final String PERMANENT = "permanent"; |
| 80 | private static final String STATE = "state"; |
Bri Prebilic Cole | 641b97b | 2015-05-05 14:47:40 -0700 | [diff] [blame] | 81 | private static final String PACKETS = "packets"; |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 82 | private static final String DURATION = "duration"; |
Bri Prebilic Cole | 641b97b | 2015-05-05 14:47:40 -0700 | [diff] [blame] | 83 | private static final String BYTES = "bytes"; |
Simon Hunt | abd16f6 | 2015-05-01 13:14:40 -0700 | [diff] [blame] | 84 | |
| 85 | private static final String COMMA = ", "; |
Viswanath KSP | 70e0d14 | 2016-10-28 21:58:32 +0530 | [diff] [blame] | 86 | private static final String OX = "0x"; |
| 87 | private static final String EMPTY = ""; |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 88 | private static final String SPACE = " "; |
| 89 | private static final String COLON = ":"; |
| 90 | private static final String ANGLE_O = "<"; |
| 91 | private static final String ANGLE_C = ">"; |
| 92 | private static final String SQUARE_O = "["; |
| 93 | private static final String SQUARE_C = "]"; |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 94 | |
Simon Hunt | 36b658d | 2017-07-14 16:20:11 -0700 | [diff] [blame] | 95 | private static final String ONOS_PREFIX = "org.onosproject."; |
| 96 | private static final String ONOS_MARKER = "*"; |
| 97 | |
Simon Hunt | f257a96 | 2017-08-25 18:58:47 -0700 | [diff] [blame^] | 98 | // json structure keys |
| 99 | private static final String IMMED = "immed"; |
| 100 | private static final String DEFER = "defer"; |
| 101 | private static final String METER = "meter"; |
| 102 | private static final String TABLE = "table"; |
| 103 | private static final String META = "meta"; |
| 104 | private static final String CLEARDEF = "clearDef"; |
| 105 | |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 106 | // TODO: replace the use of the following constants with localized text |
| 107 | private static final String MSG_NO_SELECTOR = |
| 108 | "(No traffic selector criteria for this flow)"; |
| 109 | private static final String MSG_NO_TREATMENT = |
| 110 | "(No traffic treatment instructions for this flow)"; |
| 111 | private static final String NO_ROWS_NO_FLOWS = "No flows found"; |
| 112 | |
| 113 | private static final String CRITERIA = "Criteria"; |
| 114 | private static final String TREATMENT_INSTRUCTIONS = "Treatment Instructions"; |
| 115 | private static final String IMM = "imm"; |
| 116 | private static final String DEF = "def"; |
| 117 | private static final String METERED = "metered"; |
| 118 | private static final String TRANSITION = "transition"; |
| 119 | private static final String METADATA = "metadata"; |
| 120 | private static final String CLEARED = "cleared"; |
| 121 | private static final String UNKNOWN = "Unknown"; |
| 122 | |
| 123 | |
Simon Hunt | 3d1b065 | 2015-05-05 17:27:24 -0700 | [diff] [blame] | 124 | private static final String[] COL_IDS = { |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 125 | ID, |
| 126 | STATE, |
| 127 | BYTES, |
| 128 | PACKETS, |
| 129 | DURATION, |
| 130 | PRIORITY, |
| 131 | TABLE_ID, |
| 132 | APP_ID, |
Simon Hunt | 36b658d | 2017-07-14 16:20:11 -0700 | [diff] [blame] | 133 | APP_NAME, |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 134 | |
| 135 | GROUP_ID, |
| 136 | TIMEOUT, |
| 137 | PERMANENT, |
| 138 | |
| 139 | SELECTOR_C, |
| 140 | SELECTOR, |
| 141 | TREATMENT_C, |
| 142 | TREATMENT, |
Simon Hunt | 3d1b065 | 2015-05-05 17:27:24 -0700 | [diff] [blame] | 143 | }; |
| 144 | |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 145 | @Override |
Simon Hunt | da58088 | 2015-05-12 20:58:18 -0700 | [diff] [blame] | 146 | protected Collection<RequestHandler> createRequestHandlers() { |
Viswanath KSP | d1212c7 | 2016-10-21 01:03:35 +0530 | [diff] [blame] | 147 | return ImmutableSet.of( |
| 148 | new FlowDataRequest(), |
| 149 | new DetailRequestHandler() |
| 150 | ); |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 151 | } |
| 152 | |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 153 | private void removeTrailingComma(StringBuilder sb) { |
Deepa Vaddireddy | f3932c0 | 2017-02-09 17:32:28 +0530 | [diff] [blame] | 154 | int pos = sb.lastIndexOf(COMMA); |
| 155 | sb.delete(pos, sb.length()); |
Deepa Vaddireddy | f3932c0 | 2017-02-09 17:32:28 +0530 | [diff] [blame] | 156 | } |
| 157 | |
Simon Hunt | 36b658d | 2017-07-14 16:20:11 -0700 | [diff] [blame] | 158 | // Generate a map of shorts->application IDs |
| 159 | // (working around deficiency(?) in Application Service API) |
| 160 | private Map<Short, ApplicationId> appShortMap() { |
| 161 | Set<Application> apps = |
| 162 | get(ApplicationService.class).getApplications(); |
| 163 | |
| 164 | return apps.stream() |
| 165 | .collect(Collectors.toMap(a -> a.id().id(), Application::id)); |
| 166 | } |
| 167 | |
| 168 | // Return an application name, based on a lookup of the internal short ID |
| 169 | private String makeAppName(short id, Map<Short, ApplicationId> lookup) { |
| 170 | ApplicationId appId = lookup.get(id); |
| 171 | if (appId == null) { |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 172 | return UNKNOWN + SPACE + ANGLE_O + id + ANGLE_C; |
Simon Hunt | 36b658d | 2017-07-14 16:20:11 -0700 | [diff] [blame] | 173 | } |
| 174 | String appName = appId.name(); |
| 175 | return appName.startsWith(ONOS_PREFIX) |
| 176 | ? appName.replaceFirst(ONOS_PREFIX, ONOS_MARKER) : appName; |
| 177 | } |
| 178 | |
Simon Hunt | abd16f6 | 2015-05-01 13:14:40 -0700 | [diff] [blame] | 179 | // handler for flow table requests |
| 180 | private final class FlowDataRequest extends TableRequestHandler { |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 181 | |
| 182 | private FlowDataRequest() { |
Simon Hunt | abd16f6 | 2015-05-01 13:14:40 -0700 | [diff] [blame] | 183 | super(FLOW_DATA_REQ, FLOW_DATA_RESP, FLOWS); |
Simon Hunt | d2747a0 | 2015-04-30 22:41:16 -0700 | [diff] [blame] | 184 | } |
| 185 | |
| 186 | @Override |
Simon Hunt | 3d1b065 | 2015-05-05 17:27:24 -0700 | [diff] [blame] | 187 | protected String[] getColumnIds() { |
| 188 | return COL_IDS; |
Simon Hunt | 44aa2f8 | 2015-04-30 15:01:35 -0700 | [diff] [blame] | 189 | } |
Simon Hunt | 44aa2f8 | 2015-04-30 15:01:35 -0700 | [diff] [blame] | 190 | |
Simon Hunt | 3d1b065 | 2015-05-05 17:27:24 -0700 | [diff] [blame] | 191 | @Override |
Jian Li | 8baf447 | 2016-01-15 15:08:09 -0800 | [diff] [blame] | 192 | protected String noRowsMessage(ObjectNode payload) { |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 193 | return NO_ROWS_NO_FLOWS; |
Jian Li | 69f6663 | 2016-01-15 12:27:42 -0800 | [diff] [blame] | 194 | } |
| 195 | |
| 196 | @Override |
Simon Hunt | 3d1b065 | 2015-05-05 17:27:24 -0700 | [diff] [blame] | 197 | protected TableModel createTableModel() { |
| 198 | TableModel tm = super.createTableModel(); |
Simon Hunt | 3e4ccaf | 2016-01-12 19:59:54 -0800 | [diff] [blame] | 199 | tm.setFormatter(ID, HexLongFormatter.INSTANCE); |
Simon Hunt | be60dde | 2016-01-13 12:26:56 -0800 | [diff] [blame] | 200 | tm.setFormatter(STATE, EnumFormatter.INSTANCE); |
Simon Hunt | be60dde | 2016-01-13 12:26:56 -0800 | [diff] [blame] | 201 | tm.setFormatter(BYTES, NumberFormatter.INTEGER); |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 202 | tm.setFormatter(PACKETS, NumberFormatter.INTEGER); |
| 203 | tm.setFormatter(DURATION, NumberFormatter.INTEGER); |
| 204 | |
| 205 | tm.setFormatter(SELECTOR_C, new SelectorShortFormatter()); |
Bri Prebilic Cole | 9467a23 | 2015-05-06 16:59:05 -0700 | [diff] [blame] | 206 | tm.setFormatter(SELECTOR, new SelectorFormatter()); |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 207 | tm.setFormatter(TREATMENT_C, new TreatmentShortFormatter()); |
Bri Prebilic Cole | 9467a23 | 2015-05-06 16:59:05 -0700 | [diff] [blame] | 208 | tm.setFormatter(TREATMENT, new TreatmentFormatter()); |
Simon Hunt | 3d1b065 | 2015-05-05 17:27:24 -0700 | [diff] [blame] | 209 | return tm; |
| 210 | } |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 211 | |
Simon Hunt | 3d1b065 | 2015-05-05 17:27:24 -0700 | [diff] [blame] | 212 | @Override |
| 213 | protected void populateTable(TableModel tm, ObjectNode payload) { |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 214 | String uri = string(payload, DEV_ID); |
Simon Hunt | 3d1b065 | 2015-05-05 17:27:24 -0700 | [diff] [blame] | 215 | if (!Strings.isNullOrEmpty(uri)) { |
| 216 | DeviceId deviceId = DeviceId.deviceId(uri); |
Simon Hunt | 36b658d | 2017-07-14 16:20:11 -0700 | [diff] [blame] | 217 | Map<Short, ApplicationId> lookup = appShortMap(); |
Simon Hunt | 3d1b065 | 2015-05-05 17:27:24 -0700 | [diff] [blame] | 218 | FlowRuleService frs = get(FlowRuleService.class); |
Simon Hunt | 36b658d | 2017-07-14 16:20:11 -0700 | [diff] [blame] | 219 | |
Simon Hunt | 3d1b065 | 2015-05-05 17:27:24 -0700 | [diff] [blame] | 220 | for (FlowEntry flow : frs.getFlowEntries(deviceId)) { |
Simon Hunt | 36b658d | 2017-07-14 16:20:11 -0700 | [diff] [blame] | 221 | populateRow(tm.addRow(), flow, lookup); |
Simon Hunt | 3d1b065 | 2015-05-05 17:27:24 -0700 | [diff] [blame] | 222 | } |
| 223 | } |
| 224 | } |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 225 | |
Simon Hunt | 36b658d | 2017-07-14 16:20:11 -0700 | [diff] [blame] | 226 | private void populateRow(TableModel.Row row, FlowEntry flow, |
| 227 | Map<Short, ApplicationId> lookup) { |
Simon Hunt | 3d1b065 | 2015-05-05 17:27:24 -0700 | [diff] [blame] | 228 | row.cell(ID, flow.id().value()) |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 229 | .cell(STATE, flow.state()) |
| 230 | .cell(BYTES, flow.bytes()) |
| 231 | .cell(PACKETS, flow.packets()) |
| 232 | .cell(DURATION, flow.life()) |
Simon Hunt | 8a0429a | 2017-01-06 16:52:47 -0800 | [diff] [blame] | 233 | .cell(PRIORITY, flow.priority()) |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 234 | .cell(TABLE_ID, flow.tableId()) |
| 235 | .cell(APP_ID, flow.appId()) |
Simon Hunt | 36b658d | 2017-07-14 16:20:11 -0700 | [diff] [blame] | 236 | .cell(APP_NAME, makeAppName(flow.appId(), lookup)) |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 237 | |
| 238 | .cell(GROUP_ID, flow.groupId().id()) |
Simon Hunt | 8a0429a | 2017-01-06 16:52:47 -0800 | [diff] [blame] | 239 | .cell(TIMEOUT, flow.timeout()) |
| 240 | .cell(PERMANENT, flow.isPermanent()) |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 241 | |
| 242 | .cell(SELECTOR_C, flow) |
Simon Hunt | 8a0429a | 2017-01-06 16:52:47 -0800 | [diff] [blame] | 243 | .cell(SELECTOR, flow) |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 244 | .cell(TREATMENT_C, flow) |
Simon Hunt | 8a0429a | 2017-01-06 16:52:47 -0800 | [diff] [blame] | 245 | .cell(TREATMENT, flow); |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 246 | } |
| 247 | |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 248 | private class InternalSelectorFormatter implements CellFormatter { |
| 249 | private final boolean shortFormat; |
| 250 | |
| 251 | InternalSelectorFormatter(boolean shortFormat) { |
| 252 | this.shortFormat = shortFormat; |
| 253 | } |
| 254 | |
Bri Prebilic Cole | 9467a23 | 2015-05-06 16:59:05 -0700 | [diff] [blame] | 255 | @Override |
| 256 | public String format(Object value) { |
| 257 | FlowEntry flow = (FlowEntry) value; |
| 258 | Set<Criterion> criteria = flow.selector().criteria(); |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 259 | |
Bri Prebilic Cole | 9467a23 | 2015-05-06 16:59:05 -0700 | [diff] [blame] | 260 | if (criteria.isEmpty()) { |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 261 | return MSG_NO_SELECTOR; |
Bri Prebilic Cole | 9467a23 | 2015-05-06 16:59:05 -0700 | [diff] [blame] | 262 | } |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 263 | |
| 264 | StringBuilder sb = new StringBuilder(); |
| 265 | if (!shortFormat) { |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 266 | sb.append(CRITERIA).append(COLON).append(SPACE); |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 267 | } |
| 268 | |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 269 | for (Criterion c : criteria) { |
Bri Prebilic Cole | 9467a23 | 2015-05-06 16:59:05 -0700 | [diff] [blame] | 270 | sb.append(c).append(COMMA); |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 271 | } |
| 272 | removeTrailingComma(sb); |
Bri Prebilic Cole | 9467a23 | 2015-05-06 16:59:05 -0700 | [diff] [blame] | 273 | |
| 274 | return sb.toString(); |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 275 | } |
| 276 | } |
| 277 | |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 278 | private final class SelectorShortFormatter extends InternalSelectorFormatter { |
| 279 | SelectorShortFormatter() { |
| 280 | super(true); |
| 281 | } |
| 282 | } |
| 283 | |
| 284 | private final class SelectorFormatter extends InternalSelectorFormatter { |
| 285 | SelectorFormatter() { |
| 286 | super(false); |
| 287 | } |
| 288 | } |
| 289 | |
| 290 | private class InternalTreatmentFormatter implements CellFormatter { |
| 291 | private final boolean shortFormat; |
| 292 | |
| 293 | InternalTreatmentFormatter(boolean shortFormat) { |
| 294 | this.shortFormat = shortFormat; |
| 295 | } |
| 296 | |
Bri Prebilic Cole | 9467a23 | 2015-05-06 16:59:05 -0700 | [diff] [blame] | 297 | @Override |
| 298 | public String format(Object value) { |
| 299 | FlowEntry flow = (FlowEntry) value; |
Deepa Vaddireddy | f3932c0 | 2017-02-09 17:32:28 +0530 | [diff] [blame] | 300 | TrafficTreatment treatment = flow.treatment(); |
| 301 | List<Instruction> imm = treatment.immediate(); |
| 302 | List<Instruction> def = treatment.deferred(); |
| 303 | if (imm.isEmpty() && |
| 304 | def.isEmpty() && |
| 305 | treatment.metered() == null && |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 306 | treatment.tableTransition() == null && |
| 307 | treatment.writeMetadata() == null) { |
| 308 | return MSG_NO_TREATMENT; |
Bri Prebilic Cole | 9467a23 | 2015-05-06 16:59:05 -0700 | [diff] [blame] | 309 | } |
Deepa Vaddireddy | f3932c0 | 2017-02-09 17:32:28 +0530 | [diff] [blame] | 310 | |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 311 | StringBuilder sb = new StringBuilder(); |
| 312 | |
| 313 | if (!shortFormat) { |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 314 | sb.append(TREATMENT_INSTRUCTIONS).append(COLON).append(SPACE); |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 315 | } |
| 316 | |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 317 | formatInstructs(sb, imm, IMM); |
| 318 | formatInstructs(sb, def, DEF); |
Deepa Vaddireddy | f3932c0 | 2017-02-09 17:32:28 +0530 | [diff] [blame] | 319 | |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 320 | addLabVal(sb, METERED, treatment.metered()); |
| 321 | addLabVal(sb, TRANSITION, treatment.tableTransition()); |
| 322 | addLabVal(sb, METADATA, treatment.writeMetadata()); |
Deepa Vaddireddy | f3932c0 | 2017-02-09 17:32:28 +0530 | [diff] [blame] | 323 | |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 324 | sb.append(CLEARED).append(COLON) |
| 325 | .append(treatment.clearedDeferred()); |
Bri Prebilic Cole | 9467a23 | 2015-05-06 16:59:05 -0700 | [diff] [blame] | 326 | |
| 327 | return sb.toString(); |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 328 | } |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 329 | |
| 330 | private void addLabVal(StringBuilder sb, String label, Instruction value) { |
| 331 | if (value != null) { |
| 332 | sb.append(label).append(COLON).append(value).append(COMMA); |
| 333 | } |
| 334 | } |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 335 | } |
| 336 | |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 337 | private final class TreatmentShortFormatter extends InternalTreatmentFormatter { |
| 338 | TreatmentShortFormatter() { |
| 339 | super(true); |
| 340 | } |
| 341 | } |
| 342 | |
| 343 | private final class TreatmentFormatter extends InternalTreatmentFormatter { |
| 344 | TreatmentFormatter() { |
| 345 | super(false); |
| 346 | } |
| 347 | } |
| 348 | |
Deepa Vaddireddy | f3932c0 | 2017-02-09 17:32:28 +0530 | [diff] [blame] | 349 | private void formatInstructs(StringBuilder sb, |
| 350 | List<Instruction> instructs, |
| 351 | String type) { |
| 352 | if (!instructs.isEmpty()) { |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 353 | sb.append(type).append(SQUARE_O); |
Deepa Vaddireddy | f3932c0 | 2017-02-09 17:32:28 +0530 | [diff] [blame] | 354 | for (Instruction i : instructs) { |
Simon Hunt | f257a96 | 2017-08-25 18:58:47 -0700 | [diff] [blame^] | 355 | sb.append(renderInstructionForDisplay(i)).append(COMMA); |
Deepa Vaddireddy | f3932c0 | 2017-02-09 17:32:28 +0530 | [diff] [blame] | 356 | } |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 357 | removeTrailingComma(sb); |
| 358 | sb.append(SQUARE_C).append(COMMA); |
Deepa Vaddireddy | f3932c0 | 2017-02-09 17:32:28 +0530 | [diff] [blame] | 359 | } |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 360 | } |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 361 | } |
Viswanath KSP | d1212c7 | 2016-10-21 01:03:35 +0530 | [diff] [blame] | 362 | |
| 363 | private final class DetailRequestHandler extends RequestHandler { |
| 364 | private DetailRequestHandler() { |
| 365 | super(FLOW_DETAILS_REQ); |
| 366 | } |
| 367 | |
Bharath Thiruveedula | 99849dc | 2016-11-17 22:04:38 +0530 | [diff] [blame] | 368 | private FlowEntry findFlowById(String appIdText, String flowId) { |
Viswanath KSP | 70e0d14 | 2016-10-28 21:58:32 +0530 | [diff] [blame] | 369 | String strippedFlowId = flowId.replaceAll(OX, EMPTY); |
Viswanath KSP | d1212c7 | 2016-10-21 01:03:35 +0530 | [diff] [blame] | 370 | FlowRuleService fs = get(FlowRuleService.class); |
| 371 | int appIdInt = Integer.parseInt(appIdText); |
Viswanath KSP | 70e0d14 | 2016-10-28 21:58:32 +0530 | [diff] [blame] | 372 | ApplicationId appId = new DefaultApplicationId(appIdInt, DETAILS); |
Bharath Thiruveedula | 99849dc | 2016-11-17 22:04:38 +0530 | [diff] [blame] | 373 | Iterable<FlowEntry> entries = fs.getFlowEntriesById(appId); |
Viswanath KSP | d1212c7 | 2016-10-21 01:03:35 +0530 | [diff] [blame] | 374 | |
Bharath Thiruveedula | 99849dc | 2016-11-17 22:04:38 +0530 | [diff] [blame] | 375 | for (FlowEntry entry : entries) { |
| 376 | if (entry.id().toString().equals(strippedFlowId)) { |
| 377 | return entry; |
Viswanath KSP | d1212c7 | 2016-10-21 01:03:35 +0530 | [diff] [blame] | 378 | } |
| 379 | } |
| 380 | |
| 381 | return null; |
| 382 | } |
| 383 | |
Viswanath KSP | 70e0d14 | 2016-10-28 21:58:32 +0530 | [diff] [blame] | 384 | private String decorateFlowId(FlowRule flow) { |
| 385 | return OX + flow.id(); |
| 386 | } |
| 387 | |
Viswanath KSP | ed55ecf | 2016-12-22 18:15:45 +0530 | [diff] [blame] | 388 | private String decorateGroupId(FlowRule flow) { |
| 389 | return OX + flow.groupId().id(); |
| 390 | } |
| 391 | |
Viswanath KSP | d1212c7 | 2016-10-21 01:03:35 +0530 | [diff] [blame] | 392 | @Override |
Simon Hunt | 8a0429a | 2017-01-06 16:52:47 -0800 | [diff] [blame] | 393 | public void process(ObjectNode payload) { |
Viswanath KSP | d1212c7 | 2016-10-21 01:03:35 +0530 | [diff] [blame] | 394 | |
| 395 | String flowId = string(payload, FLOW_ID); |
| 396 | String appId = string(payload, APP_ID); |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 397 | |
| 398 | FlowEntry flow = findFlowById(appId, flowId); |
Viswanath KSP | 70e0d14 | 2016-10-28 21:58:32 +0530 | [diff] [blame] | 399 | if (flow != null) { |
| 400 | ObjectNode data = objectNode(); |
Viswanath KSP | d1212c7 | 2016-10-21 01:03:35 +0530 | [diff] [blame] | 401 | |
Viswanath KSP | 70e0d14 | 2016-10-28 21:58:32 +0530 | [diff] [blame] | 402 | data.put(FLOW_ID, decorateFlowId(flow)); |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 403 | |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 404 | data.put(STATE, EnumFormatter.INSTANCE.format(flow.state())); |
| 405 | data.put(BYTES, NumberFormatter.INTEGER.format(flow.bytes())); |
| 406 | data.put(PACKETS, NumberFormatter.INTEGER.format(flow.packets())); |
| 407 | data.put(DURATION, NumberFormatter.INTEGER.format(flow.life())); |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 408 | |
Viswanath KSP | 70e0d14 | 2016-10-28 21:58:32 +0530 | [diff] [blame] | 409 | data.put(FLOW_PRIORITY, flow.priority()); |
Viswanath KSP | ed55ecf | 2016-12-22 18:15:45 +0530 | [diff] [blame] | 410 | data.put(TABLE_ID, flow.tableId()); |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 411 | data.put(APP_ID, flow.appId()); |
Simon Hunt | 36b658d | 2017-07-14 16:20:11 -0700 | [diff] [blame] | 412 | // NOTE: horribly inefficient... make a map and retrieve a single value... |
| 413 | data.put(APP_NAME, makeAppName(flow.appId(), appShortMap())); |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 414 | |
| 415 | data.put(GROUP_ID, decorateGroupId(flow)); |
Viswanath KSP | ed55ecf | 2016-12-22 18:15:45 +0530 | [diff] [blame] | 416 | data.put(TIMEOUT, flow.hardTimeout()); |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 417 | data.put(PERMANENT, flow.isPermanent()); |
Simon Hunt | 9bff595 | 2017-07-13 14:05:09 -0700 | [diff] [blame] | 418 | |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 419 | data.set(SELECTOR, jsonCriteria(flow)); |
| 420 | data.set(TREATMENT, jsonTreatment(flow)); |
Viswanath KSP | ed55ecf | 2016-12-22 18:15:45 +0530 | [diff] [blame] | 421 | |
Viswanath KSP | 70e0d14 | 2016-10-28 21:58:32 +0530 | [diff] [blame] | 422 | ObjectNode rootNode = objectNode(); |
| 423 | rootNode.set(DETAILS, data); |
| 424 | sendMessage(FLOW_DETAILS_RESP, rootNode); |
| 425 | } |
Viswanath KSP | d1212c7 | 2016-10-21 01:03:35 +0530 | [diff] [blame] | 426 | } |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 427 | |
| 428 | private ArrayNode jsonCriteria(FlowEntry flow) { |
| 429 | ArrayNode crits = arrayNode(); |
| 430 | for (Criterion c : flow.selector().criteria()) { |
| 431 | crits.add(c.toString()); |
| 432 | } |
| 433 | return crits; |
| 434 | } |
| 435 | |
| 436 | private ObjectNode jsonTreatment(FlowEntry flow) { |
| 437 | ObjectNode treat = objectNode(); |
| 438 | TrafficTreatment treatment = flow.treatment(); |
| 439 | List<Instruction> imm = treatment.immediate(); |
| 440 | List<Instruction> def = treatment.deferred(); |
| 441 | Instructions.MeterInstruction meter = treatment.metered(); |
| 442 | Instructions.TableTypeTransition table = treatment.tableTransition(); |
| 443 | Instructions.MetadataInstruction meta = treatment.writeMetadata(); |
| 444 | |
| 445 | if (!imm.isEmpty()) { |
| 446 | treat.set(IMMED, jsonInstrList(imm)); |
| 447 | } |
| 448 | if (!def.isEmpty()) { |
| 449 | treat.set(DEFER, jsonInstrList(def)); |
| 450 | } |
| 451 | if (meter != null) { |
| 452 | treat.put(METER, meter.toString()); |
| 453 | } |
| 454 | if (table != null) { |
| 455 | treat.put(TABLE, table.toString()); |
| 456 | } |
| 457 | if (meta != null) { |
| 458 | treat.put(META, meta.toString()); |
| 459 | } |
| 460 | treat.put(CLEARDEF, treatment.clearedDeferred()); |
| 461 | return treat; |
| 462 | } |
| 463 | |
| 464 | private ArrayNode jsonInstrList(List<Instruction> instructions) { |
| 465 | ArrayNode array = arrayNode(); |
| 466 | for (Instruction i : instructions) { |
Simon Hunt | f257a96 | 2017-08-25 18:58:47 -0700 | [diff] [blame^] | 467 | array.add(renderInstructionForDisplay(i)); |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 468 | } |
| 469 | return array; |
| 470 | } |
Viswanath KSP | d1212c7 | 2016-10-21 01:03:35 +0530 | [diff] [blame] | 471 | } |
Simon Hunt | 8f057ee | 2017-07-19 14:05:26 -0700 | [diff] [blame] | 472 | |
Simon Hunt | f257a96 | 2017-08-25 18:58:47 -0700 | [diff] [blame^] | 473 | // package private to allow unit test access... |
| 474 | String renderInstructionForDisplay(Instruction instr) { |
| 475 | |
| 476 | // special handling for Extension Instruction Wrappers... |
| 477 | if (instr instanceof Instructions.ExtensionInstructionWrapper) { |
| 478 | Instructions.ExtensionInstructionWrapper wrap = |
| 479 | (Instructions.ExtensionInstructionWrapper) instr; |
| 480 | return wrap.type() + COLON + wrap.extensionInstruction(); |
| 481 | } |
| 482 | |
| 483 | // special handling of other instruction classes could be placed here |
| 484 | |
| 485 | // default to the natural string representation otherwise |
| 486 | return instr.toString(); |
| 487 | } |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 488 | } |