Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-present 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.roadm; |
| 17 | |
| 18 | import com.fasterxml.jackson.databind.node.ObjectNode; |
| 19 | import com.google.common.collect.ImmutableSet; |
| 20 | import com.google.common.collect.Range; |
| 21 | import org.onlab.osgi.ServiceDirectory; |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 22 | import org.onlab.util.Frequency; |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 23 | import org.onosproject.net.AnnotationKeys; |
| 24 | import org.onosproject.net.DeviceId; |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 25 | import org.onosproject.net.device.DeviceService; |
| 26 | import org.onosproject.net.OchSignal; |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 27 | import org.onosproject.net.Port; |
| 28 | import org.onosproject.net.PortNumber; |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 29 | import org.onosproject.ui.RequestHandler; |
| 30 | import org.onosproject.ui.UiConnection; |
| 31 | import org.onosproject.ui.UiMessageHandler; |
| 32 | import org.onosproject.ui.table.TableModel; |
| 33 | import org.onosproject.ui.table.TableRequestHandler; |
| 34 | import org.slf4j.Logger; |
| 35 | import org.slf4j.LoggerFactory; |
| 36 | |
| 37 | import java.util.Collection; |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 38 | import java.util.Collections; |
| 39 | import java.util.Comparator; |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 40 | import java.util.List; |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 41 | import java.util.Set; |
| 42 | |
| 43 | import static org.onosproject.net.Device.Type; |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 44 | |
| 45 | /** |
| 46 | * Table-View message handler for ROADM port view. |
| 47 | */ |
| 48 | public class RoadmPortViewMessageHandler extends UiMessageHandler { |
| 49 | |
| 50 | private static final String ROADM_PORT_DATA_REQ = "roadmPortDataRequest"; |
| 51 | private static final String ROADM_PORT_DATA_RESP = "roadmPortDataResponse"; |
| 52 | private static final String ROADM_PORTS = "roadmPorts"; |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 53 | private static final String ROADM_SET_TARGET_POWER_REQ = "roadmSetTargetPowerRequest"; |
| 54 | private static final String ROADM_SET_TARGET_POWER_RESP = "roadmSetTargetPowerResponse"; |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 55 | private static final String ROADM_SHOW_ITEMS_REQ = "roadmShowPortItemsRequest"; |
| 56 | private static final String ROADM_SHOW_ITEMS_RESP = "roadmShowPortItemsResponse"; |
| 57 | private static final String ROADM_SET_OPS_MODE_REQ = "roadmSetOpsModeRequest"; |
| 58 | private static final String ROADM_SET_OPS_MODE_RESP = "roadmSetOpsModeResponse"; |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 59 | |
| 60 | private static final String ID = "id"; |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 61 | private static final String NAME = "name"; |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 62 | private static final String TYPE = "type"; |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 63 | private static final String ENABLED = "enabled"; |
| 64 | private static final String MIN_FREQ = "minFreq"; |
| 65 | private static final String MAX_FREQ = "maxFreq"; |
| 66 | private static final String GRID = "grid"; |
| 67 | private static final String INPUT_POWER_RANGE = "inputPowerRange"; |
| 68 | private static final String CURRENT_POWER = "currentPower"; |
| 69 | private static final String TARGET_POWER = "targetPower"; |
| 70 | private static final String HAS_TARGET_POWER = "hasTargetPower"; |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 71 | private static final String SERVICE_STATE = "serviceState"; |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 72 | |
| 73 | private static final String[] COLUMN_IDS = { |
| 74 | ID, TYPE, NAME, ENABLED, MIN_FREQ, MAX_FREQ, GRID, INPUT_POWER_RANGE, |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 75 | CURRENT_POWER, SERVICE_STATE, TARGET_POWER, HAS_TARGET_POWER |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 76 | }; |
| 77 | |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 78 | private RoadmService roadmService; |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 79 | private DeviceService deviceService; |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 80 | |
| 81 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 82 | |
| 83 | @Override |
| 84 | public void init(UiConnection connection, ServiceDirectory directory) { |
| 85 | super.init(connection, directory); |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 86 | roadmService = get(RoadmService.class); |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 87 | deviceService = get(DeviceService.class); |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 88 | } |
| 89 | |
| 90 | @Override |
| 91 | protected Collection<RequestHandler> createRequestHandlers() { |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 92 | return ImmutableSet.of(new PortTableDataRequestHandler(), |
| 93 | new SetTargetPowerRequestHandler(), |
| 94 | new CreateShowItemsRequestHandler(), |
| 95 | new CreateOpsModeSetRequestHandler() |
| 96 | ); |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 97 | } |
| 98 | |
| 99 | // Handler for sample table requests |
| 100 | private final class PortTableDataRequestHandler extends TableRequestHandler { |
| 101 | |
| 102 | private PortTableDataRequestHandler() { |
| 103 | super(ROADM_PORT_DATA_REQ, ROADM_PORT_DATA_RESP, ROADM_PORTS); |
| 104 | } |
| 105 | |
| 106 | @Override |
| 107 | protected String[] getColumnIds() { |
| 108 | return COLUMN_IDS; |
| 109 | } |
| 110 | |
| 111 | @Override |
| 112 | protected String noRowsMessage(ObjectNode payload) { |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 113 | return RoadmUtil.NO_ROWS_MESSAGE; |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | @Override |
| 117 | protected void populateTable(TableModel tm, ObjectNode payload) { |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 118 | DeviceId deviceId = DeviceId.deviceId(string(payload, RoadmUtil.DEV_ID)); |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 119 | if (deviceService.isAvailable(deviceId)) { |
| 120 | List<Port> ports = deviceService.getPorts(deviceId); |
| 121 | for (Port port : ports) { |
| 122 | populateRow(tm.addRow(), port, deviceId); |
| 123 | } |
| 124 | } |
| 125 | } |
| 126 | |
| 127 | private void populateRow(TableModel.Row row, Port port, DeviceId deviceId) { |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 128 | PortNumber portNum = port.number(); |
| 129 | getFrequencyLimit(deviceId, portNum); |
| 130 | row.cell(ID, portNum.toLong()) |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 131 | .cell(TYPE, port.type()) |
| 132 | .cell(ENABLED, port.isEnabled()) |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 133 | .cell(NAME, RoadmUtil.getAnnotation(port.annotations(), AnnotationKeys.PORT_NAME)) |
| 134 | .cell(MIN_FREQ, RoadmUtil.asTHz(minFreq)) |
| 135 | .cell(MAX_FREQ, RoadmUtil.asTHz(maxFreq)) |
| 136 | .cell(GRID, RoadmUtil.asGHz(channelSpacing)) |
| 137 | .cell(INPUT_POWER_RANGE, getInputPowerRange(deviceId, portNum)) |
| 138 | .cell(CURRENT_POWER, getCurrentPower(deviceId, portNum)) |
| 139 | .cell(SERVICE_STATE, getPortServiceState(deviceId, portNum)) |
| 140 | .cell(TARGET_POWER, getTargetPower(deviceId, portNum)) |
| 141 | .cell(HAS_TARGET_POWER, roadmService.hasPortTargetPower(deviceId, portNum)); |
| 142 | } |
| 143 | |
| 144 | private String getPortServiceState(DeviceId deviceId, PortNumber portNumber) { |
| 145 | return RoadmUtil.defaultString( |
| 146 | roadmService.getProtectionSwitchPortState(deviceId, portNumber), |
| 147 | RoadmUtil.UNKNOWN); |
| 148 | } |
| 149 | |
| 150 | private Frequency minFreq = null, maxFreq = null, channelSpacing = null; |
| 151 | // Gets min frequency, max frequency, channel spacing |
| 152 | private void getFrequencyLimit(DeviceId deviceId, PortNumber portNumber) { |
| 153 | Set<OchSignal> signals = roadmService.queryLambdas(deviceId, portNumber); |
| 154 | if (signals.isEmpty()) { |
| 155 | return; |
| 156 | } |
| 157 | Comparator<OchSignal> compare = |
| 158 | (OchSignal a, OchSignal b) -> a.spacingMultiplier() - b.spacingMultiplier(); |
| 159 | OchSignal minOch = Collections.min(signals, compare); |
| 160 | OchSignal maxOch = Collections.max(signals, compare); |
| 161 | minFreq = minOch.centralFrequency(); |
| 162 | maxFreq = maxOch.centralFrequency(); |
| 163 | channelSpacing = minOch.channelSpacing().frequency(); |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 164 | } |
| 165 | |
| 166 | // Returns the input power range as a string, N/A if the port is not an |
| 167 | // input port |
| 168 | private String getInputPowerRange(DeviceId deviceId, PortNumber portNumber) { |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 169 | Range<Long> range = roadmService.inputPortPowerRange(deviceId, portNumber); |
| 170 | return RoadmUtil.objectToString(range, RoadmUtil.NA); |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | // Returns the current power as a string, Unknown if no value can be found. |
| 174 | private String getCurrentPower(DeviceId deviceId, PortNumber portNumber) { |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 175 | Long currentPower = roadmService.getCurrentPortPower(deviceId, portNumber); |
| 176 | return RoadmUtil.objectToString(currentPower, RoadmUtil.UNKNOWN); |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 177 | } |
| 178 | |
| 179 | // Returns target power as a string, Unknown if target power is expected but |
| 180 | // cannot be found, N/A if port does not have configurable target power |
| 181 | private String getTargetPower(DeviceId deviceId, PortNumber portNumber) { |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 182 | if (!roadmService.hasPortTargetPower(deviceId, portNumber)) { |
| 183 | return RoadmUtil.NA; |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 184 | } |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 185 | Long targetPower = roadmService.getTargetPortPower(deviceId, portNumber); |
| 186 | return RoadmUtil.objectToString(targetPower, RoadmUtil.UNKNOWN); |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 187 | } |
| 188 | } |
| 189 | |
| 190 | |
| 191 | // Handler for setting port target power |
| 192 | private final class SetTargetPowerRequestHandler extends RequestHandler { |
| 193 | |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 194 | private static final String TARGET_POWER_ERR_MSG = "Target power range is %s."; |
| 195 | |
| 196 | private SetTargetPowerRequestHandler() { |
| 197 | super(ROADM_SET_TARGET_POWER_REQ); |
| 198 | } |
| 199 | |
| 200 | @Override |
| 201 | public void process(ObjectNode payload) { |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 202 | DeviceId deviceId = DeviceId.deviceId(string(payload, RoadmUtil.DEV_ID)); |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 203 | PortNumber portNumber = PortNumber.portNumber(payload.get(ID).asLong()); |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 204 | Range<Long> range = roadmService.targetPortPowerRange(deviceId, portNumber); |
| 205 | if (range == null) { |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 206 | log.warn("Unable to determine target power range for device {}", deviceId); |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 207 | return; |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 208 | } |
MaoLu | 937cf42 | 2017-03-03 23:31:46 -0800 | [diff] [blame^] | 209 | Long targetPower = payload.get(TARGET_POWER).asLong(); |
| 210 | boolean validTargetPower = range.contains(targetPower); |
| 211 | if (validTargetPower) { |
| 212 | roadmService.setTargetPortPower(deviceId, portNumber, targetPower); |
| 213 | } |
| 214 | ObjectNode rootNode = objectNode(); |
| 215 | rootNode.put(ID, payload.get(ID).asText()); |
| 216 | rootNode.put(RoadmUtil.VALID, validTargetPower); |
| 217 | rootNode.put(RoadmUtil.MESSAGE, String.format(TARGET_POWER_ERR_MSG, range.toString())); |
| 218 | sendMessage(ROADM_SET_TARGET_POWER_RESP, rootNode); |
| 219 | } |
| 220 | } |
| 221 | |
| 222 | private final class CreateShowItemsRequestHandler extends RequestHandler { |
| 223 | private static final String SHOW_TARGET_POWER = "showTargetPower"; |
| 224 | private static final String SHOW_SERVICE_STATE = "showServiceState"; |
| 225 | private static final String SHOW_FLOW_ICON = "showFlowIcon"; |
| 226 | |
| 227 | private CreateShowItemsRequestHandler() { |
| 228 | super(ROADM_SHOW_ITEMS_REQ); |
| 229 | } |
| 230 | |
| 231 | @Override |
| 232 | public void process(ObjectNode payload) { |
| 233 | DeviceId did = DeviceId.deviceId(string(payload, RoadmUtil.DEV_ID)); |
| 234 | Type devType = deviceService.getDevice(did).type(); |
| 235 | // Build response |
| 236 | ObjectNode node = objectNode(); |
| 237 | node.put(SHOW_TARGET_POWER, devType != Type.FIBER_SWITCH); |
| 238 | node.put(SHOW_SERVICE_STATE, devType == Type.FIBER_SWITCH); |
| 239 | node.put(SHOW_FLOW_ICON, devType == Type.ROADM); |
| 240 | sendMessage(ROADM_SHOW_ITEMS_RESP, node); |
| 241 | } |
| 242 | } |
| 243 | |
| 244 | private final class CreateOpsModeSetRequestHandler extends RequestHandler { |
| 245 | private static final String OPS_SWITCH_INDEX = "index"; |
| 246 | private static final String DEVICE_INVALID_ERR_MSG = "Apply failed: device is offline or unavailable."; |
| 247 | private static final String TYPE_INVALID_ERR_MSG = "Apply failed: invalid device type."; |
| 248 | |
| 249 | private CreateOpsModeSetRequestHandler() { |
| 250 | super(ROADM_SET_OPS_MODE_REQ); |
| 251 | } |
| 252 | |
| 253 | @Override |
| 254 | public void process(ObjectNode payload) { |
| 255 | DeviceId did = DeviceId.deviceId(string(payload, RoadmUtil.DEV_ID)); |
| 256 | ObjectNode node = objectNode(); |
| 257 | if (!deviceService.isAvailable(did)) { |
| 258 | node.put(RoadmUtil.VALID, false); |
| 259 | node.put(RoadmUtil.MESSAGE, DEVICE_INVALID_ERR_MSG); |
| 260 | sendMessage(ROADM_SET_OPS_MODE_RESP, node); |
| 261 | return; |
| 262 | } |
| 263 | Type devType = deviceService.getDevice(did).type(); |
| 264 | if (devType != Type.FIBER_SWITCH) { |
| 265 | node.put(RoadmUtil.VALID, false); |
| 266 | node.put(RoadmUtil.MESSAGE, TYPE_INVALID_ERR_MSG); |
| 267 | sendMessage(ROADM_SET_OPS_MODE_RESP, node); |
| 268 | return; |
| 269 | } |
| 270 | // get virtual port and switch port from payload |
| 271 | roadmService.setProtectionSwitchWorkingPath(did, (int) number(payload, OPS_SWITCH_INDEX)); |
| 272 | node.put(RoadmUtil.VALID, true); |
| 273 | sendMessage(ROADM_SET_OPS_MODE_RESP, node); |
Jimmy Yan | da878fc | 2016-09-02 16:32:01 -0700 | [diff] [blame] | 274 | } |
| 275 | } |
| 276 | } |