kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 1 | /* |
Brian O'Connor | 0a4e674 | 2016-09-15 23:03:10 -0700 | [diff] [blame^] | 2 | * Copyright 2016-present Open Networking Laboratory |
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 | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 19 | import org.apache.commons.collections.CollectionUtils; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 20 | import org.apache.felix.scr.annotations.Activate; |
| 21 | import org.apache.felix.scr.annotations.Component; |
| 22 | import org.apache.felix.scr.annotations.Deactivate; |
| 23 | import org.apache.felix.scr.annotations.Modified; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 24 | import org.apache.felix.scr.annotations.Reference; |
| 25 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 26 | import org.apache.felix.scr.annotations.Service; |
| 27 | import org.onlab.util.ItemNotFoundException; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 28 | import org.onosproject.faultmanagement.api.AlarmStore; |
| 29 | import org.onosproject.faultmanagement.api.AlarmStoreDelegate; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 30 | import org.onosproject.incubator.net.faultmanagement.alarm.Alarm; |
| 31 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmEntityId; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 32 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmEvent; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 33 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmId; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 34 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmListener; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 35 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProvider; |
| 36 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProviderRegistry; |
| 37 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmProviderService; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 38 | import org.onosproject.incubator.net.faultmanagement.alarm.AlarmService; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 39 | import org.onosproject.incubator.net.faultmanagement.alarm.DefaultAlarm; |
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 | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 42 | import org.onosproject.net.provider.AbstractListenerProviderRegistry; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 43 | import org.onosproject.net.provider.AbstractProviderService; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 44 | import org.slf4j.Logger; |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 45 | |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 46 | import java.util.Collection; |
| 47 | import java.util.Map; |
| 48 | import java.util.Set; |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 49 | import java.util.concurrent.atomic.AtomicLong; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 50 | import java.util.stream.Collectors; |
| 51 | |
| 52 | import static com.google.common.base.Preconditions.checkNotNull; |
| 53 | import static org.onlab.util.Tools.nullIsNotFound; |
| 54 | import static org.slf4j.LoggerFactory.getLogger; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 55 | |
| 56 | /** |
| 57 | * Implementation of the Alarm service. |
| 58 | */ |
| 59 | @Component(immediate = true) |
| 60 | @Service |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 61 | public class AlarmManager |
| 62 | extends AbstractListenerProviderRegistry<AlarmEvent, AlarmListener, AlarmProvider, AlarmProviderService> |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 63 | implements AlarmService, AlarmProviderRegistry { |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 64 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 65 | private final Logger log = getLogger(getClass()); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 66 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 67 | |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 68 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 69 | protected AlarmStore store; |
| 70 | |
| 71 | protected AlarmStoreDelegate delegate = this::post; |
| 72 | |
| 73 | //TODO improve implementation of AlarmId |
| 74 | private final AtomicLong alarmIdGenerator = new AtomicLong(0); |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 75 | |
| 76 | private static final String NOT_SUPPORTED_YET = "Not supported yet."; |
| 77 | |
| 78 | @Activate |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 79 | public void activate() { |
| 80 | store.setDelegate(delegate); |
| 81 | eventDispatcher.addSink(AlarmEvent.class, listenerRegistry); |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 82 | log.info("Started"); |
| 83 | } |
| 84 | |
| 85 | @Deactivate |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 86 | public void deactivate() { |
| 87 | store.unsetDelegate(delegate); |
| 88 | eventDispatcher.removeSink(AlarmEvent.class); |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 89 | log.info("Stopped"); |
| 90 | } |
| 91 | |
| 92 | @Modified |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 93 | public boolean modified() { |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 94 | log.info("Modified"); |
| 95 | return true; |
| 96 | } |
| 97 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 98 | @Override |
| 99 | public Alarm updateBookkeepingFields(AlarmId id, boolean isAcknowledged, String assignedUser) { |
| 100 | |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 101 | Alarm found = store.getAlarm(id); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 102 | if (found == null) { |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 103 | throw new ItemNotFoundException("Alarm with id " + id + " found"); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 104 | } |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 105 | |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 106 | Alarm updated = new DefaultAlarm.Builder(found) |
| 107 | .withId(found.id()) |
| 108 | .withAcknowledged(isAcknowledged) |
| 109 | .withAssignedUser(assignedUser).build(); |
| 110 | store.setAlarm(updated); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 111 | return updated; |
| 112 | } |
| 113 | |
| 114 | public Alarm clear(AlarmId id) { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 115 | Alarm found = store.getAlarm(id); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 116 | if (found == null) { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 117 | log.warn("Alarm {} is not present", id); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 118 | return null; |
| 119 | } |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 120 | Alarm updated = new DefaultAlarm.Builder(found).withId(id).clear().build(); |
| 121 | store.setAlarm(updated); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 122 | return updated; |
| 123 | } |
| 124 | |
| 125 | @Override |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 126 | public Map<Alarm.SeverityLevel, Long> getAlarmCounts(DeviceId deviceId) { |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 127 | return getAlarms(deviceId).stream().collect( |
| 128 | Collectors.groupingBy(Alarm::severity, Collectors.counting())); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 129 | } |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 130 | |
| 131 | @Override |
| 132 | public Map<Alarm.SeverityLevel, Long> getAlarmCounts() { |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 133 | return getAlarms().stream().collect( |
| 134 | Collectors.groupingBy(Alarm::severity, Collectors.counting())); |
| 135 | } |
| 136 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 137 | @Override |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 138 | public Alarm getAlarm(AlarmId alarmId) { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 139 | return nullIsNotFound(store.getAlarm(checkNotNull(alarmId, "Alarm Id cannot be null")), |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 140 | "Alarm is not found"); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 141 | } |
| 142 | |
| 143 | @Override |
| 144 | public Set<Alarm> getAlarms() { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 145 | return ImmutableSet.copyOf(store.getAlarms()); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 146 | } |
| 147 | |
| 148 | @Override |
| 149 | public Set<Alarm> getActiveAlarms() { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 150 | return ImmutableSet.copyOf(store.getAlarms().stream().filter( |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 151 | a -> !a.severity().equals(Alarm.SeverityLevel.CLEARED)). |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 152 | collect(Collectors.toSet())); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 153 | } |
| 154 | |
| 155 | @Override |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 156 | public Set<Alarm> getAlarms(Alarm.SeverityLevel severity) { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 157 | return ImmutableSet.copyOf(store.getAlarms().stream().filter( |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 158 | a -> a.severity().equals(severity)). |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 159 | collect(Collectors.toSet())); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 160 | } |
| 161 | |
| 162 | @Override |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 163 | public Set<Alarm> getAlarms(DeviceId deviceId) { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 164 | return ImmutableSet.copyOf(store.getAlarms(deviceId)); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 165 | } |
| 166 | |
| 167 | private Set<Alarm> getActiveAlarms(DeviceId deviceId) { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 168 | return ImmutableSet.copyOf(getActiveAlarms().stream().filter( |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 169 | a -> deviceId.equals(a.deviceId())). |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 170 | collect(Collectors.toSet())); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | @Override |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 174 | public Set<Alarm> getAlarms(DeviceId deviceId, AlarmEntityId source) { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 175 | return ImmutableSet.copyOf(getAlarms(deviceId).stream().filter( |
| 176 | a -> source.equals(a.source())).collect(Collectors.toSet())); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 177 | } |
| 178 | |
| 179 | @Override |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 180 | public Set<Alarm> getAlarmsForLink(ConnectPoint src, ConnectPoint dst) { |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 181 | throw new UnsupportedOperationException(NOT_SUPPORTED_YET); |
| 182 | } |
| 183 | |
| 184 | @Override |
kmcpeake | a540481 | 2015-12-08 11:52:50 +0000 | [diff] [blame] | 185 | public Set<Alarm> getAlarmsForFlow(DeviceId deviceId, long flowId) { |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 186 | throw new UnsupportedOperationException(NOT_SUPPORTED_YET); |
| 187 | } |
| 188 | |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 189 | @Override |
| 190 | protected AlarmProviderService createProviderService(AlarmProvider provider) { |
| 191 | return new InternalAlarmProviderService(provider); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 192 | } |
| 193 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 194 | // Synchronised to prevent duplicate NE alarms being raised |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 195 | protected synchronized void updateAlarms(DeviceId deviceId, Set<Alarm> discoveredSet) { |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 196 | Set<Alarm> storedSet = getActiveAlarms(deviceId); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 197 | log.debug("CurrentNeAlarms={}. DiscoveredAlarms={}", storedSet, discoveredSet); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 198 | |
| 199 | if (CollectionUtils.isEqualCollection(storedSet, discoveredSet)) { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 200 | log.debug("No update for {}.", deviceId); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 201 | return; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 202 | } |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 203 | //TODO implement distinction between UPDATED and CLEARED ALARMS |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 204 | storedSet.stream().filter( |
| 205 | (stored) -> (!discoveredSet.contains(stored))).forEach((stored) -> { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 206 | log.debug("Alarm will be Cleared as it is not on the device. Cleared alarm: {}.", stored); |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 207 | clear(stored.id()); |
| 208 | }); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 209 | |
| 210 | discoveredSet.stream().filter( |
| 211 | (discovered) -> (!storedSet.contains(discovered))).forEach((discovered) -> { |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 212 | log.info("New alarm raised {}", discovered); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 213 | AlarmId id = generateAlarmId(); |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 214 | store.setAlarm(new DefaultAlarm.Builder(discovered).withId(id).build()); |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 215 | }); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 216 | } |
| 217 | |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 218 | //TODO improve implementation of AlarmId |
| 219 | private AlarmId generateAlarmId() { |
| 220 | return AlarmId.alarmId(alarmIdGenerator.incrementAndGet()); |
| 221 | } |
| 222 | |
| 223 | private class InternalAlarmProviderService extends AbstractProviderService<AlarmProvider> |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 224 | implements AlarmProviderService { |
| 225 | |
| 226 | InternalAlarmProviderService(AlarmProvider provider) { |
| 227 | super(provider); |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 228 | } |
| 229 | |
| 230 | @Override |
| 231 | public void updateAlarmList(DeviceId deviceId, Collection<Alarm> alarms) { |
| 232 | updateAlarms(deviceId, ImmutableSet.copyOf(alarms)); |
| 233 | } |
| 234 | } |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 235 | } |