Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [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 | package org.onosproject.ui.impl; |
| 17 | |
Thomas Vachuska | 9ed335b | 2015-04-14 12:07:47 -0700 | [diff] [blame] | 18 | import com.fasterxml.jackson.databind.JsonNode; |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 19 | import com.fasterxml.jackson.databind.ObjectMapper; |
| 20 | import com.fasterxml.jackson.databind.node.ArrayNode; |
| 21 | import com.fasterxml.jackson.databind.node.BooleanNode; |
| 22 | import com.fasterxml.jackson.databind.node.DoubleNode; |
| 23 | import com.fasterxml.jackson.databind.node.IntNode; |
| 24 | import com.fasterxml.jackson.databind.node.JsonNodeFactory; |
| 25 | import com.fasterxml.jackson.databind.node.LongNode; |
| 26 | import com.fasterxml.jackson.databind.node.NullNode; |
| 27 | import com.fasterxml.jackson.databind.node.ObjectNode; |
| 28 | import com.fasterxml.jackson.databind.node.ShortNode; |
| 29 | import com.fasterxml.jackson.databind.node.TextNode; |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 30 | import com.google.common.collect.ImmutableList; |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 31 | import com.google.common.collect.ImmutableMap; |
Thomas Vachuska | 9ed335b | 2015-04-14 12:07:47 -0700 | [diff] [blame] | 32 | import com.google.common.collect.ImmutableSet; |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 33 | import com.google.common.collect.Lists; |
| 34 | import com.google.common.collect.Maps; |
| 35 | import org.apache.felix.scr.annotations.Activate; |
| 36 | import org.apache.felix.scr.annotations.Component; |
| 37 | import org.apache.felix.scr.annotations.Deactivate; |
Thomas Vachuska | 51f540f | 2015-05-27 17:26:57 -0700 | [diff] [blame] | 38 | import org.apache.felix.scr.annotations.Reference; |
| 39 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 40 | import org.apache.felix.scr.annotations.Service; |
Madan Jampani | bf8ee80 | 2016-05-04 14:07:36 -0700 | [diff] [blame] | 41 | import org.onlab.util.Tools; |
Thomas Vachuska | 51f540f | 2015-05-27 17:26:57 -0700 | [diff] [blame] | 42 | import org.onosproject.mastership.MastershipService; |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 43 | import org.onosproject.store.serializers.KryoNamespaces; |
Madan Jampani | 7b93ceb | 2016-05-04 09:58:40 -0700 | [diff] [blame] | 44 | import org.onosproject.store.service.ConsistentMap; |
| 45 | import org.onosproject.store.service.MapEvent; |
| 46 | import org.onosproject.store.service.MapEventListener; |
| 47 | import org.onosproject.store.service.Serializer; |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 48 | import org.onosproject.store.service.StorageService; |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 49 | import org.onosproject.ui.UiExtension; |
| 50 | import org.onosproject.ui.UiExtensionService; |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 51 | import org.onosproject.ui.UiMessageHandlerFactory; |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 52 | import org.onosproject.ui.UiPreferencesService; |
Simon Hunt | 1169c95 | 2017-06-05 11:20:11 -0700 | [diff] [blame] | 53 | import org.onosproject.ui.UiSessionToken; |
| 54 | import org.onosproject.ui.UiTokenService; |
Simon Hunt | 6cc8645 | 2017-04-27 17:46:22 -0700 | [diff] [blame] | 55 | import org.onosproject.ui.UiTopo2OverlayFactory; |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 56 | import org.onosproject.ui.UiTopoMap; |
Steven Burrows | 3a9a644 | 2016-05-05 15:31:16 +0100 | [diff] [blame] | 57 | import org.onosproject.ui.UiTopoMapFactory; |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 58 | import org.onosproject.ui.UiTopoOverlayFactory; |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 59 | import org.onosproject.ui.UiView; |
Simon Hunt | 1002cd8 | 2015-04-23 14:44:03 -0700 | [diff] [blame] | 60 | import org.onosproject.ui.UiViewHidden; |
Simon Hunt | e6f6461 | 2017-04-28 00:01:48 -0700 | [diff] [blame] | 61 | import org.onosproject.ui.impl.topo.Topo2TrafficMessageHandler; |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 62 | import org.onosproject.ui.impl.topo.Topo2ViewMessageHandler; |
Simon Hunt | 6cc8645 | 2017-04-27 17:46:22 -0700 | [diff] [blame] | 63 | import org.onosproject.ui.impl.topo.Traffic2Overlay; |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 64 | import org.slf4j.Logger; |
| 65 | import org.slf4j.LoggerFactory; |
| 66 | |
Simon Hunt | 1169c95 | 2017-06-05 11:20:11 -0700 | [diff] [blame] | 67 | import java.math.BigInteger; |
| 68 | import java.security.SecureRandom; |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 69 | import java.util.LinkedHashMap; |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 70 | import java.util.List; |
| 71 | import java.util.Map; |
Thomas Vachuska | 9ed335b | 2015-04-14 12:07:47 -0700 | [diff] [blame] | 72 | import java.util.Set; |
Madan Jampani | bf8ee80 | 2016-05-04 14:07:36 -0700 | [diff] [blame] | 73 | import java.util.concurrent.ExecutorService; |
| 74 | import java.util.concurrent.Executors; |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 75 | |
| 76 | import static com.google.common.collect.ImmutableList.of; |
| 77 | import static java.util.stream.Collectors.toSet; |
Heedo Kang | 4a47a30 | 2016-02-29 17:40:23 +0900 | [diff] [blame] | 78 | import static org.onosproject.security.AppGuard.checkPermission; |
| 79 | import static org.onosproject.security.AppPermission.Type.UI_READ; |
| 80 | import static org.onosproject.security.AppPermission.Type.UI_WRITE; |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 81 | import static org.onosproject.ui.UiView.Category.NETWORK; |
| 82 | import static org.onosproject.ui.UiView.Category.PLATFORM; |
Heedo Kang | 4a47a30 | 2016-02-29 17:40:23 +0900 | [diff] [blame] | 83 | |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 84 | /** |
| 85 | * Manages the user interface extensions. |
| 86 | */ |
| 87 | @Component(immediate = true) |
| 88 | @Service |
Simon Hunt | 3678c2a | 2016-03-28 14:48:07 -0700 | [diff] [blame] | 89 | public class UiExtensionManager |
Simon Hunt | 1169c95 | 2017-06-05 11:20:11 -0700 | [diff] [blame] | 90 | implements UiExtensionService, UiPreferencesService, SpriteService, |
| 91 | UiTokenService { |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 92 | |
Thomas Vachuska | fa74dd7 | 2016-03-20 19:11:12 -0700 | [diff] [blame] | 93 | private static final ClassLoader CL = UiExtensionManager.class.getClassLoader(); |
Simon Hunt | 3678c2a | 2016-03-28 14:48:07 -0700 | [diff] [blame] | 94 | |
Madan Jampani | 7b93ceb | 2016-05-04 09:58:40 -0700 | [diff] [blame] | 95 | private static final String ONOS_USER_PREFERENCES = "onos-ui-user-preferences"; |
Simon Hunt | 1169c95 | 2017-06-05 11:20:11 -0700 | [diff] [blame] | 96 | private static final String ONOS_SESSION_TOKENS = "onos-ui-session-tokens"; |
Simon Hunt | e05cae4 | 2015-07-23 17:35:24 -0700 | [diff] [blame] | 97 | private static final String CORE = "core"; |
Thomas Vachuska | fa74dd7 | 2016-03-20 19:11:12 -0700 | [diff] [blame] | 98 | private static final String GUI_ADDED = "guiAdded"; |
| 99 | private static final String GUI_REMOVED = "guiRemoved"; |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 100 | private static final String UPDATE_PREFS = "updatePrefs"; |
Simon Hunt | 3678c2a | 2016-03-28 14:48:07 -0700 | [diff] [blame] | 101 | private static final String SLASH = "/"; |
| 102 | |
| 103 | private static final int IDX_USER = 0; |
| 104 | private static final int IDX_KEY = 1; |
Simon Hunt | e05cae4 | 2015-07-23 17:35:24 -0700 | [diff] [blame] | 105 | |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 106 | private final Logger log = LoggerFactory.getLogger(getClass()); |
| 107 | |
| 108 | // List of all extensions |
| 109 | private final List<UiExtension> extensions = Lists.newArrayList(); |
| 110 | |
| 111 | // Map of views to extensions |
| 112 | private final Map<String, UiExtension> views = Maps.newHashMap(); |
| 113 | |
| 114 | // Core views & core extension |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 115 | private final UiExtension core = createCoreExtension(); |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 116 | |
Thomas Vachuska | 51f540f | 2015-05-27 17:26:57 -0700 | [diff] [blame] | 117 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 118 | protected MastershipService mastershipService; |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 119 | |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 120 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 121 | protected StorageService storageService; |
| 122 | |
| 123 | // User preferences |
Madan Jampani | 7b93ceb | 2016-05-04 09:58:40 -0700 | [diff] [blame] | 124 | private ConsistentMap<String, ObjectNode> prefsConsistentMap; |
| 125 | private Map<String, ObjectNode> prefs; |
| 126 | private final MapEventListener<String, ObjectNode> prefsListener = |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 127 | new InternalPrefsListener(); |
| 128 | |
Simon Hunt | 1169c95 | 2017-06-05 11:20:11 -0700 | [diff] [blame] | 129 | // Session tokens |
| 130 | private ConsistentMap<UiSessionToken, String> tokensConsistentMap; |
| 131 | private Map<UiSessionToken, String> tokens; |
| 132 | private final SessionTokenGenerator tokenGen = |
| 133 | new SessionTokenGenerator(); |
| 134 | |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 135 | private final ObjectMapper mapper = new ObjectMapper(); |
| 136 | |
Madan Jampani | bf8ee80 | 2016-05-04 14:07:36 -0700 | [diff] [blame] | 137 | private final ExecutorService eventHandlingExecutor = |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 138 | Executors.newSingleThreadExecutor( |
| 139 | Tools.groupedThreads("onos/ui-ext-manager", "event-handler", log)); |
Madan Jampani | bf8ee80 | 2016-05-04 14:07:36 -0700 | [diff] [blame] | 140 | |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 141 | // Creates core UI extension |
Simon Hunt | c54cd1b | 2015-05-11 13:43:44 -0700 | [diff] [blame] | 142 | private UiExtension createCoreExtension() { |
Simon Hunt | 20e1679 | 2015-04-24 14:29:39 -0700 | [diff] [blame] | 143 | List<UiView> coreViews = of( |
| 144 | new UiView(PLATFORM, "app", "Applications", "nav_apps"), |
Thomas Vachuska | aa8b0eb | 2015-05-22 09:54:15 -0700 | [diff] [blame] | 145 | new UiView(PLATFORM, "settings", "Settings", "nav_settings"), |
Simon Hunt | 20e1679 | 2015-04-24 14:29:39 -0700 | [diff] [blame] | 146 | new UiView(PLATFORM, "cluster", "Cluster Nodes", "nav_cluster"), |
Thomas Vachuska | 3ece373 | 2015-09-22 23:58:50 -0700 | [diff] [blame] | 147 | new UiView(PLATFORM, "processor", "Packet Processors", "nav_processors"), |
chengfan | c5a99dc | 2017-01-08 19:28:29 +0800 | [diff] [blame] | 148 | new UiView(PLATFORM, "partition", "Partitions", "nav_partitions"), |
Simon Hunt | 20e1679 | 2015-04-24 14:29:39 -0700 | [diff] [blame] | 149 | new UiView(NETWORK, "topo", "Topology", "nav_topo"), |
Simon Hunt | 47f8fb7 | 2017-04-11 13:49:31 -0700 | [diff] [blame] | 150 | new UiView(NETWORK, "topo2", "Topology 2", "nav_topo2"), |
Simon Hunt | 20e1679 | 2015-04-24 14:29:39 -0700 | [diff] [blame] | 151 | new UiView(NETWORK, "device", "Devices", "nav_devs"), |
| 152 | new UiViewHidden("flow"), |
Bri Prebilic Cole | ac829e4 | 2015-05-05 13:42:06 -0700 | [diff] [blame] | 153 | new UiViewHidden("port"), |
Bri Prebilic Cole | ff3dc67 | 2015-05-06 12:59:38 -0700 | [diff] [blame] | 154 | new UiViewHidden("group"), |
Jian Li | 1f54473 | 2015-12-30 23:36:37 -0800 | [diff] [blame] | 155 | new UiViewHidden("meter"), |
Simon Hunt | 20e1679 | 2015-04-24 14:29:39 -0700 | [diff] [blame] | 156 | new UiView(NETWORK, "link", "Links", "nav_links"), |
| 157 | new UiView(NETWORK, "host", "Hosts", "nav_hosts"), |
chengfan | b466a7e | 2015-08-21 09:59:29 -0500 | [diff] [blame] | 158 | new UiView(NETWORK, "intent", "Intents", "nav_intents"), |
Simon Hunt | 986b92f | 2016-06-03 15:46:59 -0700 | [diff] [blame] | 159 | new UiView(NETWORK, "tunnel", "Tunnels", "nav_tunnels") |
Simon Hunt | 20e1679 | 2015-04-24 14:29:39 -0700 | [diff] [blame] | 160 | ); |
Simon Hunt | 1002cd8 | 2015-04-23 14:44:03 -0700 | [diff] [blame] | 161 | |
Simon Hunt | 4c7edd3 | 2015-03-11 10:42:53 -0700 | [diff] [blame] | 162 | UiMessageHandlerFactory messageHandlerFactory = |
| 163 | () -> ImmutableList.of( |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 164 | new UserPreferencesMessageHandler(), |
Thomas Vachuska | e586b79 | 2015-03-26 13:59:38 -0700 | [diff] [blame] | 165 | new TopologyViewMessageHandler(), |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 166 | new Topo2ViewMessageHandler(), |
Simon Hunt | e6f6461 | 2017-04-28 00:01:48 -0700 | [diff] [blame] | 167 | new Topo2TrafficMessageHandler(), |
Thomas Vachuska | 26be4f3 | 2016-03-31 01:10:27 -0700 | [diff] [blame] | 168 | new MapSelectorMessageHandler(), |
Thomas Vachuska | e586b79 | 2015-03-26 13:59:38 -0700 | [diff] [blame] | 169 | new DeviceViewMessageHandler(), |
Thomas Vachuska | 583bc63 | 2015-04-14 10:10:57 -0700 | [diff] [blame] | 170 | new LinkViewMessageHandler(), |
Thomas Vachuska | 0fa583c | 2015-03-30 23:07:41 -0700 | [diff] [blame] | 171 | new HostViewMessageHandler(), |
Bri Prebilic Cole | cdc188d | 2015-04-24 16:40:11 -0700 | [diff] [blame] | 172 | new FlowViewMessageHandler(), |
Bri Prebilic Cole | ac829e4 | 2015-05-05 13:42:06 -0700 | [diff] [blame] | 173 | new PortViewMessageHandler(), |
Bri Prebilic Cole | ff3dc67 | 2015-05-06 12:59:38 -0700 | [diff] [blame] | 174 | new GroupViewMessageHandler(), |
Jian Li | 1f54473 | 2015-12-30 23:36:37 -0800 | [diff] [blame] | 175 | new MeterViewMessageHandler(), |
Bri Prebilic Cole | 384e8dc | 2015-04-13 15:51:14 -0700 | [diff] [blame] | 176 | new IntentViewMessageHandler(), |
Thomas Vachuska | 583bc63 | 2015-04-14 10:10:57 -0700 | [diff] [blame] | 177 | new ApplicationViewMessageHandler(), |
Thomas Vachuska | aa8b0eb | 2015-05-22 09:54:15 -0700 | [diff] [blame] | 178 | new SettingsViewMessageHandler(), |
chengfan | b466a7e | 2015-08-21 09:59:29 -0500 | [diff] [blame] | 179 | new ClusterViewMessageHandler(), |
Thomas Vachuska | 3ece373 | 2015-09-22 23:58:50 -0700 | [diff] [blame] | 180 | new ProcessorViewMessageHandler(), |
chengfan | c5a99dc | 2017-01-08 19:28:29 +0800 | [diff] [blame] | 181 | new TunnelViewMessageHandler(), |
| 182 | new PartitionViewMessageHandler() |
Simon Hunt | 4c7edd3 | 2015-03-11 10:42:53 -0700 | [diff] [blame] | 183 | ); |
Simon Hunt | 1002cd8 | 2015-04-23 14:44:03 -0700 | [diff] [blame] | 184 | |
Simon Hunt | e05cae4 | 2015-07-23 17:35:24 -0700 | [diff] [blame] | 185 | UiTopoOverlayFactory topoOverlayFactory = |
| 186 | () -> ImmutableList.of( |
Andrea Campanella | 732ea83 | 2017-02-06 09:25:59 -0800 | [diff] [blame] | 187 | new TrafficOverlay(), |
| 188 | new ProtectedIntentOverlay() |
Simon Hunt | e05cae4 | 2015-07-23 17:35:24 -0700 | [diff] [blame] | 189 | ); |
| 190 | |
Simon Hunt | 6cc8645 | 2017-04-27 17:46:22 -0700 | [diff] [blame] | 191 | UiTopo2OverlayFactory topo2OverlayFactory = |
| 192 | () -> ImmutableList.of( |
| 193 | new Traffic2Overlay() |
| 194 | ); |
| 195 | |
Steven Burrows | 3a9a644 | 2016-05-05 15:31:16 +0100 | [diff] [blame] | 196 | UiTopoMapFactory topoMapFactory = |
| 197 | () -> ImmutableList.of( |
| 198 | new UiTopoMap("australia", "Australia", "*australia", 1.0), |
| 199 | new UiTopoMap("americas", "North, Central and South America", "*americas", 0.7), |
| 200 | new UiTopoMap("n_america", "North America", "*n_america", 0.9), |
| 201 | new UiTopoMap("s_america", "South America", "*s_america", 0.9), |
Thomas Vachuska | cc0b7d6 | 2016-07-12 14:03:11 -0700 | [diff] [blame] | 202 | new UiTopoMap("usa", "United States", "*continental_us", 1.3), |
Steven Burrows | 3a9a644 | 2016-05-05 15:31:16 +0100 | [diff] [blame] | 203 | new UiTopoMap("bayareaGEO", "Bay Area, California", "*bayarea", 1.0), |
Thomas Vachuska | cc0b7d6 | 2016-07-12 14:03:11 -0700 | [diff] [blame] | 204 | new UiTopoMap("europe", "Europe", "*europe", 10.0), |
Steven Burrows | 3a9a644 | 2016-05-05 15:31:16 +0100 | [diff] [blame] | 205 | new UiTopoMap("italy", "Italy", "*italy", 0.8), |
Thomas Vachuska | cc0b7d6 | 2016-07-12 14:03:11 -0700 | [diff] [blame] | 206 | new UiTopoMap("uk", "United Kingdom and Ireland", "*uk", 2.0), |
Steven Burrows | 3a9a644 | 2016-05-05 15:31:16 +0100 | [diff] [blame] | 207 | new UiTopoMap("japan", "Japan", "*japan", 0.8), |
| 208 | new UiTopoMap("s_korea", "South Korea", "*s_korea", 0.75), |
| 209 | new UiTopoMap("taiwan", "Taiwan", "*taiwan", 0.7), |
| 210 | new UiTopoMap("africa", "Africa", "*africa", 0.7), |
| 211 | new UiTopoMap("oceania", "Oceania", "*oceania", 0.7), |
| 212 | new UiTopoMap("asia", "Asia", "*asia", 0.7) |
| 213 | ); |
| 214 | |
Simon Hunt | e05cae4 | 2015-07-23 17:35:24 -0700 | [diff] [blame] | 215 | return new UiExtension.Builder(CL, coreViews) |
| 216 | .messageHandlerFactory(messageHandlerFactory) |
| 217 | .topoOverlayFactory(topoOverlayFactory) |
Simon Hunt | 6cc8645 | 2017-04-27 17:46:22 -0700 | [diff] [blame] | 218 | .topo2OverlayFactory(topo2OverlayFactory) |
Steven Burrows | 3a9a644 | 2016-05-05 15:31:16 +0100 | [diff] [blame] | 219 | .topoMapFactory(topoMapFactory) |
Simon Hunt | e05cae4 | 2015-07-23 17:35:24 -0700 | [diff] [blame] | 220 | .resourcePath(CORE) |
| 221 | .build(); |
Thomas Vachuska | 3553b30 | 2015-03-07 14:49:43 -0800 | [diff] [blame] | 222 | } |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 223 | |
| 224 | @Activate |
| 225 | public void activate() { |
Madan Jampani | 7b93ceb | 2016-05-04 09:58:40 -0700 | [diff] [blame] | 226 | Serializer serializer = Serializer.using(KryoNamespaces.API, |
Simon Hunt | 6cc8645 | 2017-04-27 17:46:22 -0700 | [diff] [blame] | 227 | ObjectNode.class, ArrayNode.class, |
| 228 | JsonNodeFactory.class, LinkedHashMap.class, |
| 229 | TextNode.class, BooleanNode.class, |
| 230 | LongNode.class, DoubleNode.class, ShortNode.class, |
Simon Hunt | 1169c95 | 2017-06-05 11:20:11 -0700 | [diff] [blame] | 231 | IntNode.class, NullNode.class, UiSessionToken.class); |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 232 | |
Madan Jampani | 7b93ceb | 2016-05-04 09:58:40 -0700 | [diff] [blame] | 233 | prefsConsistentMap = storageService.<String, ObjectNode>consistentMapBuilder() |
Simon Hunt | 3678c2a | 2016-03-28 14:48:07 -0700 | [diff] [blame] | 234 | .withName(ONOS_USER_PREFERENCES) |
Madan Jampani | 7b93ceb | 2016-05-04 09:58:40 -0700 | [diff] [blame] | 235 | .withSerializer(serializer) |
| 236 | .withRelaxedReadConsistency() |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 237 | .build(); |
Madan Jampani | 7b93ceb | 2016-05-04 09:58:40 -0700 | [diff] [blame] | 238 | prefsConsistentMap.addListener(prefsListener); |
| 239 | prefs = prefsConsistentMap.asJavaMap(); |
Simon Hunt | 1169c95 | 2017-06-05 11:20:11 -0700 | [diff] [blame] | 240 | |
| 241 | tokensConsistentMap = storageService.<UiSessionToken, String>consistentMapBuilder() |
| 242 | .withName(ONOS_SESSION_TOKENS) |
| 243 | .withSerializer(serializer) |
| 244 | .withRelaxedReadConsistency() |
| 245 | .build(); |
| 246 | tokens = tokensConsistentMap.asJavaMap(); |
| 247 | |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 248 | register(core); |
| 249 | log.info("Started"); |
| 250 | } |
| 251 | |
| 252 | @Deactivate |
| 253 | public void deactivate() { |
Madan Jampani | 7b93ceb | 2016-05-04 09:58:40 -0700 | [diff] [blame] | 254 | prefsConsistentMap.removeListener(prefsListener); |
Madan Jampani | bf8ee80 | 2016-05-04 14:07:36 -0700 | [diff] [blame] | 255 | eventHandlingExecutor.shutdown(); |
Thomas Vachuska | 51f540f | 2015-05-27 17:26:57 -0700 | [diff] [blame] | 256 | UiWebSocketServlet.closeAll(); |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 257 | unregister(core); |
| 258 | log.info("Stopped"); |
| 259 | } |
| 260 | |
| 261 | @Override |
| 262 | public synchronized void register(UiExtension extension) { |
Heedo Kang | 4a47a30 | 2016-02-29 17:40:23 +0900 | [diff] [blame] | 263 | checkPermission(UI_WRITE); |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 264 | if (!extensions.contains(extension)) { |
| 265 | extensions.add(extension); |
| 266 | for (UiView view : extension.views()) { |
| 267 | views.put(view.id(), extension); |
| 268 | } |
Thomas Vachuska | fa74dd7 | 2016-03-20 19:11:12 -0700 | [diff] [blame] | 269 | UiWebSocketServlet.sendToAll(GUI_ADDED, null); |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 270 | } |
| 271 | } |
| 272 | |
| 273 | @Override |
| 274 | public synchronized void unregister(UiExtension extension) { |
Heedo Kang | 4a47a30 | 2016-02-29 17:40:23 +0900 | [diff] [blame] | 275 | checkPermission(UI_WRITE); |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 276 | extensions.remove(extension); |
Thomas Vachuska | fa74dd7 | 2016-03-20 19:11:12 -0700 | [diff] [blame] | 277 | extension.views().stream().map(UiView::id).collect(toSet()).forEach(views::remove); |
| 278 | UiWebSocketServlet.sendToAll(GUI_REMOVED, null); |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 279 | } |
| 280 | |
| 281 | @Override |
| 282 | public synchronized List<UiExtension> getExtensions() { |
Heedo Kang | 4a47a30 | 2016-02-29 17:40:23 +0900 | [diff] [blame] | 283 | checkPermission(UI_READ); |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 284 | return ImmutableList.copyOf(extensions); |
| 285 | } |
| 286 | |
| 287 | @Override |
| 288 | public synchronized UiExtension getViewExtension(String viewId) { |
Heedo Kang | 4a47a30 | 2016-02-29 17:40:23 +0900 | [diff] [blame] | 289 | checkPermission(UI_READ); |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 290 | return views.get(viewId); |
| 291 | } |
Thomas Vachuska | 9ed335b | 2015-04-14 12:07:47 -0700 | [diff] [blame] | 292 | |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 293 | @Override |
| 294 | public Set<String> getUserNames() { |
| 295 | ImmutableSet.Builder<String> builder = ImmutableSet.builder(); |
| 296 | prefs.keySet().forEach(k -> builder.add(userName(k))); |
| 297 | return builder.build(); |
| 298 | } |
| 299 | |
| 300 | @Override |
| 301 | public Map<String, ObjectNode> getPreferences(String userName) { |
| 302 | ImmutableMap.Builder<String, ObjectNode> builder = ImmutableMap.builder(); |
| 303 | prefs.entrySet().stream() |
Simon Hunt | 3678c2a | 2016-03-28 14:48:07 -0700 | [diff] [blame] | 304 | .filter(e -> e.getKey().startsWith(userName + SLASH)) |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 305 | .forEach(e -> builder.put(keyName(e.getKey()), e.getValue())); |
| 306 | return builder.build(); |
| 307 | } |
| 308 | |
| 309 | @Override |
| 310 | public void setPreference(String userName, String preference, ObjectNode value) { |
| 311 | prefs.put(key(userName, preference), value); |
| 312 | } |
| 313 | |
Simon Hunt | c54cd1b | 2015-05-11 13:43:44 -0700 | [diff] [blame] | 314 | // ===================================================================== |
Thomas Vachuska | 9ed335b | 2015-04-14 12:07:47 -0700 | [diff] [blame] | 315 | // Provisional tracking of sprite definitions |
Simon Hunt | c54cd1b | 2015-05-11 13:43:44 -0700 | [diff] [blame] | 316 | |
| 317 | private final Map<String, JsonNode> sprites = Maps.newHashMap(); |
Thomas Vachuska | 9ed335b | 2015-04-14 12:07:47 -0700 | [diff] [blame] | 318 | |
| 319 | @Override |
| 320 | public Set<String> getNames() { |
| 321 | return ImmutableSet.copyOf(sprites.keySet()); |
| 322 | } |
| 323 | |
| 324 | @Override |
| 325 | public void put(String name, JsonNode spriteData) { |
Simon Hunt | fd8c7d7 | 2015-04-14 17:53:37 -0700 | [diff] [blame] | 326 | log.info("Registered sprite definition [{}]", name); |
Thomas Vachuska | 9ed335b | 2015-04-14 12:07:47 -0700 | [diff] [blame] | 327 | sprites.put(name, spriteData); |
| 328 | } |
| 329 | |
| 330 | @Override |
| 331 | public JsonNode get(String name) { |
| 332 | return sprites.get(name); |
| 333 | } |
| 334 | |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 335 | private String key(String userName, String keyName) { |
Simon Hunt | 3678c2a | 2016-03-28 14:48:07 -0700 | [diff] [blame] | 336 | return userName + SLASH + keyName; |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 337 | } |
| 338 | |
Simon Hunt | 3678c2a | 2016-03-28 14:48:07 -0700 | [diff] [blame] | 339 | |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 340 | private String userName(String key) { |
Simon Hunt | 3678c2a | 2016-03-28 14:48:07 -0700 | [diff] [blame] | 341 | return key.split(SLASH)[IDX_USER]; |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 342 | } |
| 343 | |
| 344 | private String keyName(String key) { |
Simon Hunt | 3678c2a | 2016-03-28 14:48:07 -0700 | [diff] [blame] | 345 | return key.split(SLASH)[IDX_KEY]; |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 346 | } |
| 347 | |
Simon Hunt | 1169c95 | 2017-06-05 11:20:11 -0700 | [diff] [blame] | 348 | |
| 349 | // ===================================================================== |
| 350 | // UiTokenService |
| 351 | |
| 352 | @Override |
| 353 | public UiSessionToken issueToken(String username) { |
| 354 | UiSessionToken token = new UiSessionToken(tokenGen.nextSessionId()); |
| 355 | tokens.put(token, username); |
| 356 | log.debug("UiSessionToken issued: {}", token); |
| 357 | return token; |
| 358 | } |
| 359 | |
| 360 | @Override |
| 361 | public void revokeToken(UiSessionToken token) { |
| 362 | if (token != null) { |
| 363 | tokens.remove(token); |
| 364 | log.debug("UiSessionToken revoked: {}", token); |
| 365 | } |
| 366 | } |
| 367 | |
| 368 | @Override |
| 369 | public boolean isTokenValid(UiSessionToken token) { |
| 370 | return token != null && tokens.containsKey(token); |
| 371 | } |
| 372 | |
| 373 | private final class SessionTokenGenerator { |
| 374 | private final SecureRandom random = new SecureRandom(); |
| 375 | |
| 376 | /* |
| 377 | This works by choosing 130 bits from a cryptographically secure |
| 378 | random bit generator, and encoding them in base-32. |
| 379 | |
| 380 | 128 bits is considered to be cryptographically strong, but each |
| 381 | digit in a base 32 number can encode 5 bits, so 128 is rounded up |
| 382 | to the next multiple of 5. |
| 383 | |
| 384 | This encoding is compact and efficient, with 5 random bits per |
| 385 | character. Compare this to a random UUID, which only has 3.4 bits |
| 386 | per character in standard layout, and only 122 random bits in total. |
| 387 | |
| 388 | Note that SecureRandom objects are expensive to initialize, so |
| 389 | we'll want to keep it around and re-use it. |
| 390 | */ |
| 391 | |
| 392 | private String nextSessionId() { |
| 393 | return new BigInteger(130, random).toString(32); |
| 394 | } |
| 395 | } |
| 396 | |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 397 | // Auxiliary listener to preference map events. |
| 398 | private class InternalPrefsListener |
Madan Jampani | 7b93ceb | 2016-05-04 09:58:40 -0700 | [diff] [blame] | 399 | implements MapEventListener<String, ObjectNode> { |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 400 | @Override |
Madan Jampani | 7b93ceb | 2016-05-04 09:58:40 -0700 | [diff] [blame] | 401 | public void event(MapEvent<String, ObjectNode> event) { |
Madan Jampani | bf8ee80 | 2016-05-04 14:07:36 -0700 | [diff] [blame] | 402 | eventHandlingExecutor.execute(() -> { |
| 403 | String userName = userName(event.key()); |
| 404 | if (event.type() == MapEvent.Type.INSERT || event.type() == MapEvent.Type.UPDATE) { |
| 405 | UiWebSocketServlet.sendToUser(userName, UPDATE_PREFS, jsonPrefs()); |
| 406 | } |
| 407 | }); |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 408 | } |
| 409 | |
| 410 | private ObjectNode jsonPrefs() { |
| 411 | ObjectNode json = mapper.createObjectNode(); |
Simon Hunt | 1169c95 | 2017-06-05 11:20:11 -0700 | [diff] [blame] | 412 | prefs.forEach((key, value) -> json.set(keyName(key), value)); |
Thomas Vachuska | 0af2691 | 2016-03-21 21:37:30 -0700 | [diff] [blame] | 413 | return json; |
| 414 | } |
| 415 | } |
Thomas Vachuska | fe8c98a | 2015-02-04 01:24:32 -0800 | [diff] [blame] | 416 | } |