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.incubator.net.faultmanagement.alarm; |
| 17 | |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 18 | import org.onosproject.event.ListenerService; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 19 | import org.onosproject.net.ConnectPoint; |
| 20 | import org.onosproject.net.DeviceId; |
| 21 | |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 22 | import java.util.Map; |
| 23 | import java.util.Set; |
Andrea Campanella | 17f9ab6 | 2017-01-24 14:57:34 -0800 | [diff] [blame] | 24 | import java.util.stream.Collectors; |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 25 | |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 26 | /** |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 27 | * Service for interacting with the alarm handling of devices. Unless stated otherwise, getter methods |
| 28 | * return active AND recently-cleared alarms. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 29 | */ |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 30 | public interface AlarmService extends ListenerService<AlarmEvent, AlarmListener> { |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 31 | |
| 32 | /** |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 33 | * Update book-keeping (ie administrative) fields for the alarm matching the specified identifier. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 34 | * |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 35 | * @param id alarm identifier |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 36 | * @param isAcknowledged new acknowledged state |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 37 | * @param assignedUser new assigned user, null clear |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 38 | * @return updated alarm (including any recent device-derived changes) |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 39 | */ |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 40 | Alarm updateBookkeepingFields(AlarmId id, boolean isAcknowledged, String assignedUser); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 41 | |
| 42 | /** |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 43 | * Returns summary of alarms on a given device. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 44 | * |
| 45 | * @param deviceId the device |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 46 | * @return map of severity (if applicable) vs alarm counts; empty map if either the device has no alarms or |
| 47 | * identified device is not managed. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 48 | */ |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 49 | Map<Alarm.SeverityLevel, Long> getAlarmCounts(DeviceId deviceId); |
| 50 | |
| 51 | /** |
| 52 | * Returns summary of alarms on all devices. |
| 53 | * |
| 54 | * @return map of severity (if applicable) vs alarm counts; empty map if no alarms. |
| 55 | */ |
| 56 | Map<Alarm.SeverityLevel, Long> getAlarmCounts(); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 57 | |
| 58 | /** |
| 59 | * Returns the alarm with the specified identifier. |
| 60 | * |
| 61 | * @param alarmId alarm identifier |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 62 | * @return alarm matching id; null if no alarm matches the identifier. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 63 | */ |
| 64 | Alarm getAlarm(AlarmId alarmId); |
| 65 | |
| 66 | /** |
| 67 | * Returns all of the alarms. |
| 68 | * |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 69 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 70 | */ |
| 71 | Set<Alarm> getAlarms(); |
| 72 | |
| 73 | /** |
| 74 | * Returns all of the ACTIVE alarms. Recently cleared alarms excluded. |
| 75 | * |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 76 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 77 | */ |
| 78 | Set<Alarm> getActiveAlarms(); |
| 79 | |
| 80 | /** |
| 81 | * Returns the alarms with the specified severity. |
| 82 | * |
| 83 | * @param severity the alarm severity |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 84 | * @return set of alarms with a particular severity; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 85 | */ |
| 86 | Set<Alarm> getAlarms(Alarm.SeverityLevel severity); |
| 87 | |
| 88 | /** |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 89 | * Returns the alarm matching a given device, regardless of source within that device. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 90 | * |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 91 | * @param deviceId the device to use when searching alarms. |
| 92 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 93 | */ |
| 94 | Set<Alarm> getAlarms(DeviceId deviceId); |
| 95 | |
| 96 | /** |
Andrea Campanella | 17f9ab6 | 2017-01-24 14:57:34 -0800 | [diff] [blame] | 97 | * Returns all of the ACTIVE alarms for a specific device. Recently cleared alarms excluded. |
| 98 | * |
| 99 | * @param deviceId the device to use when searching alarms. |
| 100 | * @return set of alarms; empty set if no alarms |
| 101 | */ |
| 102 | default Set<Alarm> getActiveAlarms(DeviceId deviceId) { |
| 103 | return getActiveAlarms().stream() |
| 104 | .filter(a -> deviceId.equals(a.deviceId())) |
| 105 | .collect(Collectors.toSet()); |
| 106 | } |
| 107 | |
| 108 | /** |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 109 | * Returns the alarm for a given device and source. |
| 110 | * |
| 111 | * @param deviceId the device |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 112 | * @param source the source within the device |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 113 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 114 | */ |
| 115 | Set<Alarm> getAlarms(DeviceId deviceId, AlarmEntityId source); |
| 116 | |
| 117 | /** |
| 118 | * Returns the alarm affecting a given link. |
| 119 | * |
| 120 | * @param src one end of the link |
| 121 | * @param dst one end of the link |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 122 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 123 | */ |
| 124 | Set<Alarm> getAlarmsForLink(ConnectPoint src, ConnectPoint dst); |
| 125 | |
| 126 | /** |
| 127 | * Returns the alarm affecting a given flow. |
| 128 | * |
| 129 | * @param deviceId the device |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 130 | * @param flowId the flow |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 131 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 132 | */ |
| 133 | Set<Alarm> getAlarmsForFlow(DeviceId deviceId, long flowId); |
| 134 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 135 | // TODO Support retrieving alarms affecting other entity types may be added in future release |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 136 | } |