| /* |
| * Copyright 2015-present Open Networking Laboratory |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.onosproject.ui.impl; |
| |
| import com.fasterxml.jackson.databind.JsonNode; |
| import com.fasterxml.jackson.databind.node.ArrayNode; |
| import com.fasterxml.jackson.databind.node.ObjectNode; |
| import org.onlab.osgi.ServiceDirectory; |
| import org.onlab.packet.IpAddress; |
| import org.onlab.util.DefaultHashMap; |
| import org.onosproject.cluster.ClusterEvent; |
| import org.onosproject.cluster.ClusterService; |
| import org.onosproject.cluster.ControllerNode; |
| import org.onosproject.cluster.NodeId; |
| import org.onosproject.core.CoreService; |
| import org.onosproject.incubator.net.PortStatisticsService; |
| import org.onosproject.incubator.net.tunnel.OpticalTunnelEndPoint; |
| import org.onosproject.incubator.net.tunnel.Tunnel; |
| import org.onosproject.incubator.net.tunnel.TunnelService; |
| import org.onosproject.mastership.MastershipService; |
| import org.onosproject.net.Annotated; |
| import org.onosproject.net.AnnotationKeys; |
| import org.onosproject.net.Annotations; |
| import org.onosproject.net.ConnectPoint; |
| import org.onosproject.net.DefaultEdgeLink; |
| import org.onosproject.net.Device; |
| import org.onosproject.net.DeviceId; |
| import org.onosproject.net.EdgeLink; |
| import org.onosproject.net.ElementId; |
| import org.onosproject.net.Host; |
| import org.onosproject.net.HostId; |
| import org.onosproject.net.HostLocation; |
| import org.onosproject.net.Link; |
| import org.onosproject.net.device.DeviceEvent; |
| import org.onosproject.net.device.DeviceService; |
| import org.onosproject.net.flow.FlowEntry; |
| import org.onosproject.net.flow.FlowRuleService; |
| import org.onosproject.net.host.HostEvent; |
| import org.onosproject.net.host.HostService; |
| import org.onosproject.net.intent.IntentService; |
| import org.onosproject.net.link.LinkEvent; |
| import org.onosproject.net.link.LinkService; |
| import org.onosproject.net.provider.ProviderId; |
| import org.onosproject.net.statistic.StatisticService; |
| import org.onosproject.net.topology.Topology; |
| import org.onosproject.net.topology.TopologyService; |
| import org.onosproject.ui.JsonUtils; |
| import org.onosproject.ui.UiConnection; |
| import org.onosproject.ui.UiMessageHandler; |
| import org.onosproject.ui.impl.topo.util.ServicesBundle; |
| import org.onosproject.ui.topo.PropertyPanel; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| import java.util.Collection; |
| import java.util.Collections; |
| import java.util.Iterator; |
| import java.util.Map; |
| import java.util.Optional; |
| import java.util.Set; |
| import java.util.concurrent.ConcurrentHashMap; |
| |
| import static com.google.common.base.Preconditions.checkNotNull; |
| import static com.google.common.base.Strings.isNullOrEmpty; |
| import static org.onosproject.net.PortNumber.portNumber; |
| import static org.onosproject.ui.topo.TopoConstants.CoreButtons; |
| import static org.onosproject.ui.topo.TopoConstants.Properties; |
| import static org.onosproject.ui.topo.TopoUtils.compactLinkString; |
| |
| /** |
| * Facility for creating messages bound for the topology viewer. |
| */ |
| public abstract class TopologyViewMessageHandlerBase extends UiMessageHandler { |
| |
| private static final String NO_GEO_VALUE = "0.0"; |
| |
| // default to an "add" event... |
| private static final DefaultHashMap<ClusterEvent.Type, String> CLUSTER_EVENT = |
| new DefaultHashMap<>("addInstance"); |
| |
| // default to an "update" event... |
| private static final DefaultHashMap<DeviceEvent.Type, String> DEVICE_EVENT = |
| new DefaultHashMap<>("updateDevice"); |
| private static final DefaultHashMap<LinkEvent.Type, String> LINK_EVENT = |
| new DefaultHashMap<>("updateLink"); |
| private static final DefaultHashMap<HostEvent.Type, String> HOST_EVENT = |
| new DefaultHashMap<>("updateHost"); |
| |
| // but call out specific events that we care to differentiate... |
| static { |
| CLUSTER_EVENT.put(ClusterEvent.Type.INSTANCE_REMOVED, "removeInstance"); |
| |
| DEVICE_EVENT.put(DeviceEvent.Type.DEVICE_ADDED, "addDevice"); |
| DEVICE_EVENT.put(DeviceEvent.Type.DEVICE_REMOVED, "removeDevice"); |
| |
| LINK_EVENT.put(LinkEvent.Type.LINK_ADDED, "addLink"); |
| LINK_EVENT.put(LinkEvent.Type.LINK_REMOVED, "removeLink"); |
| |
| HOST_EVENT.put(HostEvent.Type.HOST_ADDED, "addHost"); |
| HOST_EVENT.put(HostEvent.Type.HOST_REMOVED, "removeHost"); |
| HOST_EVENT.put(HostEvent.Type.HOST_MOVED, "moveHost"); |
| } |
| |
| protected static final Logger log = |
| LoggerFactory.getLogger(TopologyViewMessageHandlerBase.class); |
| |
| private static final ProviderId PID = |
| new ProviderId("core", "org.onosproject.core", true); |
| |
| protected static final String SHOW_HIGHLIGHTS = "showHighlights"; |
| |
| protected ServiceDirectory directory; |
| protected ClusterService clusterService; |
| protected DeviceService deviceService; |
| protected LinkService linkService; |
| protected HostService hostService; |
| protected MastershipService mastershipService; |
| protected IntentService intentService; |
| protected FlowRuleService flowService; |
| protected StatisticService flowStatsService; |
| protected PortStatisticsService portStatsService; |
| protected TopologyService topologyService; |
| protected TunnelService tunnelService; |
| |
| protected ServicesBundle servicesBundle; |
| |
| private String version; |
| |
| // TODO: extract into an external & durable state; good enough for now and demo |
| private static Map<String, ObjectNode> metaUi = new ConcurrentHashMap<>(); |
| |
| /** |
| * Returns read-only view of the meta-ui information. |
| * |
| * @return map of id to meta-ui mementos |
| */ |
| static Map<String, ObjectNode> getMetaUi() { |
| return Collections.unmodifiableMap(metaUi); |
| } |
| |
| @Override |
| public void init(UiConnection connection, ServiceDirectory directory) { |
| super.init(connection, directory); |
| this.directory = checkNotNull(directory, "Directory cannot be null"); |
| clusterService = directory.get(ClusterService.class); |
| deviceService = directory.get(DeviceService.class); |
| linkService = directory.get(LinkService.class); |
| hostService = directory.get(HostService.class); |
| mastershipService = directory.get(MastershipService.class); |
| intentService = directory.get(IntentService.class); |
| flowService = directory.get(FlowRuleService.class); |
| flowStatsService = directory.get(StatisticService.class); |
| portStatsService = directory.get(PortStatisticsService.class); |
| topologyService = directory.get(TopologyService.class); |
| tunnelService = directory.get(TunnelService.class); |
| |
| servicesBundle = new ServicesBundle(intentService, deviceService, |
| hostService, linkService, |
| flowService, |
| flowStatsService, portStatsService); |
| |
| String ver = directory.get(CoreService.class).version().toString(); |
| version = ver.replace(".SNAPSHOT", "*").replaceFirst("~.*$", ""); |
| } |
| |
| // Returns the specified set of IP addresses as a string. |
| private String ip(Set<IpAddress> ipAddresses) { |
| Iterator<IpAddress> it = ipAddresses.iterator(); |
| return it.hasNext() ? it.next().toString() : "unknown"; |
| } |
| |
| // Produces JSON structure from annotations. |
| private JsonNode props(Annotations annotations) { |
| ObjectNode props = objectNode(); |
| if (annotations != null) { |
| for (String key : annotations.keys()) { |
| props.put(key, annotations.value(key)); |
| } |
| } |
| return props; |
| } |
| |
| // Produces an informational log message event bound to the client. |
| protected ObjectNode info(long id, String message) { |
| return message("info", id, message); |
| } |
| |
| // Produces a warning log message event bound to the client. |
| protected ObjectNode warning(long id, String message) { |
| return message("warning", id, message); |
| } |
| |
| // Produces an error log message event bound to the client. |
| protected ObjectNode error(long id, String message) { |
| return message("error", id, message); |
| } |
| |
| // Produces a log message event bound to the client. |
| private ObjectNode message(String severity, long id, String message) { |
| ObjectNode payload = objectNode() |
| .put("severity", severity) |
| .put("message", message); |
| |
| return JsonUtils.envelope("message", id, payload); |
| } |
| |
| // Produces a cluster instance message to the client. |
| protected ObjectNode instanceMessage(ClusterEvent event, String msgType) { |
| ControllerNode node = event.subject(); |
| int switchCount = mastershipService.getDevicesOf(node.id()).size(); |
| ObjectNode payload = objectNode() |
| .put("id", node.id().toString()) |
| .put("ip", node.ip().toString()) |
| .put("online", clusterService.getState(node.id()).isActive()) |
| .put("ready", clusterService.getState(node.id()).isReady()) |
| .put("uiAttached", node.equals(clusterService.getLocalNode())) |
| .put("switches", switchCount); |
| |
| ArrayNode labels = arrayNode(); |
| labels.add(node.id().toString()); |
| labels.add(node.ip().toString()); |
| |
| // Add labels, props and stuff the payload into envelope. |
| payload.set("labels", labels); |
| addMetaUi(node.id().toString(), payload); |
| |
| String type = msgType != null ? msgType : CLUSTER_EVENT.get(event.type()); |
| return JsonUtils.envelope(type, 0, payload); |
| } |
| |
| // Produces a device event message to the client. |
| protected ObjectNode deviceMessage(DeviceEvent event) { |
| Device device = event.subject(); |
| String uiType = device.annotations().value(AnnotationKeys.UI_TYPE); |
| String devType = uiType != null ? uiType : |
| device.type().toString().toLowerCase(); |
| |
| ObjectNode payload = objectNode() |
| .put("id", device.id().toString()) |
| .put("type", devType) |
| .put("online", deviceService.isAvailable(device.id())) |
| .put("master", master(device.id())); |
| |
| // Generate labels: id, chassis id, no-label, optional-name |
| String name = device.annotations().value(AnnotationKeys.NAME); |
| ArrayNode labels = arrayNode(); |
| labels.add(""); |
| labels.add(isNullOrEmpty(name) ? device.id().toString() : name); |
| labels.add(device.id().toString()); |
| |
| // Add labels, props and stuff the payload into envelope. |
| payload.set("labels", labels); |
| payload.set("props", props(device.annotations())); |
| addGeoLocation(device, payload); |
| addMetaUi(device.id().toString(), payload); |
| |
| String type = DEVICE_EVENT.get(event.type()); |
| return JsonUtils.envelope(type, 0, payload); |
| } |
| |
| // Produces a link event message to the client. |
| protected ObjectNode linkMessage(LinkEvent event) { |
| Link link = event.subject(); |
| ObjectNode payload = objectNode() |
| .put("id", compactLinkString(link)) |
| .put("type", link.type().toString().toLowerCase()) |
| .put("expected", link.isExpected()) |
| .put("online", link.state() == Link.State.ACTIVE) |
| .put("linkWidth", 1.2) |
| .put("src", link.src().deviceId().toString()) |
| .put("srcPort", link.src().port().toString()) |
| .put("dst", link.dst().deviceId().toString()) |
| .put("dstPort", link.dst().port().toString()); |
| String type = LINK_EVENT.get(event.type()); |
| return JsonUtils.envelope(type, 0, payload); |
| } |
| |
| // Produces a host event message to the client. |
| protected ObjectNode hostMessage(HostEvent event) { |
| Host host = event.subject(); |
| Host prevHost = event.prevSubject(); |
| String hostType = host.annotations().value(AnnotationKeys.UI_TYPE); |
| |
| ObjectNode payload = objectNode() |
| .put("id", host.id().toString()) |
| .put("type", isNullOrEmpty(hostType) ? "endstation" : hostType) |
| .put("ingress", compactLinkString(edgeLink(host, true))) |
| .put("egress", compactLinkString(edgeLink(host, false))); |
| payload.set("cp", hostConnect(host.location())); |
| if (prevHost != null && prevHost.location() != null) { |
| payload.set("prevCp", hostConnect(prevHost.location())); |
| } |
| payload.set("labels", labels(ip(host.ipAddresses()), |
| host.mac().toString())); |
| payload.set("props", props(host.annotations())); |
| addGeoLocation(host, payload); |
| addMetaUi(host.id().toString(), payload); |
| |
| String type = HOST_EVENT.get(event.type()); |
| return JsonUtils.envelope(type, 0, payload); |
| } |
| |
| // Encodes the specified host location into a JSON object. |
| private ObjectNode hostConnect(HostLocation location) { |
| return objectNode() |
| .put("device", location.deviceId().toString()) |
| .put("port", location.port().toLong()); |
| } |
| |
| // Encodes the specified list of labels a JSON array. |
| private ArrayNode labels(String... labels) { |
| ArrayNode json = arrayNode(); |
| for (String label : labels) { |
| json.add(label); |
| } |
| return json; |
| } |
| |
| // Returns the name of the master node for the specified device id. |
| private String master(DeviceId deviceId) { |
| NodeId master = mastershipService.getMasterFor(deviceId); |
| return master != null ? master.toString() : ""; |
| } |
| |
| // Generates an edge link from the specified host location. |
| private EdgeLink edgeLink(Host host, boolean ingress) { |
| return new DefaultEdgeLink(PID, new ConnectPoint(host.id(), portNumber(0)), |
| host.location(), ingress); |
| } |
| |
| // Adds meta UI information for the specified object. |
| private void addMetaUi(String id, ObjectNode payload) { |
| ObjectNode meta = metaUi.get(id); |
| if (meta != null) { |
| payload.set("metaUi", meta); |
| } |
| } |
| |
| // Adds a geo location JSON to the specified payload object. |
| private void addGeoLocation(Annotated annotated, ObjectNode payload) { |
| Annotations annotations = annotated.annotations(); |
| if (annotations == null) { |
| return; |
| } |
| |
| String slng = annotations.value(AnnotationKeys.LONGITUDE); |
| String slat = annotations.value(AnnotationKeys.LATITUDE); |
| boolean validLng = slng != null && !slng.equals(NO_GEO_VALUE); |
| boolean validLat = slat != null && !slat.equals(NO_GEO_VALUE); |
| if (validLat && validLng) { |
| try { |
| double lng = Double.parseDouble(slng); |
| double lat = Double.parseDouble(slat); |
| ObjectNode loc = objectNode() |
| .put("type", "geo") |
| .put("lng", lng) |
| .put("lat", lat); |
| payload.set("location", loc); |
| } catch (NumberFormatException e) { |
| log.warn("Invalid geo data: longitude={}, latitude={}", slng, slat); |
| } |
| } |
| } |
| |
| // Updates meta UI information for the specified object. |
| protected void updateMetaUi(ObjectNode payload) { |
| metaUi.put(JsonUtils.string(payload, "id"), |
| JsonUtils.node(payload, "memento")); |
| } |
| |
| |
| // ----------------------------------------------------------------------- |
| // Create models of the data to return, that overlays can adjust / augment |
| |
| // Returns property panel model for summary response. |
| protected PropertyPanel summmaryMessage() { |
| Topology topology = topologyService.currentTopology(); |
| |
| return new PropertyPanel("ONOS Summary", "node") |
| .addProp(Properties.VERSION, version) |
| .addSeparator() |
| .addProp(Properties.DEVICES, deviceService.getDeviceCount()) |
| .addProp(Properties.LINKS, topology.linkCount()) |
| .addProp(Properties.HOSTS, hostService.getHostCount()) |
| .addProp(Properties.TOPOLOGY_SSCS, topology.clusterCount()) |
| .addSeparator() |
| .addProp(Properties.INTENTS, intentService.getIntentCount()) |
| .addProp(Properties.TUNNELS, tunnelService.tunnelCount()) |
| .addProp(Properties.FLOWS, flowService.getFlowRuleCount()); |
| } |
| |
| // Returns property panel model for device details response. |
| protected PropertyPanel deviceDetails(DeviceId deviceId) { |
| Device device = deviceService.getDevice(deviceId); |
| Annotations annot = device.annotations(); |
| String name = annot.value(AnnotationKeys.NAME); |
| int portCount = deviceService.getPorts(deviceId).size(); |
| int flowCount = getFlowCount(deviceId); |
| int tunnelCount = getTunnelCount(deviceId); |
| |
| String title = isNullOrEmpty(name) ? deviceId.toString() : name; |
| String typeId = device.type().toString().toLowerCase(); |
| |
| PropertyPanel pp = new PropertyPanel(title, typeId) |
| .id(deviceId.toString()) |
| |
| .addProp(Properties.URI, deviceId.toString()) |
| .addProp(Properties.VENDOR, device.manufacturer()) |
| .addProp(Properties.HW_VERSION, device.hwVersion()) |
| .addProp(Properties.SW_VERSION, device.swVersion()) |
| .addProp(Properties.SERIAL_NUMBER, device.serialNumber()) |
| .addProp(Properties.PROTOCOL, annot.value(AnnotationKeys.PROTOCOL)) |
| .addSeparator() |
| |
| .addProp(Properties.LATITUDE, annot.value(AnnotationKeys.LATITUDE)) |
| .addProp(Properties.LONGITUDE, annot.value(AnnotationKeys.LONGITUDE)) |
| .addSeparator() |
| |
| .addProp(Properties.PORTS, portCount) |
| .addProp(Properties.FLOWS, flowCount) |
| .addProp(Properties.TUNNELS, tunnelCount) |
| |
| .addButton(CoreButtons.SHOW_DEVICE_VIEW) |
| .addButton(CoreButtons.SHOW_FLOW_VIEW) |
| .addButton(CoreButtons.SHOW_PORT_VIEW) |
| .addButton(CoreButtons.SHOW_GROUP_VIEW) |
| .addButton(CoreButtons.SHOW_METER_VIEW); |
| |
| return pp; |
| } |
| |
| protected int getFlowCount(DeviceId deviceId) { |
| int count = 0; |
| for (FlowEntry flowEntry : flowService.getFlowEntries(deviceId)) { |
| count++; |
| } |
| return count; |
| } |
| |
| protected int getTunnelCount(DeviceId deviceId) { |
| int count = 0; |
| Collection<Tunnel> tunnels = tunnelService.queryAllTunnels(); |
| for (Tunnel tunnel : tunnels) { |
| //Only OpticalTunnelEndPoint has a device |
| if (!(tunnel.src() instanceof OpticalTunnelEndPoint) || |
| !(tunnel.dst() instanceof OpticalTunnelEndPoint)) { |
| continue; |
| } |
| |
| Optional<ElementId> srcElementId = ((OpticalTunnelEndPoint) tunnel.src()).elementId(); |
| Optional<ElementId> dstElementId = ((OpticalTunnelEndPoint) tunnel.dst()).elementId(); |
| if (!srcElementId.isPresent() || !dstElementId.isPresent()) { |
| continue; |
| } |
| DeviceId srcDeviceId = (DeviceId) srcElementId.get(); |
| DeviceId dstDeviceId = (DeviceId) dstElementId.get(); |
| if (srcDeviceId.equals(deviceId) || dstDeviceId.equals(deviceId)) { |
| count++; |
| } |
| } |
| return count; |
| } |
| |
| // Returns host details response. |
| protected PropertyPanel hostDetails(HostId hostId) { |
| Host host = hostService.getHost(hostId); |
| Annotations annot = host.annotations(); |
| String type = annot.value(AnnotationKeys.TYPE); |
| String name = annot.value(AnnotationKeys.NAME); |
| String vlan = host.vlan().toString(); |
| |
| String title = isNullOrEmpty(name) ? hostId.toString() : name; |
| String typeId = isNullOrEmpty(type) ? "endstation" : type; |
| |
| PropertyPanel pp = new PropertyPanel(title, typeId) |
| .id(hostId.toString()) |
| .addProp(Properties.MAC, host.mac()) |
| .addProp(Properties.IP, host.ipAddresses(), "[\\[\\]]") |
| .addProp(Properties.VLAN, "-1".equals(vlan) ? "none" : vlan) |
| .addSeparator() |
| .addProp(Properties.LATITUDE, annot.value(AnnotationKeys.LATITUDE)) |
| .addProp(Properties.LONGITUDE, annot.value(AnnotationKeys.LONGITUDE)); |
| |
| // Potentially add button descriptors here |
| return pp; |
| } |
| |
| } |