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