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