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 | |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 17 | package org.onosproject.ui.impl.topo; |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 18 | |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 19 | import org.onosproject.net.region.RegionId; |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 20 | import org.onosproject.ui.UiTopoLayoutService; |
| 21 | import org.onosproject.ui.impl.UiWebSocket; |
Thomas Vachuska | 8c0b18a | 2017-04-14 16:27:33 -0700 | [diff] [blame] | 22 | import org.onosproject.ui.model.topo.UiModelEvent; |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 23 | import org.onosproject.ui.impl.topo.model.UiModelListener; |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 24 | import org.onosproject.ui.impl.topo.model.UiSharedTopologyModel; |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 25 | import org.onosproject.ui.model.topo.UiClusterMember; |
Simon Hunt | 9818919 | 2016-07-29 19:02:27 -0700 | [diff] [blame] | 26 | import org.onosproject.ui.model.topo.UiNode; |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 27 | import org.onosproject.ui.model.topo.UiRegion; |
Simon Hunt | c13082f | 2016-08-03 21:20:23 -0700 | [diff] [blame] | 28 | import org.onosproject.ui.model.topo.UiSynthLink; |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 29 | import org.onosproject.ui.model.topo.UiTopoLayout; |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 30 | import org.slf4j.Logger; |
| 31 | import org.slf4j.LoggerFactory; |
| 32 | |
Simon Hunt | f836a87 | 2016-08-10 17:37:36 -0700 | [diff] [blame] | 33 | import java.util.ArrayList; |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 34 | import java.util.HashSet; |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 35 | import java.util.List; |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 36 | import java.util.Set; |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 37 | |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 38 | /** |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 39 | * Coordinates with the {@link UiTopoLayoutService} to access |
| 40 | * {@link UiTopoLayout}s, and with the {@link UiSharedTopologyModel} which |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 41 | * maintains a local model of the network entities, tailored specifically |
| 42 | * for displaying on the UI. |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 43 | * <p> |
| 44 | * Note that an instance of this class will be created for each |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 45 | * {@link UiWebSocket} connection, and will contain |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 46 | * the state of how the topology is laid out for the logged-in user. |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 47 | * <p> |
| 48 | * The expected pattern is for the {@link Topo2ViewMessageHandler} to obtain |
| 49 | * a reference to the session instance (via the {@link UiWebSocket}), and |
| 50 | * interact with it when topo-related events come in from the client. |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 51 | */ |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 52 | public class UiTopoSession implements UiModelListener { |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 53 | |
Simon Hunt | 537bc76 | 2016-12-20 12:15:13 -0800 | [diff] [blame] | 54 | private static final String TOPO2_UI_MODEL_EVENT = "topo2UiModelEvent"; |
| 55 | |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 56 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 57 | |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 58 | private final UiWebSocket webSocket; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 59 | private final String username; |
Simon Hunt | 537bc76 | 2016-12-20 12:15:13 -0800 | [diff] [blame] | 60 | private final Topo2Jsonifier t2json; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 61 | |
| 62 | final UiSharedTopologyModel sharedModel; |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 63 | |
| 64 | private boolean registered = false; |
| 65 | |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 66 | private UiTopoLayoutService layoutService; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 67 | private UiTopoLayout currentLayout; |
Simon Hunt | bbd0f46 | 2017-01-10 14:50:22 -0800 | [diff] [blame] | 68 | private boolean messagesEnabled = true; |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 69 | |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 70 | /** |
Simon Hunt | 537bc76 | 2016-12-20 12:15:13 -0800 | [diff] [blame] | 71 | * Creates a new topology session for the specified web socket connection, |
| 72 | * and references to JSONifier, shared model, and layout service. |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 73 | * |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 74 | * @param webSocket web socket |
Simon Hunt | 537bc76 | 2016-12-20 12:15:13 -0800 | [diff] [blame] | 75 | * @param jsonifier JSONifier instance |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 76 | * @param model share topology model |
| 77 | * @param layoutService topology layout service |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 78 | */ |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 79 | public UiTopoSession(UiWebSocket webSocket, |
Simon Hunt | 537bc76 | 2016-12-20 12:15:13 -0800 | [diff] [blame] | 80 | Topo2Jsonifier jsonifier, |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 81 | UiSharedTopologyModel model, |
| 82 | UiTopoLayoutService layoutService) { |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 83 | this.webSocket = webSocket; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 84 | this.username = webSocket.userName(); |
Simon Hunt | 537bc76 | 2016-12-20 12:15:13 -0800 | [diff] [blame] | 85 | this.t2json = jsonifier; |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 86 | this.sharedModel = model; |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 87 | this.layoutService = layoutService; |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 88 | } |
| 89 | |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 90 | // constructs a neutered instance, for unit testing |
| 91 | UiTopoSession() { |
| 92 | webSocket = null; |
| 93 | username = null; |
Simon Hunt | 537bc76 | 2016-12-20 12:15:13 -0800 | [diff] [blame] | 94 | t2json = null; |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 95 | sharedModel = null; |
| 96 | } |
| 97 | |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 98 | /** |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 99 | * Initializes the session; registering with the shared model. |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 100 | */ |
| 101 | public void init() { |
| 102 | if (!registered) { |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 103 | log.debug("{} : Registering with shared model", this); |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 104 | sharedModel.register(this); |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 105 | currentLayout = layoutService.getRootLayout(); |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 106 | registered = true; |
| 107 | } else { |
| 108 | log.warn("already registered"); |
| 109 | } |
| 110 | } |
| 111 | |
| 112 | /** |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 113 | * Destroys the session; unregistering from the shared model. |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 114 | */ |
| 115 | public void destroy() { |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 116 | if (registered) { |
| 117 | log.debug("{} : Unregistering from shared model", this); |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 118 | sharedModel.unregister(this); |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 119 | registered = false; |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 120 | } else { |
| 121 | log.warn("already unregistered"); |
| 122 | } |
| 123 | } |
| 124 | |
| 125 | @Override |
| 126 | public String toString() { |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 127 | return String.format("{UiTopoSession for user <%s>}", username); |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 128 | } |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 129 | |
| 130 | @Override |
Thomas Vachuska | 8c0b18a | 2017-04-14 16:27:33 -0700 | [diff] [blame] | 131 | public boolean isRelevant(UiModelEvent event) { |
| 132 | if (!messagesEnabled) { |
| 133 | return false; |
Simon Hunt | bbd0f46 | 2017-01-10 14:50:22 -0800 | [diff] [blame] | 134 | } |
Thomas Vachuska | 8c0b18a | 2017-04-14 16:27:33 -0700 | [diff] [blame] | 135 | UiRegion uiRegion = sharedModel.getRegion(currentLayout.regionId()); |
| 136 | return uiRegion.isRelevant(event); |
| 137 | } |
| 138 | |
| 139 | @Override |
| 140 | public void event(UiModelEvent event) { |
| 141 | webSocket.sendMessage(TOPO2_UI_MODEL_EVENT, t2json.jsonEvent(event)); |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 142 | } |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 143 | |
| 144 | /** |
| 145 | * Returns the current layout context. |
| 146 | * |
| 147 | * @return current topology layout |
| 148 | */ |
| 149 | public UiTopoLayout currentLayout() { |
| 150 | return currentLayout; |
| 151 | } |
| 152 | |
| 153 | /** |
Simon Hunt | f836a87 | 2016-08-10 17:37:36 -0700 | [diff] [blame] | 154 | * Returns the breadcrumb trail from current layout to root. That is, |
| 155 | * element 0 of the list will be the current layout; the last element |
| 156 | * of the list will be the root layout. This list is guaranteed to have |
| 157 | * size of at least 1. |
| 158 | * |
| 159 | * @return breadcrumb trail |
| 160 | */ |
| 161 | public List<UiTopoLayout> breadCrumbs() { |
| 162 | UiTopoLayout current = currentLayout; |
| 163 | List<UiTopoLayout> crumbs = new ArrayList<>(); |
| 164 | crumbs.add(current); |
| 165 | while (!current.isRoot()) { |
| 166 | current = layoutService.getLayout(current.parent()); |
| 167 | crumbs.add(current); |
| 168 | } |
| 169 | return crumbs; |
| 170 | } |
| 171 | |
| 172 | /** |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 173 | * Changes the current layout context to the specified layout. |
| 174 | * |
| 175 | * @param topoLayout new topology layout context |
| 176 | */ |
| 177 | public void setCurrentLayout(UiTopoLayout topoLayout) { |
| 178 | currentLayout = topoLayout; |
| 179 | } |
| 180 | |
| 181 | /** |
| 182 | * Enables or disables the transmission of topology event update messages. |
| 183 | * |
| 184 | * @param enabled true if messages should be sent |
| 185 | */ |
| 186 | public void enableEvent(boolean enabled) { |
| 187 | messagesEnabled = enabled; |
| 188 | } |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 189 | |
| 190 | /** |
| 191 | * Returns the list of ONOS instances (cluster members). |
| 192 | * |
| 193 | * @return the list of ONOS instances |
| 194 | */ |
| 195 | public List<UiClusterMember> getAllInstances() { |
| 196 | return sharedModel.getClusterMembers(); |
| 197 | } |
| 198 | |
| 199 | /** |
| 200 | * Returns the region for the specified layout. |
| 201 | * |
| 202 | * @param layout layout filter |
| 203 | * @return region that the layout is based upon |
| 204 | */ |
| 205 | public UiRegion getRegion(UiTopoLayout layout) { |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 206 | RegionId rid = layout.regionId(); |
| 207 | return rid == null ? sharedModel.getNullRegion() : sharedModel.getRegion(rid); |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 208 | } |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 209 | |
| 210 | /** |
Simon Hunt | 9818919 | 2016-07-29 19:02:27 -0700 | [diff] [blame] | 211 | * Returns the regions/devices that are "peers" to this region. That is, |
| 212 | * based on the layout the user is viewing, all the regions/devices that |
| 213 | * are associated with layouts that share the same parent layout as this |
| 214 | * layout, AND that are linked to an element within this region. |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 215 | * |
| 216 | * @param layout the layout being viewed |
Simon Hunt | 9818919 | 2016-07-29 19:02:27 -0700 | [diff] [blame] | 217 | * @return all regions/devices that are "siblings" to this layout's region |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 218 | */ |
Simon Hunt | 9818919 | 2016-07-29 19:02:27 -0700 | [diff] [blame] | 219 | public Set<UiNode> getPeerNodes(UiTopoLayout layout) { |
| 220 | Set<UiNode> peers = new HashSet<>(); |
| 221 | |
| 222 | // first, get the peer regions |
| 223 | Set<UiTopoLayout> peerLayouts = layoutService.getPeerLayouts(layout.id()); |
| 224 | peerLayouts.forEach(l -> { |
| 225 | RegionId peerRegion = l.regionId(); |
| 226 | peers.add(sharedModel.getRegion(peerRegion)); |
| 227 | }); |
| 228 | |
| 229 | // now add the devices that reside in the parent region |
| 230 | if (!layout.isRoot()) { |
| 231 | UiTopoLayout parentLayout = layoutService.getLayout(layout.parent()); |
Simon Hunt | 8f60ff8 | 2017-04-24 17:19:30 -0700 | [diff] [blame^] | 232 | peers.addAll(getRegion(parentLayout).devices()); |
Simon Hunt | 9818919 | 2016-07-29 19:02:27 -0700 | [diff] [blame] | 233 | } |
| 234 | |
| 235 | // TODO: Finally, filter out regions / devices that are not connected |
| 236 | // directly to this region by an implicit link |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 237 | return peers; |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 238 | } |
| 239 | |
| 240 | /** |
| 241 | * Returns the subregions of the region in the specified layout. |
| 242 | * |
| 243 | * @param layout the layout being viewed |
| 244 | * @return all regions that are "contained within" this layout's region |
| 245 | */ |
| 246 | public Set<UiRegion> getSubRegions(UiTopoLayout layout) { |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 247 | Set<UiTopoLayout> kidLayouts = layoutService.getChildren(layout.id()); |
| 248 | Set<UiRegion> kids = new HashSet<>(); |
| 249 | kidLayouts.forEach(l -> kids.add(sharedModel.getRegion(l.regionId()))); |
| 250 | return kids; |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 251 | } |
| 252 | |
| 253 | /** |
Simon Hunt | c13082f | 2016-08-03 21:20:23 -0700 | [diff] [blame] | 254 | * Returns the (synthetic) links of the region in the specified layout. |
| 255 | * |
| 256 | * @param layout the layout being viewed |
| 257 | * @return all links that are contained by this layout's region |
| 258 | */ |
| 259 | public List<UiSynthLink> getLinks(UiTopoLayout layout) { |
| 260 | return sharedModel.getSynthLinks(layout.regionId()); |
| 261 | } |
| 262 | |
| 263 | /** |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 264 | * Refreshes the model's internal state. |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 265 | */ |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 266 | public void refreshModel() { |
| 267 | sharedModel.refresh(); |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 268 | } |
Simon Hunt | 377f5d2 | 2016-09-01 16:27:21 -0700 | [diff] [blame] | 269 | |
| 270 | /** |
| 271 | * Navigates to the specified region by setting the associated layout as |
| 272 | * current. |
| 273 | * |
| 274 | * @param regionId region identifier |
| 275 | */ |
| 276 | public void navToRegion(String regionId) { |
| 277 | // 1. find the layout corresponding to the region ID |
| 278 | // 2. set this layout to be "current" |
| 279 | RegionId r = RegionId.regionId(regionId); |
| 280 | UiTopoLayout layout = layoutService.getLayout(r); |
| 281 | setCurrentLayout(layout); |
| 282 | } |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 283 | } |