kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.faultmanagement.impl; |
| 17 | |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 18 | import com.google.common.collect.ImmutableSet; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 19 | import org.onlab.util.ItemNotFoundException; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 20 | import org.onosproject.faultmanagement.api.AlarmStore; |
| 21 | import org.onosproject.faultmanagement.api.AlarmStoreDelegate; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 22 | import org.onosproject.incubator.net.faultmanagement.alarm.Alarm; |
| 23 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmEntityId; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 24 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmEvent; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 25 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmId; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 26 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmListener; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 27 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProvider; |
| 28 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProviderRegistry; |
| 29 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProviderService; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 30 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmService; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 31 | import org.onosproject.incubator.net.faultmanagement.alarm.DefaultAlarm; |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 32 | import org.onosproject.mastership.MastershipService; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 33 | import org.onosproject.net.ConnectPoint; |
| 34 | import org.onosproject.net.DeviceId; |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 35 | import org.onosproject.net.device.DeviceEvent; |
| 36 | import org.onosproject.net.device.DeviceListener; |
| 37 | import org.onosproject.net.device.DeviceService; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 38 | import org.onosproject.net.provider.AbstractListenerProviderRegistry; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 39 | import org.onosproject.net.provider.AbstractProviderService; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 40 | import org.osgi.service.component.annotations.Activate; |
| 41 | import org.osgi.service.component.annotations.Component; |
| 42 | import org.osgi.service.component.annotations.Deactivate; |
| 43 | import org.osgi.service.component.annotations.Modified; |
| 44 | import org.osgi.service.component.annotations.Reference; |
| 45 | import org.osgi.service.component.annotations.ReferenceCardinality; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 46 | import org.slf4j.Logger; |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 47 | |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 48 | import java.util.Collection; |
| 49 | import java.util.Map; |
| 50 | import java.util.Set; |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 51 | import java.util.concurrent.atomic.AtomicLong; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 52 | import java.util.stream.Collectors; |
| 53 | |
| 54 | import static com.google.common.base.Preconditions.checkNotNull; |
| 55 | import static org.onlab.util.Tools.nullIsNotFound; |
| 56 | import static org.slf4j.LoggerFactory.getLogger; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 57 | |
| 58 | /** |
| 59 | * Implementation of the Alarm service. |
| 60 | */ |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 61 | @Component(immediate = true, service = { AlarmService.class, AlarmProviderRegistry.class }) |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 62 | public class AlarmManager |
| 63 | extends AbstractListenerProviderRegistry<AlarmEvent, AlarmListener, AlarmProvider, AlarmProviderService> |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 64 | implements AlarmService, AlarmProviderRegistry { |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 65 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 66 | private final Logger log = getLogger(getClass()); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 67 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 68 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 69 | protected DeviceService deviceService; |
| 70 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 71 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 72 | protected MastershipService mastershipService; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 73 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame^] | 74 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 75 | protected AlarmStore store; |
| 76 | |
| 77 | protected AlarmStoreDelegate delegate = this::post; |
| 78 | |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 79 | private InternalDeviceListener deviceListener = new InternalDeviceListener(); |
| 80 | |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 81 | //TODO improve implementation of AlarmId |
| 82 | private final AtomicLong alarmIdGenerator = new AtomicLong(0); |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 83 | |
| 84 | private static final String NOT_SUPPORTED_YET = "Not supported yet."; |
| 85 | |
| 86 | @Activate |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 87 | public void activate() { |
| 88 | store.setDelegate(delegate); |
| 89 | eventDispatcher.addSink(AlarmEvent.class, listenerRegistry); |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 90 | deviceService.addListener(deviceListener); |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 91 | log.info("Started"); |
| 92 | } |
| 93 | |
| 94 | @Deactivate |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 95 | public void deactivate() { |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 96 | deviceService.removeListener(deviceListener); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 97 | store.unsetDelegate(delegate); |
| 98 | eventDispatcher.removeSink(AlarmEvent.class); |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 99 | log.info("Stopped"); |
| 100 | } |
| 101 | |
| 102 | @Modified |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 103 | public boolean modified() { |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 104 | log.info("Modified"); |
| 105 | return true; |
| 106 | } |
| 107 | |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 108 | @Override |
| 109 | public Alarm updateBookkeepingFields(AlarmId id, boolean clear, boolean isAcknowledged, |
| 110 | String assignedUser) { |
| 111 | checkNotNull(id, "Alarm id is null"); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 112 | Alarm found = store.getAlarm(id); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 113 | if (found == null) { |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 114 | throw new ItemNotFoundException("Alarm with id " + id + " found"); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 115 | } |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 116 | long now = System.currentTimeMillis(); |
| 117 | DefaultAlarm.Builder alarmBuilder = new DefaultAlarm.Builder(found).withTimeUpdated(now); |
| 118 | if (found.cleared() != clear) { |
| 119 | alarmBuilder.clear().withTimeCleared(now); |
| 120 | } |
| 121 | if (found.acknowledged() != isAcknowledged) { |
| 122 | alarmBuilder.withAcknowledged(isAcknowledged); |
| 123 | } |
| 124 | if (assignedUser != null && !found.assignedUser().equals(assignedUser)) { |
| 125 | alarmBuilder.withAssignedUser(assignedUser); |
| 126 | } |
| 127 | DefaultAlarm updated = alarmBuilder.build(); |
| 128 | store.createOrUpdateAlarm(updated); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 129 | return updated; |
| 130 | } |
| 131 | |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 132 | //TODO move to AlarmAdminService |
| 133 | @Override |
| 134 | public void remove(AlarmId id) { |
| 135 | checkNotNull(id, "Alarm id is null"); |
| 136 | store.removeAlarm(id); |
| 137 | } |
| 138 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 139 | @Override |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 140 | public Map<Alarm.SeverityLevel, Long> getAlarmCounts(DeviceId deviceId) { |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 141 | return getAlarms(deviceId).stream().collect( |
| 142 | Collectors.groupingBy(Alarm::severity, Collectors.counting())); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 143 | } |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 144 | |
| 145 | @Override |
| 146 | public Map<Alarm.SeverityLevel, Long> getAlarmCounts() { |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 147 | return getAlarms().stream().collect( |
| 148 | Collectors.groupingBy(Alarm::severity, Collectors.counting())); |
| 149 | } |
| 150 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 151 | @Override |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 152 | public Alarm getAlarm(AlarmId alarmId) { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 153 | return nullIsNotFound(store.getAlarm(checkNotNull(alarmId, "Alarm Id cannot be null")), |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 154 | "Alarm is not found"); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 155 | } |
| 156 | |
| 157 | @Override |
| 158 | public Set<Alarm> getAlarms() { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 159 | return ImmutableSet.copyOf(store.getAlarms()); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 160 | } |
| 161 | |
| 162 | @Override |
| 163 | public Set<Alarm> getActiveAlarms() { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 164 | return ImmutableSet.copyOf(store.getAlarms().stream().filter( |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 165 | a -> !a.severity().equals(Alarm.SeverityLevel.CLEARED)). |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 166 | collect(Collectors.toSet())); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 167 | } |
| 168 | |
| 169 | @Override |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 170 | public Set<Alarm> getAlarms(Alarm.SeverityLevel severity) { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 171 | return ImmutableSet.copyOf(store.getAlarms().stream().filter( |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 172 | a -> a.severity().equals(severity)). |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 173 | collect(Collectors.toSet())); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 174 | } |
| 175 | |
| 176 | @Override |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 177 | public Set<Alarm> getAlarms(DeviceId deviceId) { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 178 | return ImmutableSet.copyOf(store.getAlarms(deviceId)); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 179 | } |
| 180 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 181 | @Override |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 182 | public Set<Alarm> getAlarms(DeviceId deviceId, AlarmEntityId source) { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 183 | return ImmutableSet.copyOf(getAlarms(deviceId).stream().filter( |
| 184 | a -> source.equals(a.source())).collect(Collectors.toSet())); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 185 | } |
| 186 | |
| 187 | @Override |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 188 | public Set<Alarm> getAlarmsForLink(ConnectPoint src, ConnectPoint dst) { |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 189 | throw new UnsupportedOperationException(NOT_SUPPORTED_YET); |
| 190 | } |
| 191 | |
| 192 | @Override |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 193 | public Set<Alarm> getAlarmsForFlow(DeviceId deviceId, long flowId) { |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 194 | throw new UnsupportedOperationException(NOT_SUPPORTED_YET); |
| 195 | } |
| 196 | |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 197 | @Override |
| 198 | protected AlarmProviderService createProviderService(AlarmProvider provider) { |
| 199 | return new InternalAlarmProviderService(provider); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 200 | } |
| 201 | |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 202 | private class InternalAlarmProviderService extends AbstractProviderService<AlarmProvider> |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 203 | implements AlarmProviderService { |
| 204 | |
| 205 | InternalAlarmProviderService(AlarmProvider provider) { |
| 206 | super(provider); |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 207 | } |
| 208 | |
| 209 | @Override |
| 210 | public void updateAlarmList(DeviceId deviceId, Collection<Alarm> alarms) { |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 211 | alarms.forEach(alarm -> store.createOrUpdateAlarm(alarm)); |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 212 | } |
| 213 | } |
Andrea Campanella | 5a4df1e | 2017-10-24 13:46:56 +0200 | [diff] [blame] | 214 | |
| 215 | /** |
| 216 | * Internal listener for device events. |
| 217 | */ |
| 218 | private class InternalDeviceListener implements DeviceListener { |
| 219 | |
| 220 | @Override |
| 221 | public boolean isRelevant(DeviceEvent event) { |
| 222 | return event.type().equals(DeviceEvent.Type.DEVICE_REMOVED); |
| 223 | } |
| 224 | |
| 225 | @Override |
| 226 | public void event(DeviceEvent event) { |
| 227 | if (mastershipService.isLocalMaster(event.subject().id())) { |
| 228 | log.info("Device {} removed from ONOS, removing all related alarms", event.subject().id()); |
| 229 | //TODO this can be improved when core supports multiple keys map and gets implemented in AlarmStore |
| 230 | store.getAlarms(event.subject().id()).forEach(alarm -> store.removeAlarm(alarm.id())); |
| 231 | } else { |
| 232 | log.info("This Node is not Master for device {}", event.subject().id()); |
| 233 | } |
| 234 | } |
| 235 | |
| 236 | } |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 237 | } |