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