tom | be98831 | 2014-09-19 18:38:47 -0700 | [diff] [blame] | 1 | package org.onlab.onos.net.topology.impl; |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 2 | |
| 3 | import org.apache.felix.scr.annotations.Activate; |
| 4 | import org.apache.felix.scr.annotations.Component; |
| 5 | import org.apache.felix.scr.annotations.Deactivate; |
| 6 | import org.apache.felix.scr.annotations.Reference; |
| 7 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 8 | import org.apache.felix.scr.annotations.Service; |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 9 | import org.onlab.onos.event.AbstractListenerRegistry; |
| 10 | import org.onlab.onos.event.Event; |
| 11 | import org.onlab.onos.event.EventDeliveryService; |
| 12 | import org.onlab.onos.net.ConnectPoint; |
| 13 | import org.onlab.onos.net.DeviceId; |
tom | 13cb485 | 2014-09-11 12:44:17 -0700 | [diff] [blame] | 14 | import org.onlab.onos.net.Link; |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 15 | import org.onlab.onos.net.Path; |
| 16 | import org.onlab.onos.net.provider.AbstractProviderRegistry; |
| 17 | import org.onlab.onos.net.provider.AbstractProviderService; |
tom | 13cb485 | 2014-09-11 12:44:17 -0700 | [diff] [blame] | 18 | import org.onlab.onos.net.topology.ClusterId; |
tom | 9793755 | 2014-09-11 10:48:42 -0700 | [diff] [blame] | 19 | import org.onlab.onos.net.topology.GraphDescription; |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 20 | import org.onlab.onos.net.topology.LinkWeight; |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 21 | import org.onlab.onos.net.topology.Topology; |
| 22 | import org.onlab.onos.net.topology.TopologyCluster; |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 23 | import org.onlab.onos.net.topology.TopologyEvent; |
tom | 9793755 | 2014-09-11 10:48:42 -0700 | [diff] [blame] | 24 | import org.onlab.onos.net.topology.TopologyGraph; |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 25 | import org.onlab.onos.net.topology.TopologyListener; |
| 26 | import org.onlab.onos.net.topology.TopologyProvider; |
| 27 | import org.onlab.onos.net.topology.TopologyProviderRegistry; |
| 28 | import org.onlab.onos.net.topology.TopologyProviderService; |
| 29 | import org.onlab.onos.net.topology.TopologyService; |
tom | 10262dd | 2014-09-19 10:51:19 -0700 | [diff] [blame] | 30 | import org.onlab.onos.net.topology.TopologyStore; |
tom | c78acee | 2014-09-24 15:16:55 -0700 | [diff] [blame] | 31 | import org.onlab.onos.net.topology.TopologyStoreDelegate; |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 32 | import org.slf4j.Logger; |
| 33 | |
| 34 | import java.util.List; |
| 35 | import java.util.Set; |
| 36 | |
| 37 | import static com.google.common.base.Preconditions.checkNotNull; |
| 38 | import static org.slf4j.LoggerFactory.getLogger; |
| 39 | |
| 40 | /** |
| 41 | * Provides basic implementation of the topology SB & NB APIs. |
| 42 | */ |
| 43 | @Component(immediate = true) |
| 44 | @Service |
tom | 10262dd | 2014-09-19 10:51:19 -0700 | [diff] [blame] | 45 | public class TopologyManager |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 46 | extends AbstractProviderRegistry<TopologyProvider, TopologyProviderService> |
| 47 | implements TopologyService, TopologyProviderRegistry { |
| 48 | |
| 49 | public static final String TOPOLOGY_NULL = "Topology cannot be null"; |
| 50 | private static final String DEVICE_ID_NULL = "Device ID cannot be null"; |
tom | 13cb485 | 2014-09-11 12:44:17 -0700 | [diff] [blame] | 51 | private static final String CLUSTER_ID_NULL = "Cluster ID cannot be null"; |
| 52 | private static final String CLUSTER_NULL = "Topology cluster cannot be null"; |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 53 | public static final String CONNECTION_POINT_NULL = "Connection point cannot be null"; |
| 54 | |
| 55 | private final Logger log = getLogger(getClass()); |
| 56 | |
| 57 | private final AbstractListenerRegistry<TopologyEvent, TopologyListener> |
| 58 | listenerRegistry = new AbstractListenerRegistry<>(); |
| 59 | |
tom | c78acee | 2014-09-24 15:16:55 -0700 | [diff] [blame] | 60 | private TopologyStoreDelegate delegate = new InternalStoreDelegate(); |
| 61 | |
tom | 10262dd | 2014-09-19 10:51:19 -0700 | [diff] [blame] | 62 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 63 | protected TopologyStore store; |
tom | 0efbb1d | 2014-09-09 11:54:28 -0700 | [diff] [blame] | 64 | |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 65 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
tom | 4d0dd3a | 2014-09-14 23:12:28 -0700 | [diff] [blame] | 66 | protected EventDeliveryService eventDispatcher; |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 67 | |
| 68 | |
| 69 | @Activate |
| 70 | public void activate() { |
tom | c78acee | 2014-09-24 15:16:55 -0700 | [diff] [blame] | 71 | store.setDelegate(delegate); |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 72 | eventDispatcher.addSink(TopologyEvent.class, listenerRegistry); |
| 73 | log.info("Started"); |
| 74 | } |
| 75 | |
| 76 | @Deactivate |
| 77 | public void deactivate() { |
tom | c78acee | 2014-09-24 15:16:55 -0700 | [diff] [blame] | 78 | store.unsetDelegate(delegate); |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 79 | eventDispatcher.removeSink(TopologyEvent.class); |
| 80 | log.info("Stopped"); |
| 81 | } |
| 82 | |
| 83 | @Override |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 84 | public Topology currentTopology() { |
| 85 | return store.currentTopology(); |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 86 | } |
| 87 | |
| 88 | @Override |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 89 | public boolean isLatest(Topology topology) { |
| 90 | checkNotNull(topology, TOPOLOGY_NULL); |
tom | 10262dd | 2014-09-19 10:51:19 -0700 | [diff] [blame] | 91 | return store.isLatest(topology); |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 92 | } |
| 93 | |
| 94 | @Override |
| 95 | public Set<TopologyCluster> getClusters(Topology topology) { |
| 96 | checkNotNull(topology, TOPOLOGY_NULL); |
tom | 10262dd | 2014-09-19 10:51:19 -0700 | [diff] [blame] | 97 | return store.getClusters(topology); |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 98 | } |
| 99 | |
| 100 | @Override |
tom | 13cb485 | 2014-09-11 12:44:17 -0700 | [diff] [blame] | 101 | public TopologyCluster getCluster(Topology topology, ClusterId clusterId) { |
| 102 | checkNotNull(topology, TOPOLOGY_NULL); |
| 103 | checkNotNull(topology, CLUSTER_ID_NULL); |
tom | 10262dd | 2014-09-19 10:51:19 -0700 | [diff] [blame] | 104 | return store.getCluster(topology, clusterId); |
tom | 13cb485 | 2014-09-11 12:44:17 -0700 | [diff] [blame] | 105 | } |
| 106 | |
| 107 | @Override |
| 108 | public Set<DeviceId> getClusterDevices(Topology topology, TopologyCluster cluster) { |
| 109 | checkNotNull(topology, TOPOLOGY_NULL); |
| 110 | checkNotNull(topology, CLUSTER_NULL); |
tom | 10262dd | 2014-09-19 10:51:19 -0700 | [diff] [blame] | 111 | return store.getClusterDevices(topology, cluster); |
tom | 13cb485 | 2014-09-11 12:44:17 -0700 | [diff] [blame] | 112 | } |
| 113 | |
| 114 | @Override |
| 115 | public Set<Link> getClusterLinks(Topology topology, TopologyCluster cluster) { |
| 116 | checkNotNull(topology, TOPOLOGY_NULL); |
| 117 | checkNotNull(topology, CLUSTER_NULL); |
tom | 10262dd | 2014-09-19 10:51:19 -0700 | [diff] [blame] | 118 | return store.getClusterLinks(topology, cluster); |
tom | 13cb485 | 2014-09-11 12:44:17 -0700 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | @Override |
tom | 9793755 | 2014-09-11 10:48:42 -0700 | [diff] [blame] | 122 | public TopologyGraph getGraph(Topology topology) { |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 123 | checkNotNull(topology, TOPOLOGY_NULL); |
tom | 10262dd | 2014-09-19 10:51:19 -0700 | [diff] [blame] | 124 | return store.getGraph(topology); |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 125 | } |
| 126 | |
| 127 | @Override |
| 128 | public Set<Path> getPaths(Topology topology, DeviceId src, DeviceId dst) { |
| 129 | checkNotNull(topology, TOPOLOGY_NULL); |
| 130 | checkNotNull(src, DEVICE_ID_NULL); |
| 131 | checkNotNull(dst, DEVICE_ID_NULL); |
tom | 10262dd | 2014-09-19 10:51:19 -0700 | [diff] [blame] | 132 | return store.getPaths(topology, src, dst); |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 133 | } |
| 134 | |
| 135 | @Override |
| 136 | public Set<Path> getPaths(Topology topology, DeviceId src, DeviceId dst, LinkWeight weight) { |
| 137 | checkNotNull(topology, TOPOLOGY_NULL); |
| 138 | checkNotNull(src, DEVICE_ID_NULL); |
| 139 | checkNotNull(dst, DEVICE_ID_NULL); |
| 140 | checkNotNull(weight, "Link weight cannot be null"); |
tom | 10262dd | 2014-09-19 10:51:19 -0700 | [diff] [blame] | 141 | return store.getPaths(topology, src, dst, weight); |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 142 | } |
| 143 | |
| 144 | @Override |
| 145 | public boolean isInfrastructure(Topology topology, ConnectPoint connectPoint) { |
| 146 | checkNotNull(topology, TOPOLOGY_NULL); |
| 147 | checkNotNull(connectPoint, CONNECTION_POINT_NULL); |
tom | 10262dd | 2014-09-19 10:51:19 -0700 | [diff] [blame] | 148 | return store.isInfrastructure(topology, connectPoint); |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 149 | } |
| 150 | |
| 151 | @Override |
tom | 4d0dd3a | 2014-09-14 23:12:28 -0700 | [diff] [blame] | 152 | public boolean isBroadcastPoint(Topology topology, ConnectPoint connectPoint) { |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 153 | checkNotNull(topology, TOPOLOGY_NULL); |
| 154 | checkNotNull(connectPoint, CONNECTION_POINT_NULL); |
tom | 10262dd | 2014-09-19 10:51:19 -0700 | [diff] [blame] | 155 | return store.isBroadcastPoint(topology, connectPoint); |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 156 | } |
| 157 | |
| 158 | @Override |
| 159 | public void addListener(TopologyListener listener) { |
| 160 | listenerRegistry.addListener(listener); |
| 161 | } |
| 162 | |
| 163 | @Override |
| 164 | public void removeListener(TopologyListener listener) { |
| 165 | listenerRegistry.removeListener(listener); |
| 166 | } |
| 167 | |
| 168 | // Personalized host provider service issued to the supplied provider. |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 169 | @Override |
| 170 | protected TopologyProviderService createProviderService(TopologyProvider provider) { |
| 171 | return new InternalTopologyProviderService(provider); |
| 172 | } |
| 173 | |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 174 | private class InternalTopologyProviderService |
| 175 | extends AbstractProviderService<TopologyProvider> |
| 176 | implements TopologyProviderService { |
| 177 | |
| 178 | InternalTopologyProviderService(TopologyProvider provider) { |
| 179 | super(provider); |
| 180 | } |
| 181 | |
| 182 | @Override |
tom | 9793755 | 2014-09-11 10:48:42 -0700 | [diff] [blame] | 183 | public void topologyChanged(GraphDescription topoDescription, |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 184 | List<Event> reasons) { |
| 185 | checkNotNull(topoDescription, "Topology description cannot be null"); |
tom | cbff939 | 2014-09-10 00:45:23 -0700 | [diff] [blame] | 186 | |
tom | e52ce70 | 2014-09-11 00:12:54 -0700 | [diff] [blame] | 187 | TopologyEvent event = store.updateTopology(provider().id(), |
| 188 | topoDescription, reasons); |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 189 | if (event != null) { |
tom | 782a7cf | 2014-09-11 23:58:38 -0700 | [diff] [blame] | 190 | log.info("Topology {} changed", event.subject()); |
tom | dc361b6 | 2014-09-09 20:36:52 -0700 | [diff] [blame] | 191 | eventDispatcher.post(event); |
| 192 | } |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 193 | } |
| 194 | } |
| 195 | |
tom | c78acee | 2014-09-24 15:16:55 -0700 | [diff] [blame] | 196 | // Store delegate to re-post events emitted from the store. |
| 197 | private class InternalStoreDelegate implements TopologyStoreDelegate { |
| 198 | @Override |
| 199 | public void notify(TopologyEvent event) { |
| 200 | eventDispatcher.post(event); |
| 201 | } |
| 202 | } |
tom | cfde062 | 2014-09-09 11:02:42 -0700 | [diff] [blame] | 203 | } |