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 2015-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.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) |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 39 | * @deprecated 1.10.0 Kingfisher |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 40 | */ |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 41 | @Deprecated |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 42 | Alarm updateBookkeepingFields(AlarmId id, boolean isAcknowledged, String assignedUser); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 43 | |
| 44 | /** |
Andrea Campanella | 65f9eb9 | 2017-05-02 11:36:14 -0700 | [diff] [blame] | 45 | * Update book-keeping (ie administrative) fields for the alarm matching the specified identifier. |
| 46 | * |
| 47 | * @param id alarm identifier |
| 48 | * @param clear ture if the alarm has to be cleared |
| 49 | * @param isAcknowledged new acknowledged state |
| 50 | * @param assignedUser new assigned user, null clear |
| 51 | * @return updated alarm (including any recent device-derived changes) |
| 52 | */ |
| 53 | Alarm updateBookkeepingFields(AlarmId id, boolean clear, boolean isAcknowledged, String assignedUser); |
| 54 | |
| 55 | /** |
| 56 | * Remove an alarm from ONOS. |
| 57 | * |
| 58 | * @param id alarm |
| 59 | */ |
| 60 | void remove(AlarmId id); |
| 61 | |
| 62 | /** |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 63 | * Returns summary of alarms on a given device. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 64 | * |
| 65 | * @param deviceId the device |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 66 | * @return map of severity (if applicable) vs alarm counts; empty map if either the device has no alarms or |
| 67 | * identified device is not managed. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 68 | */ |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 69 | Map<Alarm.SeverityLevel, Long> getAlarmCounts(DeviceId deviceId); |
| 70 | |
| 71 | /** |
| 72 | * Returns summary of alarms on all devices. |
| 73 | * |
| 74 | * @return map of severity (if applicable) vs alarm counts; empty map if no alarms. |
| 75 | */ |
| 76 | Map<Alarm.SeverityLevel, Long> getAlarmCounts(); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 77 | |
| 78 | /** |
| 79 | * Returns the alarm with the specified identifier. |
| 80 | * |
| 81 | * @param alarmId alarm identifier |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 82 | * @return alarm matching id; null if no alarm matches the identifier. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 83 | */ |
| 84 | Alarm getAlarm(AlarmId alarmId); |
| 85 | |
| 86 | /** |
| 87 | * Returns all of the alarms. |
| 88 | * |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 89 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 90 | */ |
| 91 | Set<Alarm> getAlarms(); |
| 92 | |
| 93 | /** |
| 94 | * Returns all of the ACTIVE alarms. Recently cleared alarms excluded. |
| 95 | * |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 96 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 97 | */ |
| 98 | Set<Alarm> getActiveAlarms(); |
| 99 | |
| 100 | /** |
| 101 | * Returns the alarms with the specified severity. |
| 102 | * |
| 103 | * @param severity the alarm severity |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 104 | * @return set of alarms with a particular severity; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 105 | */ |
| 106 | Set<Alarm> getAlarms(Alarm.SeverityLevel severity); |
| 107 | |
| 108 | /** |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 109 | * Returns the alarm matching a given device, regardless of source within that device. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 110 | * |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 111 | * @param deviceId the device to use when searching alarms. |
| 112 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 113 | */ |
| 114 | Set<Alarm> getAlarms(DeviceId deviceId); |
| 115 | |
| 116 | /** |
Andrea Campanella | 17f9ab6 | 2017-01-24 14:57:34 -0800 | [diff] [blame] | 117 | * Returns all of the ACTIVE alarms for a specific device. Recently cleared alarms excluded. |
| 118 | * |
| 119 | * @param deviceId the device to use when searching alarms. |
| 120 | * @return set of alarms; empty set if no alarms |
| 121 | */ |
| 122 | default Set<Alarm> getActiveAlarms(DeviceId deviceId) { |
| 123 | return getActiveAlarms().stream() |
| 124 | .filter(a -> deviceId.equals(a.deviceId())) |
| 125 | .collect(Collectors.toSet()); |
| 126 | } |
| 127 | |
| 128 | /** |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 129 | * Returns the alarm for a given device and source. |
| 130 | * |
| 131 | * @param deviceId the device |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 132 | * @param source the source within the device |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 133 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 134 | */ |
| 135 | Set<Alarm> getAlarms(DeviceId deviceId, AlarmEntityId source); |
| 136 | |
| 137 | /** |
| 138 | * Returns the alarm affecting a given link. |
| 139 | * |
| 140 | * @param src one end of the link |
| 141 | * @param dst one end of the link |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 142 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 143 | */ |
| 144 | Set<Alarm> getAlarmsForLink(ConnectPoint src, ConnectPoint dst); |
| 145 | |
| 146 | /** |
| 147 | * Returns the alarm affecting a given flow. |
| 148 | * |
| 149 | * @param deviceId the device |
Andrea Campanella | 8e94b0c | 2016-04-12 13:58:07 -0700 | [diff] [blame] | 150 | * @param flowId the flow |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 151 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 152 | */ |
| 153 | Set<Alarm> getAlarmsForFlow(DeviceId deviceId, long flowId); |
| 154 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 155 | // 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] | 156 | } |