janani b | f7060cd | 2017-03-28 19:06:30 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2017-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 | |
| 17 | package org.onosproject.drivers.huawei; |
| 18 | |
Gaurav Agrawal | 9912f29 | 2017-03-30 01:22:40 +0530 | [diff] [blame] | 19 | import com.google.common.collect.Lists; |
janani b | f7060cd | 2017-03-28 19:06:30 +0530 | [diff] [blame] | 20 | import org.dom4j.Document; |
| 21 | import org.dom4j.DocumentException; |
| 22 | import org.dom4j.DocumentHelper; |
| 23 | import org.dom4j.Element; |
| 24 | import org.onosproject.net.DefaultAnnotations; |
Gaurav Agrawal | 9912f29 | 2017-03-30 01:22:40 +0530 | [diff] [blame] | 25 | import org.onosproject.net.DeviceId; |
janani b | f7060cd | 2017-03-28 19:06:30 +0530 | [diff] [blame] | 26 | import org.onosproject.net.device.DefaultPortDescription; |
Gaurav Agrawal | 9912f29 | 2017-03-30 01:22:40 +0530 | [diff] [blame] | 27 | import org.onosproject.net.device.DefaultPortStatistics; |
janani b | f7060cd | 2017-03-28 19:06:30 +0530 | [diff] [blame] | 28 | import org.onosproject.net.device.PortDescription; |
Gaurav Agrawal | 9912f29 | 2017-03-30 01:22:40 +0530 | [diff] [blame] | 29 | import org.onosproject.net.device.PortStatistics; |
janani b | f7060cd | 2017-03-28 19:06:30 +0530 | [diff] [blame] | 30 | |
| 31 | import java.util.ArrayList; |
| 32 | import java.util.Arrays; |
Gaurav Agrawal | 9912f29 | 2017-03-30 01:22:40 +0530 | [diff] [blame] | 33 | import java.util.Collection; |
janani b | f7060cd | 2017-03-28 19:06:30 +0530 | [diff] [blame] | 34 | import java.util.Iterator; |
| 35 | import java.util.List; |
| 36 | |
| 37 | import static org.onosproject.net.AnnotationKeys.PORT_NAME; |
| 38 | import static org.onosproject.net.Port.Type.COPPER; |
| 39 | import static org.onosproject.net.PortNumber.portNumber; |
| 40 | |
| 41 | /** |
Gaurav Agrawal | 9912f29 | 2017-03-30 01:22:40 +0530 | [diff] [blame] | 42 | * Representation of Huawei XML parser. |
janani b | f7060cd | 2017-03-28 19:06:30 +0530 | [diff] [blame] | 43 | */ |
Gaurav Agrawal | 9912f29 | 2017-03-30 01:22:40 +0530 | [diff] [blame] | 44 | public final class HuaweiXmlParser { |
janani b | f7060cd | 2017-03-28 19:06:30 +0530 | [diff] [blame] | 45 | |
| 46 | private static final String DATA = "data"; |
| 47 | private static final String IFM = "ifm"; |
| 48 | private static final String IFS = "interfaces"; |
| 49 | private static final String IF = "interface"; |
| 50 | private static final String IF_TYPE = "ifPhyType"; |
Gaurav Agrawal | 9912f29 | 2017-03-30 01:22:40 +0530 | [diff] [blame] | 51 | private static final String IF_STATS = "ifStatistics"; |
janani b | f7060cd | 2017-03-28 19:06:30 +0530 | [diff] [blame] | 52 | private static final String IF_STAT = "ifPhyStatus"; |
| 53 | private static final String IF_NUM = "ifNumber"; |
| 54 | private static final String IF_SPEED = "ifOperSpeed"; |
| 55 | private static final String IF_NAME = "ifName"; |
| 56 | private static final String UP = "up"; |
| 57 | private static final String DYN_INFO = "ifDynamicInfo"; |
| 58 | private static final String DELIMITER = "/"; |
| 59 | private static final String SYS = "system"; |
| 60 | private static final String SYS_INFO = "systemInfo"; |
| 61 | private static final String SYS_NAME = "sysName"; |
| 62 | private static final String PDT_VER = "productVer"; |
| 63 | private static final String PLATFORM_VER = "platformVer"; |
| 64 | private static final String SYS_ID = "sysObjectId"; |
Gaurav Agrawal | 9912f29 | 2017-03-30 01:22:40 +0530 | [diff] [blame] | 65 | private static final String P_RCVD = "receivePacket"; |
| 66 | private static final String P_SENT = "sendPacket"; |
| 67 | private static final String B_RCVD = "receiveByte"; |
| 68 | private static final String B_SENT = "sendByte"; |
| 69 | private static final String RX_DROP = "rcvDropPacket"; |
| 70 | private static final String TX_DROP = "sendDropPacket"; |
| 71 | private static final String RX_ERROR = "rcvErrorPacket"; |
| 72 | private static final String TX_ERROR = "sendErrorPacket"; |
janani b | f7060cd | 2017-03-28 19:06:30 +0530 | [diff] [blame] | 73 | |
| 74 | private static final String DEV_PARSE_ERR = "Unable to parse the received" + |
| 75 | " xml reply for system details from the huawei device"; |
| 76 | private static final String INT_PARSE_ERR = "Unable to parse the received" + |
| 77 | " xml reply for interface details from the huawei device"; |
| 78 | private static final String P_NAME_INVALID = "Invalid port name."; |
| 79 | |
| 80 | //TODO: All type of interfaces has to be added. |
| 81 | private static final List INTERFACES = Arrays.asList( |
Vidyashree Rama | d89a153 | 2017-03-30 15:13:52 +0530 | [diff] [blame] | 82 | "MEth", "Ethernet", "POS", "GigabitEthernet"); |
janani b | f7060cd | 2017-03-28 19:06:30 +0530 | [diff] [blame] | 83 | |
| 84 | private List<PortDescription> ports = new ArrayList<>(); |
| 85 | private String xml; |
| 86 | private int portInc; |
| 87 | private String[] info = new String[4]; |
| 88 | |
| 89 | /** |
| 90 | * Constructs huawei XML parser with xml reply. |
| 91 | * |
| 92 | * @param xml xml reply |
| 93 | */ |
| 94 | public HuaweiXmlParser(String xml) { |
| 95 | this.xml = xml; |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Returns the system info. |
| 100 | * |
| 101 | * @return system info |
| 102 | */ |
| 103 | String[] getInfo() { |
| 104 | return info; |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Returns the port list. |
| 109 | * |
| 110 | * @return port list |
| 111 | */ |
| 112 | List<PortDescription> getPorts() { |
| 113 | return ports; |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Parses system info xml reply. |
| 118 | */ |
| 119 | void parseSysInfo() { |
| 120 | Document doc; |
| 121 | try { |
| 122 | doc = DocumentHelper.parseText(xml); |
| 123 | } catch (DocumentException e) { |
| 124 | throw new IllegalArgumentException(DEV_PARSE_ERR); |
| 125 | } |
| 126 | |
| 127 | Element root = doc.getRootElement(); |
| 128 | Element parent = root.element(DATA).element(SYS).element(SYS_INFO); |
| 129 | info[0] = parent.element(SYS_NAME).getText(); |
| 130 | info[1] = parent.element(PDT_VER).getText(); |
| 131 | info[2] = parent.element(PLATFORM_VER).getText(); |
| 132 | info[3] = parent.element(SYS_ID).getText(); |
| 133 | } |
| 134 | |
| 135 | /** |
| 136 | * Parses interface xml reply and creates ports to be updated. |
| 137 | */ |
| 138 | void parseInterfaces() { |
Gaurav Agrawal | 9912f29 | 2017-03-30 01:22:40 +0530 | [diff] [blame] | 139 | Iterator itr = getInterfaceIterator(); |
| 140 | while (itr.hasNext()) { |
| 141 | Element ifElement = (Element) itr.next(); |
| 142 | addPorts(ifElement); |
| 143 | } |
| 144 | } |
| 145 | |
| 146 | private Iterator getInterfaceIterator() { |
janani b | f7060cd | 2017-03-28 19:06:30 +0530 | [diff] [blame] | 147 | Document doc; |
| 148 | try { |
| 149 | doc = DocumentHelper.parseText(xml); |
| 150 | } catch (DocumentException e) { |
| 151 | throw new IllegalArgumentException(INT_PARSE_ERR); |
| 152 | } |
| 153 | Element root = doc.getRootElement(); |
| 154 | Element parent = root.element(DATA).element(IFM).element(IFS); |
Gaurav Agrawal | 9912f29 | 2017-03-30 01:22:40 +0530 | [diff] [blame] | 155 | return parent.elementIterator(IF); |
janani b | f7060cd | 2017-03-28 19:06:30 +0530 | [diff] [blame] | 156 | } |
| 157 | |
| 158 | /** |
| 159 | * Adds port information to the port list from the xml reply. |
| 160 | * |
| 161 | * @param ifElement interface element |
| 162 | */ |
| 163 | private void addPorts(Element ifElement) { |
| 164 | String ifType = ifElement.element(IF_TYPE).getText(); |
| 165 | |
| 166 | if (INTERFACES.contains(ifType)) { |
| 167 | Element info = ifElement.element(DYN_INFO); |
| 168 | String status = info.element(IF_STAT).getText(); |
| 169 | String port = getPortNum(ifElement.element(IF_NUM).getText()); |
| 170 | String speed = info.element(IF_SPEED).getText(); |
| 171 | String ifName = ifElement.element(IF_NAME).getText(); |
| 172 | |
| 173 | boolean isEnabled = false; |
| 174 | if (status.equals(UP)) { |
| 175 | isEnabled = true; |
| 176 | } |
| 177 | |
| 178 | Long portSpeed = 0L; |
| 179 | if (!speed.isEmpty()) { |
| 180 | portSpeed = Long.valueOf(speed); |
| 181 | } |
| 182 | |
| 183 | DefaultAnnotations annotations = DefaultAnnotations.builder() |
| 184 | .set(PORT_NAME, ifName).build(); |
| 185 | ports.add(new DefaultPortDescription(portNumber(port), isEnabled, |
| 186 | COPPER, portSpeed, |
| 187 | annotations)); |
| 188 | } |
| 189 | } |
| 190 | |
| 191 | /** |
| 192 | * Returns port number from the port name. As many type of port can have |
| 193 | * same port number, each port number will be prepended with a incrementing |
| 194 | * number to make it unique in the list. |
| 195 | * |
| 196 | * @param portName port name |
| 197 | * @return port number |
| 198 | */ |
| 199 | private String getPortNum(String portName) { |
| 200 | String port; |
| 201 | if (!portName.contains(DELIMITER)) { |
| 202 | portInc++; |
| 203 | port = String.valueOf(portInc) + portName; |
| 204 | } else if (portName.indexOf(DELIMITER) > 0) { |
| 205 | try { |
| 206 | port = portName.substring( |
| 207 | portName.lastIndexOf(DELIMITER) + 1); |
| 208 | portInc++; |
| 209 | port = String.valueOf(portInc) + port; |
| 210 | } catch (StringIndexOutOfBoundsException e) { |
| 211 | throw new IllegalArgumentException(P_NAME_INVALID); |
| 212 | } |
| 213 | } else { |
| 214 | throw new IllegalArgumentException(P_NAME_INVALID); |
| 215 | } |
| 216 | return port; |
| 217 | } |
Gaurav Agrawal | 9912f29 | 2017-03-30 01:22:40 +0530 | [diff] [blame] | 218 | |
| 219 | /** |
| 220 | * Returns port statistics information for a device. |
| 221 | * |
| 222 | * @param deviceId device for which port statistics to be fetched |
| 223 | * @return port statistics |
| 224 | */ |
| 225 | Collection<PortStatistics> parsePortsStatistics(DeviceId deviceId) { |
| 226 | Collection<PortStatistics> pss = Lists.newArrayList(); |
| 227 | Iterator itr = getInterfaceIterator(); |
| 228 | while (itr.hasNext()) { |
| 229 | Element ifElement = (Element) itr.next(); |
| 230 | pss.add(getPortStatistics(ifElement, deviceId)); |
| 231 | } |
| 232 | return pss; |
| 233 | } |
| 234 | |
| 235 | private PortStatistics getPortStatistics(Element ifElement, DeviceId id) { |
| 236 | String ifType = ifElement.element(IF_TYPE).getText(); |
| 237 | |
| 238 | DefaultPortStatistics.Builder builder = DefaultPortStatistics.builder(); |
| 239 | |
| 240 | if (INTERFACES.contains(ifType)) { |
Gaurav Agrawal | 9912f29 | 2017-03-30 01:22:40 +0530 | [diff] [blame] | 241 | int port = Integer.parseInt(getPortNum(ifElement.element(IF_NUM) |
| 242 | .getText())); |
| 243 | Element statInfo = ifElement.element(IF_STATS); |
| 244 | long packetReceived = Long.parseLong(statInfo.element(P_RCVD) |
| 245 | .getText()); |
| 246 | long packetSent = Long.parseLong(statInfo.element(P_SENT).getText()); |
| 247 | long bytesReceived = Long.parseLong(statInfo.element(B_RCVD) |
| 248 | .getText()); |
| 249 | long bytesSent = Long.parseLong(statInfo.element(B_SENT).getText()); |
| 250 | long packetsRxDropped = Long.parseLong(statInfo.element(RX_DROP) |
| 251 | .getText()); |
| 252 | long packetsTxDropped = Long.parseLong(statInfo.element(TX_DROP) |
| 253 | .getText()); |
| 254 | long packetsRxErrors = Long.parseLong(statInfo.element(RX_ERROR) |
| 255 | .getText()); |
| 256 | long packetsTxErrors = Long.parseLong(statInfo.element(TX_ERROR) |
| 257 | .getText()); |
| 258 | |
| 259 | return builder.setDeviceId(id) |
Vidyashree Rama | d89a153 | 2017-03-30 15:13:52 +0530 | [diff] [blame] | 260 | .setPort(port) |
Gaurav Agrawal | 9912f29 | 2017-03-30 01:22:40 +0530 | [diff] [blame] | 261 | .setPacketsReceived(packetReceived) |
| 262 | .setPacketsSent(packetSent) |
| 263 | .setBytesReceived(bytesReceived) |
| 264 | .setBytesSent(bytesSent) |
| 265 | .setPacketsRxDropped(packetsRxDropped) |
| 266 | .setPacketsRxErrors(packetsRxErrors) |
| 267 | .setPacketsTxDropped(packetsTxDropped) |
| 268 | .setPacketsTxErrors(packetsTxErrors).build(); |
| 269 | } |
| 270 | return builder.build(); |
| 271 | } |
janani b | f7060cd | 2017-03-28 19:06:30 +0530 | [diff] [blame] | 272 | } |