Jonathan Hart | 472062d | 2014-04-03 10:56:48 -0700 | [diff] [blame] | 1 | package net.onrc.onos.core.topology; |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 2 | |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 3 | import java.nio.ByteBuffer; |
| 4 | import java.nio.charset.StandardCharsets; |
weibit | cef0986 | 2014-07-11 17:05:16 -0700 | [diff] [blame] | 5 | import java.util.Objects; |
| 6 | |
Pavlin Radoslavov | d7b792e | 2014-08-01 02:47:47 -0700 | [diff] [blame^] | 7 | import net.onrc.onos.core.util.Dpid; |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 8 | import net.onrc.onos.core.util.OnosInstanceId; |
| 9 | |
| 10 | import static com.google.common.base.Preconditions.checkNotNull; |
weibit | cef0986 | 2014-07-11 17:05:16 -0700 | [diff] [blame] | 11 | |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 12 | /** |
| 13 | * Self-contained Topology event Object |
Ray Milkey | 269ffb9 | 2014-04-03 14:43:30 -0700 | [diff] [blame] | 14 | * <p/> |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 15 | * TODO: For now the topology event contains one of the following events: |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 16 | * Switch Mastership, Switch, Port, Link, Host. In the future it will contain |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 17 | * multiple events in a single transaction. |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 18 | * TODO: This class should become immutable after its internals and usage |
| 19 | * are finalized. |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 20 | */ |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 21 | public final class TopologyEvent { |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 22 | private final MastershipEvent mastershipEvent; // Set for Mastership event |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 23 | private final SwitchEvent switchEvent; // Set for Switch event |
| 24 | private final PortEvent portEvent; // Set for Port event |
| 25 | private final LinkEvent linkEvent; // Set for Link event |
| 26 | private final HostEvent hostEvent; // Set for Host event |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 27 | private final OnosInstanceId onosInstanceId; // The ONOS Instance ID |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 28 | |
| 29 | /** |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 30 | * Default constructor for serializer. |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 31 | */ |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 32 | @Deprecated |
| 33 | protected TopologyEvent() { |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 34 | mastershipEvent = null; |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 35 | switchEvent = null; |
| 36 | portEvent = null; |
| 37 | linkEvent = null; |
| 38 | hostEvent = null; |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 39 | onosInstanceId = null; |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 40 | } |
| 41 | |
| 42 | /** |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 43 | * Constructor for given Switch Mastership event. |
| 44 | * |
| 45 | * @param mastershipEvent the Switch Mastership event to use. |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 46 | * @param onosInstanceId the ONOS Instance ID that originates the event. |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 47 | */ |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 48 | TopologyEvent(MastershipEvent mastershipEvent, |
| 49 | OnosInstanceId onosInstanceId) { |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 50 | this.mastershipEvent = checkNotNull(mastershipEvent); |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 51 | this.switchEvent = null; |
| 52 | this.portEvent = null; |
| 53 | this.linkEvent = null; |
| 54 | this.hostEvent = null; |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 55 | this.onosInstanceId = checkNotNull(onosInstanceId); |
| 56 | } |
| 57 | |
| 58 | /** |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 59 | * Constructor for given Switch event. |
| 60 | * |
| 61 | * @param switchEvent the Switch event to use. |
| 62 | * @param onosInstanceId the ONOS Instance ID that originates the event. |
| 63 | */ |
| 64 | TopologyEvent(SwitchEvent switchEvent, OnosInstanceId onosInstanceId) { |
| 65 | this.mastershipEvent = null; |
| 66 | this.switchEvent = checkNotNull(switchEvent); |
| 67 | this.portEvent = null; |
| 68 | this.linkEvent = null; |
| 69 | this.hostEvent = null; |
| 70 | this.onosInstanceId = checkNotNull(onosInstanceId); |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Constructor for given Port event. |
| 75 | * |
| 76 | * @param portEvent the Port event to use. |
| 77 | * @param onosInstanceId the ONOS Instance ID that originates the event. |
| 78 | */ |
| 79 | TopologyEvent(PortEvent portEvent, OnosInstanceId onosInstanceId) { |
| 80 | this.mastershipEvent = null; |
| 81 | this.switchEvent = null; |
| 82 | this.portEvent = checkNotNull(portEvent); |
| 83 | this.linkEvent = null; |
| 84 | this.hostEvent = null; |
| 85 | this.onosInstanceId = checkNotNull(onosInstanceId); |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * Constructor for given Link event. |
| 90 | * |
| 91 | * @param linkEvent the Link event to use. |
| 92 | * @param onosInstanceId the ONOS Instance ID that originates the event. |
| 93 | */ |
| 94 | TopologyEvent(LinkEvent linkEvent, OnosInstanceId onosInstanceId) { |
| 95 | this.mastershipEvent = null; |
| 96 | this.switchEvent = null; |
| 97 | this.portEvent = null; |
| 98 | this.linkEvent = checkNotNull(linkEvent); |
| 99 | this.hostEvent = null; |
| 100 | this.onosInstanceId = checkNotNull(onosInstanceId); |
| 101 | } |
| 102 | |
| 103 | /** |
| 104 | * Constructor for given Host event. |
| 105 | * |
| 106 | * @param hostEvent the Host event to use. |
| 107 | * @param onosInstanceId the ONOS Instance ID that originates the event. |
| 108 | */ |
| 109 | TopologyEvent(HostEvent hostEvent, OnosInstanceId onosInstanceId) { |
| 110 | this.mastershipEvent = null; |
| 111 | this.switchEvent = null; |
| 112 | this.portEvent = null; |
| 113 | this.linkEvent = null; |
| 114 | this.hostEvent = checkNotNull(hostEvent); |
| 115 | this.onosInstanceId = checkNotNull(onosInstanceId); |
| 116 | } |
| 117 | |
| 118 | /** |
| 119 | * Gets the Mastership event. |
| 120 | * |
| 121 | * @return the Mastership event. |
| 122 | */ |
| 123 | public MastershipEvent getMastershipEvent() { |
| 124 | return mastershipEvent; |
| 125 | } |
| 126 | |
| 127 | /** |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 128 | * Gets the Switch event. |
| 129 | * |
| 130 | * @return the Switch event. |
| 131 | */ |
| 132 | public SwitchEvent getSwitchEvent() { |
| 133 | return switchEvent; |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Gets the Port event. |
| 138 | * |
| 139 | * @return the Port event. |
| 140 | */ |
| 141 | public PortEvent getPortEvent() { |
| 142 | return portEvent; |
| 143 | } |
| 144 | |
| 145 | /** |
| 146 | * Gets the Link event. |
| 147 | * |
| 148 | * @return the Link event. |
| 149 | */ |
| 150 | public LinkEvent getLinkEvent() { |
| 151 | return linkEvent; |
| 152 | } |
| 153 | |
| 154 | /** |
| 155 | * Gets the Host event. |
| 156 | * |
| 157 | * @return the Host event. |
| 158 | */ |
| 159 | public HostEvent getHostEvent() { |
| 160 | return hostEvent; |
| 161 | } |
| 162 | |
| 163 | /** |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 164 | * Gets the ONOS Instance ID. |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 165 | * |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 166 | * @return the ONOS Instance ID. |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 167 | */ |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 168 | public OnosInstanceId getOnosInstanceId() { |
| 169 | return onosInstanceId; |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 170 | } |
| 171 | |
| 172 | /** |
Pavlin Radoslavov | d7b792e | 2014-08-01 02:47:47 -0700 | [diff] [blame^] | 173 | * Gets the event origin DPID. |
| 174 | * |
| 175 | * @return the event origin DPID. |
| 176 | */ |
| 177 | public Dpid getOriginDpid() { |
| 178 | if (mastershipEvent != null) { |
| 179 | return mastershipEvent.getOriginDpid(); |
| 180 | } |
| 181 | if (switchEvent != null) { |
| 182 | return switchEvent.getOriginDpid(); |
| 183 | } |
| 184 | if (portEvent != null) { |
| 185 | return portEvent.getOriginDpid(); |
| 186 | } |
| 187 | if (linkEvent != null) { |
| 188 | return linkEvent.getOriginDpid(); |
| 189 | } |
| 190 | if (hostEvent != null) { |
| 191 | return hostEvent.getOriginDpid(); |
| 192 | } |
| 193 | return null; |
| 194 | } |
| 195 | |
| 196 | /** |
| 197 | * Tests whether the event origin DPID equals the specified DPID. |
| 198 | * |
| 199 | * @param dpid the DPID to compare against. |
| 200 | * @return true if the event origin Dpid equals the specified DPID. |
| 201 | */ |
| 202 | public boolean equalsOriginDpid(Dpid dpid) { |
| 203 | return dpid.equals(getOriginDpid()); |
| 204 | } |
| 205 | |
| 206 | /** |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 207 | * Checks if all events contained are equal. |
Yuta HIGUCHI | ccab05d | 2014-07-26 22:42:28 -0700 | [diff] [blame] | 208 | * |
| 209 | * @param obj TopologyEvent to compare against |
weibit | cef0986 | 2014-07-11 17:05:16 -0700 | [diff] [blame] | 210 | */ |
| 211 | @Override |
| 212 | public boolean equals(Object obj) { |
| 213 | if (this == obj) { |
| 214 | return true; |
| 215 | } |
| 216 | |
| 217 | if (obj == null) { |
| 218 | return false; |
| 219 | } |
| 220 | |
| 221 | if (getClass() != obj.getClass()) { |
| 222 | return false; |
| 223 | } |
| 224 | |
| 225 | TopologyEvent other = (TopologyEvent) obj; |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 226 | return Objects.equals(mastershipEvent, other.mastershipEvent) && |
| 227 | Objects.equals(switchEvent, other.switchEvent) && |
| 228 | Objects.equals(portEvent, other.portEvent) && |
| 229 | Objects.equals(linkEvent, other.linkEvent) && |
| 230 | Objects.equals(hostEvent, other.hostEvent) && |
| 231 | Objects.equals(onosInstanceId, other.onosInstanceId); |
weibit | cef0986 | 2014-07-11 17:05:16 -0700 | [diff] [blame] | 232 | } |
| 233 | |
| 234 | @Override |
| 235 | public int hashCode() { |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 236 | return Objects.hash(mastershipEvent, switchEvent, portEvent, |
| 237 | linkEvent, hostEvent, onosInstanceId); |
weibit | cef0986 | 2014-07-11 17:05:16 -0700 | [diff] [blame] | 238 | } |
| 239 | |
| 240 | /** |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 241 | * Gets the string representation of the event. |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 242 | * |
| 243 | * @return the string representation of the event. |
| 244 | */ |
| 245 | @Override |
| 246 | public String toString() { |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 247 | String eventStr = null; |
| 248 | |
| 249 | // |
| 250 | // Get the Event string |
| 251 | // |
| 252 | do { |
| 253 | if (mastershipEvent != null) { |
| 254 | eventStr = mastershipEvent.toString(); |
| 255 | break; |
| 256 | } |
| 257 | if (switchEvent != null) { |
| 258 | eventStr = switchEvent.toString(); |
| 259 | break; |
| 260 | } |
| 261 | if (portEvent != null) { |
| 262 | eventStr = portEvent.toString(); |
| 263 | break; |
| 264 | } |
| 265 | if (linkEvent != null) { |
| 266 | eventStr = linkEvent.toString(); |
| 267 | break; |
| 268 | } |
| 269 | if (hostEvent != null) { |
| 270 | eventStr = hostEvent.toString(); |
| 271 | break; |
| 272 | } |
| 273 | // No event found |
| 274 | return "[Empty TopologyEvent]"; |
| 275 | } while (false); |
| 276 | |
| 277 | return "[TopologyEvent " + eventStr + " from " + |
| 278 | onosInstanceId.toString() + "]"; |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 279 | } |
| 280 | |
| 281 | /** |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 282 | * Gets the Topology event ID as a byte array. |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 283 | * |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 284 | * @return the Topology event ID as a byte array. |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 285 | */ |
| 286 | public byte[] getID() { |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 287 | return getIDasByteBuffer().array(); |
| 288 | } |
| 289 | |
| 290 | /** |
| 291 | * Gets the Topology event ID as a ByteBuffer. |
| 292 | * |
| 293 | * @return the Topology event ID as a ByteBuffer. |
| 294 | */ |
| 295 | public ByteBuffer getIDasByteBuffer() { |
| 296 | ByteBuffer eventId = null; |
| 297 | |
| 298 | // |
| 299 | // Get the Event ID |
| 300 | // |
| 301 | do { |
| 302 | if (mastershipEvent != null) { |
| 303 | eventId = mastershipEvent.getIDasByteBuffer(); |
| 304 | break; |
| 305 | } |
| 306 | if (switchEvent != null) { |
| 307 | eventId = switchEvent.getIDasByteBuffer(); |
| 308 | break; |
| 309 | } |
| 310 | if (portEvent != null) { |
| 311 | eventId = portEvent.getIDasByteBuffer(); |
| 312 | break; |
| 313 | } |
| 314 | if (linkEvent != null) { |
| 315 | eventId = linkEvent.getIDasByteBuffer(); |
| 316 | break; |
| 317 | } |
| 318 | if (hostEvent != null) { |
| 319 | eventId = hostEvent.getIDasByteBuffer(); |
| 320 | break; |
| 321 | } |
| 322 | // No event found |
| 323 | throw new IllegalStateException("Invalid TopologyEvent ID"); |
| 324 | } while (false); |
| 325 | |
| 326 | // |
| 327 | // Prepare the ONOS Instance ID. The '@' separator is needed to avoid |
| 328 | // potential key collisions. |
| 329 | // |
| 330 | byte[] onosId = ("@" + onosInstanceId.toString()).getBytes(StandardCharsets.UTF_8); |
| 331 | |
| 332 | // Concatenate the IDs |
| 333 | ByteBuffer buf = |
| 334 | ByteBuffer.allocate(eventId.capacity() + onosId.length); |
| 335 | buf.put(eventId); |
| 336 | buf.put(onosId); |
| 337 | buf.flip(); |
| 338 | return buf; |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 339 | } |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 340 | } |