kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014-2015 Open Networking Laboratory |
| 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 | |
| 18 | import com.google.common.annotations.Beta; |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 19 | import java.util.Map; |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 20 | |
| 21 | import java.util.Set; |
| 22 | import org.onosproject.net.ConnectPoint; |
| 23 | import org.onosproject.net.DeviceId; |
| 24 | |
| 25 | /** |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 26 | * Service for interacting with the alarm handling of devices. Unless stated otherwise, getter methods |
| 27 | * return active AND recently-cleared alarms. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 28 | */ |
| 29 | @Beta |
| 30 | public interface AlarmService { |
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 | * |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 35 | * @param id alarm identifier |
| 36 | * @param isAcknowledged new acknowledged state |
| 37 | * @param assignedUser new assigned user, null clear |
| 38 | * @return updated alarm (including any recent device-derived changes) |
| 39 | * |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 40 | */ |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 41 | Alarm updateBookkeepingFields(AlarmId id, boolean isAcknowledged, String assignedUser); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 42 | |
| 43 | /** |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 44 | * Returns summary of alarms on a given device. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 45 | * |
| 46 | * @param deviceId the device |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 47 | * @return map of severity (if applicable) vs alarm counts; empty map if either the device has no alarms or |
| 48 | * identified device is not managed. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 49 | */ |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 50 | Map<Alarm.SeverityLevel, Long> getAlarmCounts(DeviceId deviceId); |
| 51 | |
| 52 | /** |
| 53 | * Returns summary of alarms on all devices. |
| 54 | * |
| 55 | * @return map of severity (if applicable) vs alarm counts; empty map if no alarms. |
| 56 | */ |
| 57 | Map<Alarm.SeverityLevel, Long> getAlarmCounts(); |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 58 | |
| 59 | /** |
| 60 | * Returns the alarm with the specified identifier. |
| 61 | * |
| 62 | * @param alarmId alarm identifier |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 63 | * @return alarm matching id; null if no alarm matches the identifier. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 64 | */ |
| 65 | Alarm getAlarm(AlarmId alarmId); |
| 66 | |
| 67 | /** |
| 68 | * Returns all of the alarms. |
| 69 | * |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 70 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 71 | */ |
| 72 | Set<Alarm> getAlarms(); |
| 73 | |
| 74 | /** |
| 75 | * Returns all of the ACTIVE alarms. Recently cleared alarms excluded. |
| 76 | * |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 77 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 78 | */ |
| 79 | Set<Alarm> getActiveAlarms(); |
| 80 | |
| 81 | /** |
| 82 | * Returns the alarms with the specified severity. |
| 83 | * |
| 84 | * @param severity the alarm severity |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 85 | * @return set of alarms with a particular severity; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 86 | */ |
| 87 | Set<Alarm> getAlarms(Alarm.SeverityLevel severity); |
| 88 | |
| 89 | /** |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 90 | * Returns the alarm matching a given device, regardless of source within that device. |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 91 | * |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 92 | * @param deviceId the device to use when searching alarms. |
| 93 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 94 | */ |
| 95 | Set<Alarm> getAlarms(DeviceId deviceId); |
| 96 | |
| 97 | /** |
| 98 | * Returns the alarm for a given device and source. |
| 99 | * |
| 100 | * @param deviceId the device |
| 101 | * @param source the source within the device |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 102 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 103 | */ |
| 104 | Set<Alarm> getAlarms(DeviceId deviceId, AlarmEntityId source); |
| 105 | |
| 106 | /** |
| 107 | * Returns the alarm affecting a given link. |
| 108 | * |
| 109 | * @param src one end of the link |
| 110 | * @param dst one end of the link |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 111 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 112 | */ |
| 113 | Set<Alarm> getAlarmsForLink(ConnectPoint src, ConnectPoint dst); |
| 114 | |
| 115 | /** |
| 116 | * Returns the alarm affecting a given flow. |
| 117 | * |
| 118 | * @param deviceId the device |
| 119 | * @param flowId the flow |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 120 | * @return set of alarms; empty set if no alarms |
kmcpeake | 4fe18c8 | 2015-11-17 20:07:39 +0000 | [diff] [blame] | 121 | */ |
| 122 | Set<Alarm> getAlarmsForFlow(DeviceId deviceId, long flowId); |
| 123 | |
kmcpeake | b172d5f | 2015-12-10 11:30:43 +0000 | [diff] [blame] | 124 | // 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] | 125 | } |