Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 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.ui.impl.topo.model; |
| 18 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 19 | import org.apache.felix.scr.annotations.Activate; |
| 20 | import org.apache.felix.scr.annotations.Component; |
| 21 | import org.apache.felix.scr.annotations.Deactivate; |
| 22 | import org.apache.felix.scr.annotations.Reference; |
| 23 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 24 | import org.apache.felix.scr.annotations.Service; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 25 | import org.onosproject.cluster.ClusterEvent; |
| 26 | import org.onosproject.cluster.ClusterEventListener; |
| 27 | import org.onosproject.cluster.ClusterService; |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 28 | import org.onosproject.cluster.ControllerNode; |
| 29 | import org.onosproject.cluster.RoleInfo; |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 30 | import org.onosproject.event.AbstractListenerManager; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 31 | import org.onosproject.incubator.net.PortStatisticsService; |
| 32 | import org.onosproject.incubator.net.tunnel.TunnelService; |
| 33 | import org.onosproject.mastership.MastershipEvent; |
| 34 | import org.onosproject.mastership.MastershipListener; |
| 35 | import org.onosproject.mastership.MastershipService; |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 36 | import org.onosproject.net.Device; |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 37 | import org.onosproject.net.DeviceId; |
| 38 | import org.onosproject.net.Host; |
| 39 | import org.onosproject.net.Link; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 40 | import org.onosproject.net.device.DeviceEvent; |
| 41 | import org.onosproject.net.device.DeviceListener; |
| 42 | import org.onosproject.net.device.DeviceService; |
| 43 | import org.onosproject.net.flow.FlowRuleEvent; |
| 44 | import org.onosproject.net.flow.FlowRuleListener; |
| 45 | import org.onosproject.net.flow.FlowRuleService; |
| 46 | import org.onosproject.net.host.HostEvent; |
| 47 | import org.onosproject.net.host.HostListener; |
| 48 | import org.onosproject.net.host.HostService; |
| 49 | import org.onosproject.net.intent.IntentEvent; |
| 50 | import org.onosproject.net.intent.IntentListener; |
| 51 | import org.onosproject.net.intent.IntentService; |
| 52 | import org.onosproject.net.link.LinkEvent; |
| 53 | import org.onosproject.net.link.LinkListener; |
| 54 | import org.onosproject.net.link.LinkService; |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 55 | import org.onosproject.net.region.Region; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 56 | import org.onosproject.net.region.RegionEvent; |
| 57 | import org.onosproject.net.region.RegionListener; |
| 58 | import org.onosproject.net.region.RegionService; |
| 59 | import org.onosproject.net.statistic.StatisticService; |
| 60 | import org.onosproject.net.topology.TopologyService; |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 61 | import org.onosproject.ui.impl.topo.UiTopoSession; |
Simon Hunt | 642bc45 | 2016-05-04 19:34:45 -0700 | [diff] [blame] | 62 | import org.onosproject.ui.model.ServiceBundle; |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 63 | import org.slf4j.Logger; |
| 64 | import org.slf4j.LoggerFactory; |
| 65 | |
| 66 | /** |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 67 | * Service that creates and maintains the UI-model of the network topology. |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 68 | */ |
Thomas Vachuska | 318cd58 | 2016-05-17 15:01:10 -0700 | [diff] [blame] | 69 | @Component(immediate = true, enabled = false) |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 70 | @Service(value = UiSharedTopologyModel.class) |
| 71 | public final class UiSharedTopologyModel |
| 72 | extends AbstractListenerManager<UiModelEvent, UiModelListener> { |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 73 | |
| 74 | private static final Logger log = |
| 75 | LoggerFactory.getLogger(UiSharedTopologyModel.class); |
| 76 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 77 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 78 | private ClusterService clusterService; |
| 79 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 80 | private MastershipService mastershipService; |
| 81 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 82 | private RegionService regionService; |
| 83 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 84 | private DeviceService deviceService; |
| 85 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 86 | private LinkService linkService; |
| 87 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 88 | private HostService hostService; |
| 89 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 90 | private IntentService intentService; |
| 91 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 92 | private FlowRuleService flowService; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 93 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 94 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 95 | private StatisticService flowStatsService; |
| 96 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 97 | private PortStatisticsService portStatsService; |
| 98 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 99 | private TopologyService topologyService; |
| 100 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 101 | private TunnelService tunnelService; |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 102 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 103 | private final ClusterEventListener clusterListener = |
| 104 | new InternalClusterListener(); |
| 105 | private final MastershipListener mastershipListener = |
| 106 | new InternalMastershipListener(); |
| 107 | private final RegionListener regionListener = |
| 108 | new InternalRegionListener(); |
| 109 | private final DeviceListener deviceListener = |
| 110 | new InternalDeviceListener(); |
| 111 | private final LinkListener linkListener = |
| 112 | new InternalLinkListener(); |
| 113 | private final HostListener hostListener = |
| 114 | new InternalHostListener(); |
| 115 | private final IntentListener intentListener = |
| 116 | new InternalIntentListener(); |
| 117 | private final FlowRuleListener flowRuleListener = |
| 118 | new InternalFlowRuleListener(); |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 119 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 120 | |
| 121 | private ModelCache cache; |
| 122 | |
| 123 | |
| 124 | @Activate |
| 125 | protected void activate() { |
Simon Hunt | 642bc45 | 2016-05-04 19:34:45 -0700 | [diff] [blame] | 126 | cache = new ModelCache(new DefaultServiceBundle(), eventDispatcher); |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 127 | |
| 128 | eventDispatcher.addSink(UiModelEvent.class, listenerRegistry); |
| 129 | |
| 130 | clusterService.addListener(clusterListener); |
| 131 | mastershipService.addListener(mastershipListener); |
| 132 | regionService.addListener(regionListener); |
| 133 | deviceService.addListener(deviceListener); |
| 134 | linkService.addListener(linkListener); |
| 135 | hostService.addListener(hostListener); |
| 136 | intentService.addListener(intentListener); |
| 137 | flowService.addListener(flowRuleListener); |
| 138 | |
| 139 | cache.load(); |
| 140 | |
| 141 | log.info("Started"); |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 142 | } |
| 143 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 144 | @Deactivate |
| 145 | protected void deactivate() { |
| 146 | eventDispatcher.removeSink(UiModelEvent.class); |
| 147 | |
| 148 | clusterService.removeListener(clusterListener); |
| 149 | mastershipService.removeListener(mastershipListener); |
| 150 | regionService.removeListener(regionListener); |
| 151 | deviceService.removeListener(deviceListener); |
| 152 | linkService.removeListener(linkListener); |
| 153 | hostService.removeListener(hostListener); |
| 154 | intentService.removeListener(intentListener); |
| 155 | flowService.removeListener(flowRuleListener); |
| 156 | |
| 157 | cache.clear(); |
| 158 | cache = null; |
| 159 | |
| 160 | log.info("Stopped"); |
| 161 | } |
| 162 | |
| 163 | |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 164 | /** |
| 165 | * Registers a UI topology session with the topology model. |
| 166 | * |
| 167 | * @param session the session to register |
| 168 | */ |
| 169 | public void register(UiTopoSession session) { |
| 170 | log.info("Registering topology session {}", session); |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 171 | addListener(session); |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 172 | } |
| 173 | |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 174 | /** |
| 175 | * Unregisters a UI topology session from the topology model. |
| 176 | * |
| 177 | * @param session the session to unregister |
| 178 | */ |
| 179 | public void unregister(UiTopoSession session) { |
| 180 | log.info("Unregistering topology session {}", session); |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 181 | removeListener(session); |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 182 | } |
| 183 | |
Simon Hunt | 642bc45 | 2016-05-04 19:34:45 -0700 | [diff] [blame] | 184 | /** |
| 185 | * Default implementation of service bundle to return references to our |
| 186 | * dynamically injected services. |
| 187 | */ |
| 188 | private class DefaultServiceBundle implements ServiceBundle { |
| 189 | @Override |
| 190 | public ClusterService cluster() { |
| 191 | return clusterService; |
| 192 | } |
| 193 | |
| 194 | @Override |
| 195 | public MastershipService mastership() { |
| 196 | return mastershipService; |
| 197 | } |
| 198 | |
| 199 | @Override |
| 200 | public RegionService region() { |
| 201 | return regionService; |
| 202 | } |
| 203 | |
| 204 | @Override |
| 205 | public DeviceService device() { |
| 206 | return deviceService; |
| 207 | } |
| 208 | |
| 209 | @Override |
| 210 | public LinkService link() { |
| 211 | return linkService; |
| 212 | } |
| 213 | |
| 214 | @Override |
| 215 | public HostService host() { |
| 216 | return hostService; |
| 217 | } |
| 218 | |
| 219 | @Override |
| 220 | public IntentService intent() { |
| 221 | return intentService; |
| 222 | } |
| 223 | |
| 224 | @Override |
| 225 | public FlowRuleService flow() { |
| 226 | return flowService; |
| 227 | } |
| 228 | } |
| 229 | |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 230 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 231 | private class InternalClusterListener implements ClusterEventListener { |
| 232 | @Override |
| 233 | public void event(ClusterEvent event) { |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 234 | ControllerNode cnode = event.subject(); |
| 235 | |
| 236 | switch (event.type()) { |
| 237 | |
| 238 | case INSTANCE_ADDED: |
| 239 | case INSTANCE_ACTIVATED: |
| 240 | case INSTANCE_READY: |
| 241 | case INSTANCE_DEACTIVATED: |
| 242 | cache.addOrUpdateClusterMember(cnode); |
| 243 | break; |
| 244 | |
| 245 | case INSTANCE_REMOVED: |
| 246 | cache.removeClusterMember(cnode); |
| 247 | break; |
| 248 | |
| 249 | default: |
| 250 | break; |
| 251 | } |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 252 | } |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 253 | } |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 254 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 255 | private class InternalMastershipListener implements MastershipListener { |
| 256 | @Override |
| 257 | public void event(MastershipEvent event) { |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 258 | DeviceId deviceId = event.subject(); |
| 259 | RoleInfo roleInfo = event.roleInfo(); |
| 260 | |
| 261 | switch (event.type()) { |
| 262 | case MASTER_CHANGED: |
| 263 | case BACKUPS_CHANGED: |
| 264 | cache.updateMasterships(deviceId, roleInfo); |
| 265 | break; |
| 266 | |
| 267 | default: |
| 268 | break; |
| 269 | } |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 270 | } |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 271 | } |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 272 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 273 | private class InternalRegionListener implements RegionListener { |
| 274 | @Override |
| 275 | public void event(RegionEvent event) { |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 276 | Region region = event.subject(); |
| 277 | |
| 278 | switch (event.type()) { |
| 279 | |
| 280 | case REGION_ADDED: |
| 281 | case REGION_UPDATED: |
| 282 | case REGION_MEMBERSHIP_CHANGED: |
| 283 | cache.addOrUpdateRegion(region); |
| 284 | break; |
| 285 | |
| 286 | case REGION_REMOVED: |
| 287 | cache.removeRegion(region); |
| 288 | break; |
| 289 | |
| 290 | default: |
| 291 | break; |
| 292 | } |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 293 | } |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 294 | } |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 295 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 296 | private class InternalDeviceListener implements DeviceListener { |
| 297 | @Override |
| 298 | public void event(DeviceEvent event) { |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 299 | Device device = event.subject(); |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 300 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 301 | switch (event.type()) { |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 302 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 303 | case DEVICE_ADDED: |
| 304 | case DEVICE_UPDATED: |
| 305 | case DEVICE_AVAILABILITY_CHANGED: |
| 306 | case DEVICE_SUSPENDED: |
| 307 | cache.addOrUpdateDevice(device); |
| 308 | break; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 309 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 310 | case DEVICE_REMOVED: |
| 311 | cache.removeDevice(device); |
| 312 | break; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 313 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 314 | default: |
| 315 | break; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 316 | } |
| 317 | } |
| 318 | } |
| 319 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 320 | private class InternalLinkListener implements LinkListener { |
| 321 | @Override |
| 322 | public void event(LinkEvent event) { |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 323 | Link link = event.subject(); |
| 324 | |
| 325 | switch (event.type()) { |
| 326 | |
| 327 | case LINK_ADDED: |
| 328 | case LINK_UPDATED: |
| 329 | cache.addOrUpdateLink(link); |
| 330 | break; |
| 331 | |
| 332 | case LINK_REMOVED: |
| 333 | cache.removeLink(link); |
| 334 | break; |
| 335 | |
| 336 | default: |
| 337 | break; |
| 338 | } |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 339 | } |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 340 | } |
| 341 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 342 | private class InternalHostListener implements HostListener { |
| 343 | @Override |
| 344 | public void event(HostEvent event) { |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 345 | Host host = event.subject(); |
| 346 | Host prevHost = event.prevSubject(); |
| 347 | |
| 348 | switch (event.type()) { |
| 349 | |
| 350 | case HOST_ADDED: |
| 351 | case HOST_UPDATED: |
| 352 | cache.addOrUpdateHost(host); |
| 353 | break; |
| 354 | |
| 355 | case HOST_MOVED: |
| 356 | cache.moveHost(host, prevHost); |
| 357 | break; |
| 358 | |
| 359 | case HOST_REMOVED: |
| 360 | cache.removeHost(host); |
| 361 | break; |
| 362 | |
| 363 | default: |
| 364 | break; |
| 365 | } |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 366 | } |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 367 | } |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 368 | |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 369 | // ======================================================================= |
| 370 | // NOTE: Neither intents nor flows are modeled by the UiTopology. |
| 371 | // Rather, they are serviced directly from this class. |
| 372 | // Additionally, since we are only retrieving counts (in the current |
| 373 | // implementation), we'll fetch them on demand from the service. |
| 374 | // Thus, the following internal listeners are stubs only (for now). |
| 375 | // ======================================================================= |
| 376 | |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 377 | private class InternalIntentListener implements IntentListener { |
| 378 | @Override |
| 379 | public void event(IntentEvent event) { |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 380 | // do nothing (for now) |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 381 | } |
| 382 | } |
| 383 | |
| 384 | private class InternalFlowRuleListener implements FlowRuleListener { |
| 385 | @Override |
| 386 | public void event(FlowRuleEvent event) { |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 387 | // do nothing (for now) |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 388 | } |
| 389 | } |
| 390 | |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 391 | } |