Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 1 | /* |
Thomas Vachuska | 52f2cd1 | 2018-11-08 21:20:04 -0800 | [diff] [blame] | 2 | * Copyright 2018-present Open Networking Foundation |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [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 | |
Thomas Vachuska | 52f2cd1 | 2018-11-08 21:20:04 -0800 | [diff] [blame] | 17 | package org.onosproject.alarm; |
Andrea Campanella | e72ac55 | 2016-04-11 10:04:52 -0700 | [diff] [blame] | 18 | |
| 19 | import org.onosproject.net.driver.HandlerBehaviour; |
| 20 | |
| 21 | import java.util.List; |
| 22 | |
| 23 | /** |
| 24 | * Abstraction of a device behaviour capable of retrieving/consuming list of |
| 25 | * pending alarms from the device. |
| 26 | */ |
| 27 | public interface AlarmConsumer extends HandlerBehaviour { |
| 28 | |
| 29 | /** |
| 30 | * Returns the list of active alarms consumed from the device. |
| 31 | * This means that subsequent retrieval of alarms will not contain |
| 32 | * any duplicates. |
| 33 | * |
| 34 | * @return list of alarms consumed from the device |
| 35 | */ |
| 36 | List<Alarm> consumeAlarms(); |
| 37 | |
| 38 | } |