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