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