tom | b1260e4 | 2014-08-26 18:39:57 -0700 | [diff] [blame] | 1 | package org.onlab.onos.net.trivial.impl; |
tom | d3097b0 | 2014-08-26 10:40:29 -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; |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 6 | import org.apache.felix.scr.annotations.Reference; |
| 7 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 8 | import org.apache.felix.scr.annotations.Service; |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 9 | import org.onlab.onos.event.AbstractListenerRegistry; |
| 10 | import org.onlab.onos.event.EventDeliveryService; |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 11 | import org.onlab.onos.net.Device; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 12 | import org.onlab.onos.net.DeviceId; |
| 13 | import org.onlab.onos.net.MastershipRole; |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 14 | import org.onlab.onos.net.Port; |
| 15 | import org.onlab.onos.net.PortNumber; |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 16 | import org.onlab.onos.net.device.DeviceAdminService; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 17 | import org.onlab.onos.net.device.DeviceDescription; |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 18 | import org.onlab.onos.net.device.DeviceEvent; |
| 19 | import org.onlab.onos.net.device.DeviceListener; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 20 | import org.onlab.onos.net.device.DeviceProvider; |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 21 | import org.onlab.onos.net.device.DeviceProviderRegistry; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 22 | import org.onlab.onos.net.device.DeviceProviderService; |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 23 | import org.onlab.onos.net.device.DeviceService; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 24 | import org.onlab.onos.net.device.PortDescription; |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 25 | import org.onlab.onos.net.provider.AbstractProviderRegistry; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 26 | import org.onlab.onos.net.provider.AbstractProviderService; |
| 27 | import org.slf4j.Logger; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 28 | |
| 29 | import java.util.List; |
tom | 80c0e5e | 2014-09-08 18:08:58 -0700 | [diff] [blame^] | 30 | import java.util.concurrent.ExecutorService; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 31 | |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 32 | import static com.google.common.base.Preconditions.checkNotNull; |
tom | 80c0e5e | 2014-09-08 18:08:58 -0700 | [diff] [blame^] | 33 | import static java.util.concurrent.Executors.newSingleThreadExecutor; |
| 34 | import static org.onlab.util.Tools.namedThreads; |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 35 | import static org.slf4j.LoggerFactory.getLogger; |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 36 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 37 | /** |
tom | b36046e | 2014-08-27 00:22:24 -0700 | [diff] [blame] | 38 | * Provides basic implementation of the device SB & NB APIs. |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 39 | */ |
| 40 | @Component(immediate = true) |
| 41 | @Service |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 42 | public class SimpleDeviceManager |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 43 | extends AbstractProviderRegistry<DeviceProvider, DeviceProviderService> |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 44 | implements DeviceService, DeviceAdminService, DeviceProviderRegistry { |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 45 | |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 46 | private static final String DEVICE_ID_NULL = "Device ID cannot be null"; |
| 47 | private static final String PORT_NUMBER_NULL = "Port number cannot be null"; |
| 48 | private static final String DEVICE_DESCRIPTION_NULL = "Device description cannot be null"; |
| 49 | private static final String PORT_DESCRIPTION_NULL = "Port description cannot be null"; |
| 50 | private static final String ROLE_NULL = "Role cannot be null"; |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 51 | |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 52 | private final Logger log = getLogger(getClass()); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 53 | |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 54 | private final AbstractListenerRegistry<DeviceEvent, DeviceListener> |
| 55 | listenerRegistry = new AbstractListenerRegistry<>(); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 56 | |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 57 | private final SimpleDeviceStore store = new SimpleDeviceStore(); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 58 | |
tom | 80c0e5e | 2014-09-08 18:08:58 -0700 | [diff] [blame^] | 59 | private final ExecutorService executor = |
| 60 | newSingleThreadExecutor(namedThreads("onos-device-%d")); |
| 61 | |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 62 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 63 | protected EventDeliveryService eventDispatcher; |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 64 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 65 | @Activate |
| 66 | public void activate() { |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 67 | eventDispatcher.addSink(DeviceEvent.class, listenerRegistry); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 68 | log.info("Started"); |
| 69 | } |
| 70 | |
| 71 | @Deactivate |
| 72 | public void deactivate() { |
tom | 5f38b3a | 2014-08-27 23:50:54 -0700 | [diff] [blame] | 73 | eventDispatcher.removeSink(DeviceEvent.class); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 74 | log.info("Stopped"); |
| 75 | } |
| 76 | |
| 77 | @Override |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 78 | public int getDeviceCount() { |
| 79 | return store.getDeviceCount(); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 80 | } |
| 81 | |
| 82 | @Override |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 83 | public Iterable<Device> getDevices() { |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 84 | return store.getDevices(); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 85 | } |
| 86 | |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 87 | @Override |
| 88 | public Device getDevice(DeviceId deviceId) { |
| 89 | checkNotNull(deviceId, DEVICE_ID_NULL); |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 90 | return store.getDevice(deviceId); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 91 | } |
| 92 | |
| 93 | @Override |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 94 | public MastershipRole getRole(DeviceId deviceId) { |
| 95 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 96 | return store.getRole(deviceId); |
| 97 | } |
| 98 | |
| 99 | @Override |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 100 | public List<Port> getPorts(DeviceId deviceId) { |
| 101 | checkNotNull(deviceId, DEVICE_ID_NULL); |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 102 | return store.getPorts(deviceId); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 103 | } |
| 104 | |
| 105 | @Override |
| 106 | public Port getPort(DeviceId deviceId, PortNumber portNumber) { |
| 107 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 108 | checkNotNull(portNumber, PORT_NUMBER_NULL); |
tom | 132b58a | 2014-08-28 16:11:28 -0700 | [diff] [blame] | 109 | return store.getPort(deviceId, portNumber); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 110 | } |
| 111 | |
| 112 | @Override |
tom | ff7eb7c | 2014-09-08 12:49:03 -0700 | [diff] [blame] | 113 | public boolean isAvailable(DeviceId deviceId) { |
| 114 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 115 | return store.isAvailable(deviceId); |
| 116 | } |
| 117 | |
| 118 | @Override |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 119 | public void addListener(DeviceListener listener) { |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 120 | listenerRegistry.addListener(listener); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 121 | } |
| 122 | |
| 123 | @Override |
| 124 | public void removeListener(DeviceListener listener) { |
tom | 96dfcab | 2014-08-28 09:26:03 -0700 | [diff] [blame] | 125 | listenerRegistry.removeListener(listener); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 126 | } |
| 127 | |
| 128 | @Override |
| 129 | protected DeviceProviderService createProviderService(DeviceProvider provider) { |
| 130 | return new InternalDeviceProviderService(provider); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 131 | } |
| 132 | |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 133 | @Override |
| 134 | public void setRole(DeviceId deviceId, MastershipRole newRole) { |
| 135 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 136 | checkNotNull(newRole, ROLE_NULL); |
| 137 | DeviceEvent event = store.setRole(deviceId, newRole); |
| 138 | if (event != null) { |
| 139 | Device device = event.subject(); |
| 140 | DeviceProvider provider = getProvider(device.providerId()); |
| 141 | if (provider != null) { |
| 142 | provider.roleChanged(device, newRole); |
| 143 | } |
| 144 | post(event); |
| 145 | } |
| 146 | } |
| 147 | |
| 148 | @Override |
| 149 | public void removeDevice(DeviceId deviceId) { |
| 150 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 151 | DeviceEvent event = store.removeDevice(deviceId); |
| 152 | post(event); |
| 153 | } |
| 154 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 155 | // Personalized device provider service issued to the supplied provider. |
| 156 | private class InternalDeviceProviderService extends AbstractProviderService<DeviceProvider> |
| 157 | implements DeviceProviderService { |
| 158 | |
| 159 | public InternalDeviceProviderService(DeviceProvider provider) { |
| 160 | super(provider); |
| 161 | } |
| 162 | |
| 163 | @Override |
tom | d1c0649 | 2014-09-03 11:07:58 -0700 | [diff] [blame] | 164 | public void deviceConnected(DeviceId deviceId, DeviceDescription deviceDescription) { |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 165 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 166 | checkNotNull(deviceDescription, DEVICE_DESCRIPTION_NULL); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 167 | checkValidity(); |
tom | 24c55cd | 2014-09-06 10:47:25 -0700 | [diff] [blame] | 168 | log.info("Device {} connected", deviceId); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 169 | DeviceEvent event = store.createOrUpdateDevice(provider().id(), |
| 170 | deviceId, deviceDescription); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 171 | post(event); |
tom | 80c0e5e | 2014-09-08 18:08:58 -0700 | [diff] [blame^] | 172 | |
| 173 | // If there was a change of any kind, trigger role selection process. |
| 174 | if (event != null) { |
| 175 | triggerRoleSelection(event.subject(), provider()); |
| 176 | } |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 177 | } |
| 178 | |
| 179 | @Override |
| 180 | public void deviceDisconnected(DeviceId deviceId) { |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 181 | checkNotNull(deviceId, DEVICE_ID_NULL); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 182 | checkValidity(); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 183 | log.info("Device {} disconnected", deviceId); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 184 | DeviceEvent event = store.markOffline(deviceId); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 185 | post(event); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 186 | } |
| 187 | |
| 188 | @Override |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 189 | public void updatePorts(DeviceId deviceId, List<PortDescription> portDescriptions) { |
| 190 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 191 | checkNotNull(portDescriptions, "Port descriptions list cannot be null"); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 192 | checkValidity(); |
tom | 24c55cd | 2014-09-06 10:47:25 -0700 | [diff] [blame] | 193 | log.info("Device {} ports updated", deviceId); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 194 | List<DeviceEvent> events = store.updatePorts(deviceId, portDescriptions); |
| 195 | for (DeviceEvent event : events) { |
| 196 | post(event); |
| 197 | } |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 198 | } |
| 199 | |
| 200 | @Override |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 201 | public void portStatusChanged(DeviceId deviceId, PortDescription portDescription) { |
| 202 | checkNotNull(deviceId, DEVICE_ID_NULL); |
| 203 | checkNotNull(portDescription, PORT_DESCRIPTION_NULL); |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 204 | checkValidity(); |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 205 | DeviceEvent event = store.updatePortStatus(deviceId, portDescription); |
tom | ff7eb7c | 2014-09-08 12:49:03 -0700 | [diff] [blame] | 206 | if (event != null) { |
| 207 | log.info("Device {} port status changed", deviceId); |
| 208 | } |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 209 | post(event); |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 210 | } |
| 211 | } |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 212 | |
tom | 80c0e5e | 2014-09-08 18:08:58 -0700 | [diff] [blame^] | 213 | /** |
| 214 | * Triggers asynchronous role selection. |
| 215 | * |
| 216 | * @param device device |
| 217 | * @param provider device provider |
| 218 | */ |
| 219 | private void triggerRoleSelection(final Device device, |
| 220 | final DeviceProvider provider) { |
| 221 | executor.execute(new Runnable() { |
| 222 | @Override |
| 223 | public void run() { |
| 224 | provider.roleChanged(device, store.getRole(device.id())); |
| 225 | } |
| 226 | }); |
| 227 | } |
| 228 | |
tom | eadbb46 | 2014-09-07 16:10:19 -0700 | [diff] [blame] | 229 | // Posts the specified event to the local event dispatcher. |
tom | 32f6684 | 2014-08-27 19:27:47 -0700 | [diff] [blame] | 230 | private void post(DeviceEvent event) { |
| 231 | if (event != null && eventDispatcher != null) { |
| 232 | eventDispatcher.post(event); |
| 233 | } |
| 234 | } |
| 235 | |
tom | d3097b0 | 2014-08-26 10:40:29 -0700 | [diff] [blame] | 236 | } |