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; |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 22 | import org.onosproject.ui.impl.topo.model.UiModelEvent; |
| 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 | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 28 | import org.onosproject.ui.model.topo.UiTopoLayout; |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 29 | import org.slf4j.Logger; |
| 30 | import org.slf4j.LoggerFactory; |
| 31 | |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 32 | import java.util.HashSet; |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 33 | import java.util.List; |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 34 | import java.util.Set; |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 35 | |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 36 | /** |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 37 | * Coordinates with the {@link UiTopoLayoutService} to access |
| 38 | * {@link UiTopoLayout}s, and with the {@link UiSharedTopologyModel} which |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 39 | * maintains a local model of the network entities, tailored specifically |
| 40 | * for displaying on the UI. |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 41 | * <p> |
| 42 | * Note that an instance of this class will be created for each |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 43 | * {@link UiWebSocket} connection, and will contain |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 44 | * 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] | 45 | * <p> |
| 46 | * The expected pattern is for the {@link Topo2ViewMessageHandler} to obtain |
| 47 | * a reference to the session instance (via the {@link UiWebSocket}), and |
| 48 | * interact with it when topo-related events come in from the client. |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 49 | */ |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 50 | public class UiTopoSession implements UiModelListener { |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 51 | |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 52 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 53 | |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 54 | private final UiWebSocket webSocket; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 55 | private final String username; |
| 56 | |
| 57 | final UiSharedTopologyModel sharedModel; |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 58 | |
| 59 | private boolean registered = false; |
| 60 | |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 61 | private UiTopoLayoutService layoutService; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 62 | private UiTopoLayout currentLayout; |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 63 | private boolean messagesEnabled; |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 64 | |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 65 | /** |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 66 | * Creates a new topology session for the specified web socket connection. |
| 67 | * |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 68 | * @param webSocket web socket |
| 69 | * @param model share topology model |
| 70 | * @param layoutService topology layout service |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 71 | */ |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 72 | public UiTopoSession(UiWebSocket webSocket, |
| 73 | UiSharedTopologyModel model, |
| 74 | UiTopoLayoutService layoutService) { |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 75 | this.webSocket = webSocket; |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 76 | this.username = webSocket.userName(); |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 77 | this.sharedModel = model; |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 78 | this.layoutService = layoutService; |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 79 | } |
| 80 | |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 81 | // constructs a neutered instance, for unit testing |
| 82 | UiTopoSession() { |
| 83 | webSocket = null; |
| 84 | username = null; |
| 85 | sharedModel = null; |
| 86 | } |
| 87 | |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 88 | /** |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 89 | * Initializes the session; registering with the shared model. |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 90 | */ |
| 91 | public void init() { |
| 92 | if (!registered) { |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 93 | log.debug("{} : Registering with shared model", this); |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 94 | sharedModel.register(this); |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 95 | currentLayout = layoutService.getRootLayout(); |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 96 | registered = true; |
| 97 | } else { |
| 98 | log.warn("already registered"); |
| 99 | } |
| 100 | } |
| 101 | |
| 102 | /** |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 103 | * Destroys the session; unregistering from the shared model. |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 104 | */ |
| 105 | public void destroy() { |
Simon Hunt | 7092cc4 | 2016-04-06 18:40:17 -0700 | [diff] [blame] | 106 | if (registered) { |
| 107 | log.debug("{} : Unregistering from shared model", this); |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 108 | sharedModel.unregister(this); |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 109 | registered = false; |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 110 | } else { |
| 111 | log.warn("already unregistered"); |
| 112 | } |
| 113 | } |
| 114 | |
| 115 | @Override |
| 116 | public String toString() { |
Simon Hunt | f679c4e | 2016-04-01 17:02:24 -0700 | [diff] [blame] | 117 | return String.format("{UiTopoSession for user <%s>}", username); |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 118 | } |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 119 | |
| 120 | @Override |
| 121 | public void event(UiModelEvent event) { |
Yuta HIGUCHI | 28ad09a | 2016-06-28 17:08:29 -0700 | [diff] [blame] | 122 | log.debug("Event received: {}", event); |
Simon Hunt | cda9c03 | 2016-04-11 10:32:54 -0700 | [diff] [blame] | 123 | // TODO: handle model events from the cache... |
| 124 | } |
Thomas Vachuska | 92b016b | 2016-05-20 11:37:57 -0700 | [diff] [blame] | 125 | |
| 126 | /** |
| 127 | * Returns the current layout context. |
| 128 | * |
| 129 | * @return current topology layout |
| 130 | */ |
| 131 | public UiTopoLayout currentLayout() { |
| 132 | return currentLayout; |
| 133 | } |
| 134 | |
| 135 | /** |
| 136 | * Changes the current layout context to the specified layout. |
| 137 | * |
| 138 | * @param topoLayout new topology layout context |
| 139 | */ |
| 140 | public void setCurrentLayout(UiTopoLayout topoLayout) { |
| 141 | currentLayout = topoLayout; |
| 142 | } |
| 143 | |
| 144 | /** |
| 145 | * Enables or disables the transmission of topology event update messages. |
| 146 | * |
| 147 | * @param enabled true if messages should be sent |
| 148 | */ |
| 149 | public void enableEvent(boolean enabled) { |
| 150 | messagesEnabled = enabled; |
| 151 | } |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 152 | |
| 153 | /** |
| 154 | * Returns the list of ONOS instances (cluster members). |
| 155 | * |
| 156 | * @return the list of ONOS instances |
| 157 | */ |
| 158 | public List<UiClusterMember> getAllInstances() { |
| 159 | return sharedModel.getClusterMembers(); |
| 160 | } |
| 161 | |
| 162 | /** |
| 163 | * Returns the region for the specified layout. |
| 164 | * |
| 165 | * @param layout layout filter |
| 166 | * @return region that the layout is based upon |
| 167 | */ |
| 168 | public UiRegion getRegion(UiTopoLayout layout) { |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 169 | RegionId rid = layout.regionId(); |
| 170 | return rid == null ? sharedModel.getNullRegion() : sharedModel.getRegion(rid); |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 171 | } |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 172 | |
| 173 | /** |
Simon Hunt | 9818919 | 2016-07-29 19:02:27 -0700 | [diff] [blame] | 174 | * Returns the regions/devices that are "peers" to this region. That is, |
| 175 | * based on the layout the user is viewing, all the regions/devices that |
| 176 | * are associated with layouts that share the same parent layout as this |
| 177 | * layout, AND that are linked to an element within this region. |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 178 | * |
| 179 | * @param layout the layout being viewed |
Simon Hunt | 9818919 | 2016-07-29 19:02:27 -0700 | [diff] [blame] | 180 | * @return all regions/devices that are "siblings" to this layout's region |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 181 | */ |
Simon Hunt | 9818919 | 2016-07-29 19:02:27 -0700 | [diff] [blame] | 182 | public Set<UiNode> getPeerNodes(UiTopoLayout layout) { |
| 183 | Set<UiNode> peers = new HashSet<>(); |
| 184 | |
| 185 | // first, get the peer regions |
| 186 | Set<UiTopoLayout> peerLayouts = layoutService.getPeerLayouts(layout.id()); |
| 187 | peerLayouts.forEach(l -> { |
| 188 | RegionId peerRegion = l.regionId(); |
| 189 | peers.add(sharedModel.getRegion(peerRegion)); |
| 190 | }); |
| 191 | |
| 192 | // now add the devices that reside in the parent region |
| 193 | if (!layout.isRoot()) { |
| 194 | UiTopoLayout parentLayout = layoutService.getLayout(layout.parent()); |
| 195 | getRegion(parentLayout).devices().forEach(peers::add); |
| 196 | } |
| 197 | |
| 198 | // TODO: Finally, filter out regions / devices that are not connected |
| 199 | // directly to this region by an implicit link |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 200 | return peers; |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 201 | } |
| 202 | |
| 203 | /** |
| 204 | * Returns the subregions of the region in the specified layout. |
| 205 | * |
| 206 | * @param layout the layout being viewed |
| 207 | * @return all regions that are "contained within" this layout's region |
| 208 | */ |
| 209 | public Set<UiRegion> getSubRegions(UiTopoLayout layout) { |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 210 | Set<UiTopoLayout> kidLayouts = layoutService.getChildren(layout.id()); |
| 211 | Set<UiRegion> kids = new HashSet<>(); |
| 212 | kidLayouts.forEach(l -> kids.add(sharedModel.getRegion(l.regionId()))); |
| 213 | return kids; |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 214 | } |
| 215 | |
| 216 | /** |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 217 | * Refreshes the model's internal state. |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 218 | */ |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 219 | public void refreshModel() { |
| 220 | sharedModel.refresh(); |
Simon Hunt | 977aa05 | 2016-07-20 17:08:29 -0700 | [diff] [blame] | 221 | } |
Simon Hunt | ed804d5 | 2016-03-30 09:51:40 -0700 | [diff] [blame] | 222 | } |