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