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 | */ |
Yuta HIGUCHI | 7c28ebb | 2014-08-19 00:29:30 -0700 | [diff] [blame] | 21 | public final class TopologyEvent implements TopologyBatchTarget { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 22 | private final Type eventType; |
| 23 | private final TopologyElement<?> event; |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 24 | private final OnosInstanceId onosInstanceId; // The ONOS Instance ID |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 25 | |
| 26 | /** |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 27 | * The topology event type. |
| 28 | */ |
| 29 | public enum Type { |
| 30 | MASTERSHIP, |
| 31 | SWITCH, |
| 32 | PORT, |
| 33 | LINK, |
| 34 | HOST, |
| 35 | NOOP, // TODO: temporary type; should be removed |
| 36 | } |
| 37 | |
| 38 | /** |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 39 | * Default constructor for serializer. |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 40 | */ |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 41 | @Deprecated |
| 42 | protected TopologyEvent() { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 43 | this.eventType = Type.NOOP; |
| 44 | this.event = null; |
| 45 | this.onosInstanceId = null; |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 46 | } |
| 47 | |
| 48 | /** |
Pavlin Radoslavov | 054cd59 | 2014-08-07 20:57:16 -0700 | [diff] [blame] | 49 | * Constructor for creating an empty (NO-OP) Topology Event. |
| 50 | * |
| 51 | * @param onosInstanceId the ONOS Instance ID that originates the event. |
| 52 | */ |
| 53 | protected TopologyEvent(OnosInstanceId onosInstanceId) { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 54 | this.eventType = Type.NOOP; |
| 55 | this.event = null; |
Pavlin Radoslavov | 054cd59 | 2014-08-07 20:57:16 -0700 | [diff] [blame] | 56 | this.onosInstanceId = checkNotNull(onosInstanceId); |
| 57 | } |
| 58 | |
| 59 | /** |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 60 | * Constructor for given Switch Mastership event. |
| 61 | * |
| 62 | * @param mastershipEvent the Switch Mastership event to use. |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 63 | * @param onosInstanceId the ONOS Instance ID that originates the event. |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 64 | */ |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 65 | TopologyEvent(MastershipEvent mastershipEvent, |
| 66 | OnosInstanceId onosInstanceId) { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 67 | this.eventType = Type.MASTERSHIP; |
| 68 | this.event = checkNotNull(mastershipEvent); |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 69 | this.onosInstanceId = checkNotNull(onosInstanceId); |
| 70 | } |
| 71 | |
| 72 | /** |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 73 | * Constructor for given Switch event. |
| 74 | * |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 75 | * @param switchData the Switch event to use. |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 76 | * @param onosInstanceId the ONOS Instance ID that originates the event. |
| 77 | */ |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 78 | TopologyEvent(SwitchData switchData, OnosInstanceId onosInstanceId) { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 79 | this.eventType = Type.SWITCH; |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 80 | this.event = checkNotNull(switchData); |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 81 | this.onosInstanceId = checkNotNull(onosInstanceId); |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * Constructor for given Port event. |
| 86 | * |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 87 | * @param portData the Port event to use. |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 88 | * @param onosInstanceId the ONOS Instance ID that originates the event. |
| 89 | */ |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 90 | TopologyEvent(PortData portData, OnosInstanceId onosInstanceId) { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 91 | this.eventType = Type.PORT; |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 92 | this.event = checkNotNull(portData); |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 93 | this.onosInstanceId = checkNotNull(onosInstanceId); |
| 94 | } |
| 95 | |
| 96 | /** |
| 97 | * Constructor for given Link event. |
| 98 | * |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 99 | * @param linkData the Link event to use. |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 100 | * @param onosInstanceId the ONOS Instance ID that originates the event. |
| 101 | */ |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 102 | TopologyEvent(LinkData linkData, OnosInstanceId onosInstanceId) { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 103 | this.eventType = Type.LINK; |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 104 | this.event = checkNotNull(linkData); |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 105 | this.onosInstanceId = checkNotNull(onosInstanceId); |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * Constructor for given Host event. |
| 110 | * |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 111 | * @param hostData the Host event to use. |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 112 | * @param onosInstanceId the ONOS Instance ID that originates the event. |
| 113 | */ |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 114 | TopologyEvent(HostData hostData, OnosInstanceId onosInstanceId) { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 115 | this.eventType = Type.HOST; |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 116 | this.event = checkNotNull(hostData); |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 117 | this.onosInstanceId = checkNotNull(onosInstanceId); |
| 118 | } |
| 119 | |
| 120 | /** |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 121 | * Gets the Topology Event type. |
| 122 | * |
| 123 | * @return the Topology Event type. |
| 124 | */ |
| 125 | TopologyEvent.Type getEventType() { |
| 126 | return this.eventType; |
| 127 | } |
| 128 | |
| 129 | /** |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 130 | * Gets the Mastership event. |
| 131 | * |
| 132 | * @return the Mastership event. |
| 133 | */ |
| 134 | public MastershipEvent getMastershipEvent() { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 135 | if (eventType != Type.MASTERSHIP) { |
| 136 | return null; |
| 137 | } |
| 138 | MastershipEvent mastershipEvent = (MastershipEvent) event; |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 139 | return mastershipEvent; |
| 140 | } |
| 141 | |
| 142 | /** |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 143 | * Gets the Switch event. |
| 144 | * |
| 145 | * @return the Switch event. |
| 146 | */ |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 147 | public SwitchData getSwitchData() { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 148 | if (eventType != Type.SWITCH) { |
| 149 | return null; |
| 150 | } |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 151 | SwitchData switchData = (SwitchData) event; |
| 152 | return switchData; |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 153 | } |
| 154 | |
| 155 | /** |
| 156 | * Gets the Port event. |
| 157 | * |
| 158 | * @return the Port event. |
| 159 | */ |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 160 | public PortData getPortData() { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 161 | if (eventType != Type.PORT) { |
| 162 | return null; |
| 163 | } |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 164 | PortData portData = (PortData) event; |
| 165 | return portData; |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 166 | } |
| 167 | |
| 168 | /** |
| 169 | * Gets the Link event. |
| 170 | * |
| 171 | * @return the Link event. |
| 172 | */ |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 173 | public LinkData getLinkData() { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 174 | if (eventType != Type.LINK) { |
| 175 | return null; |
| 176 | } |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 177 | LinkData linkData = (LinkData) event; |
| 178 | return linkData; |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 179 | } |
| 180 | |
| 181 | /** |
| 182 | * Gets the Host event. |
| 183 | * |
| 184 | * @return the Host event. |
| 185 | */ |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 186 | public HostData getHostData() { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 187 | if (eventType != Type.HOST) { |
| 188 | return null; |
| 189 | } |
Yuta HIGUCHI | 93d35ea | 2014-08-31 23:26:13 -0700 | [diff] [blame^] | 190 | HostData hostData = (HostData) event; |
| 191 | return hostData; |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 192 | } |
| 193 | |
| 194 | /** |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 195 | * Gets the ONOS Instance ID. |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 196 | * |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 197 | * @return the ONOS Instance ID. |
Pavlin Radoslavov | a5637c0 | 2014-07-30 15:55:11 -0700 | [diff] [blame] | 198 | */ |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 199 | public OnosInstanceId getOnosInstanceId() { |
| 200 | return onosInstanceId; |
Pavlin Radoslavov | 695f895 | 2014-07-23 16:57:01 -0700 | [diff] [blame] | 201 | } |
| 202 | |
| 203 | /** |
Pavlin Radoslavov | d7b792e | 2014-08-01 02:47:47 -0700 | [diff] [blame] | 204 | * Tests whether the event origin DPID equals the specified DPID. |
| 205 | * |
| 206 | * @param dpid the DPID to compare against. |
| 207 | * @return true if the event origin Dpid equals the specified DPID. |
| 208 | */ |
| 209 | public boolean equalsOriginDpid(Dpid dpid) { |
| 210 | return dpid.equals(getOriginDpid()); |
| 211 | } |
| 212 | |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 213 | public Dpid getOriginDpid() { |
| 214 | if (eventType == Type.NOOP) { |
| 215 | return null; |
| 216 | } |
| 217 | return event.getOriginDpid(); |
| 218 | } |
| 219 | |
Pavlin Radoslavov | d7b792e | 2014-08-01 02:47:47 -0700 | [diff] [blame] | 220 | /** |
Pavlin Radoslavov | ae7e848 | 2014-08-11 16:58:19 -0700 | [diff] [blame] | 221 | * Returns the config state of the topology element. |
| 222 | * |
| 223 | * @return the config state of the topology element. |
| 224 | */ |
| 225 | public ConfigState getConfigState() { |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 226 | if (eventType == Type.NOOP) { |
| 227 | return ConfigState.NOT_CONFIGURED; // Default: not configured |
Pavlin Radoslavov | ae7e848 | 2014-08-11 16:58:19 -0700 | [diff] [blame] | 228 | } |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 229 | return event.getConfigState(); |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 230 | } |
| 231 | |
| 232 | /** |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 233 | * Gets the Topology event ID as a byte array. |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 234 | * |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 235 | * @return the Topology event ID as a byte array. |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 236 | */ |
| 237 | public byte[] getID() { |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 238 | return getIDasByteBuffer().array(); |
| 239 | } |
| 240 | |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 241 | public ByteBuffer getIDasByteBuffer() { |
| 242 | ByteBuffer eventId = null; |
| 243 | |
| 244 | // |
| 245 | // Get the Event ID |
| 246 | // |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 247 | if (eventType == Type.NOOP) { |
| 248 | String id = "NO-OP"; |
| 249 | eventId = ByteBuffer.wrap(id.getBytes(StandardCharsets.UTF_8)); |
| 250 | } else { |
| 251 | eventId = event.getIDasByteBuffer(); |
Pavlin Radoslavov | 845ffdd | 2014-08-06 18:01:26 -0700 | [diff] [blame] | 252 | } |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 253 | |
| 254 | // |
| 255 | // Prepare the ONOS Instance ID. The '@' separator is needed to avoid |
| 256 | // potential key collisions. |
| 257 | // |
Pavlin Radoslavov | 845ffdd | 2014-08-06 18:01:26 -0700 | [diff] [blame] | 258 | byte[] onosId = |
| 259 | ("@" + onosInstanceId.toString()).getBytes(StandardCharsets.UTF_8); |
Pavlin Radoslavov | cac157d | 2014-07-31 13:54:08 -0700 | [diff] [blame] | 260 | |
| 261 | // Concatenate the IDs |
| 262 | ByteBuffer buf = |
| 263 | ByteBuffer.allocate(eventId.capacity() + onosId.length); |
| 264 | buf.put(eventId); |
| 265 | buf.put(onosId); |
| 266 | buf.flip(); |
| 267 | return buf; |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 268 | } |
Pavlin Radoslavov | 31f8510 | 2014-08-15 13:55:44 -0700 | [diff] [blame] | 269 | |
| 270 | @Override |
| 271 | public boolean equals(Object o) { |
| 272 | if (this == o) { |
| 273 | return true; |
| 274 | } |
| 275 | if (o == null || getClass() != o.getClass()) { |
| 276 | return false; |
| 277 | } |
| 278 | |
| 279 | TopologyEvent other = (TopologyEvent) o; |
| 280 | return Objects.equals(eventType, other.eventType) && |
| 281 | Objects.equals(event, other.event) && |
| 282 | Objects.equals(onosInstanceId, other.onosInstanceId); |
| 283 | } |
| 284 | |
| 285 | @Override |
| 286 | public int hashCode() { |
| 287 | return Objects.hash(eventType, event, onosInstanceId); |
| 288 | } |
| 289 | |
| 290 | @Override |
| 291 | public String toString() { |
| 292 | String eventStr = null; |
| 293 | |
| 294 | // |
| 295 | // Get the Event string |
| 296 | // |
| 297 | if (eventType == Type.NOOP) { |
| 298 | eventStr = "NO-OP"; |
| 299 | } else { |
| 300 | eventStr = event.toString(); |
| 301 | } |
| 302 | return "[TopologyEvent " + eventStr + " from " + |
| 303 | onosInstanceId.toString() + "]"; |
| 304 | } |
Pavlin Radoslavov | 45ec04b | 2014-02-14 23:29:33 -0800 | [diff] [blame] | 305 | } |