Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 3 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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 |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 7 | * |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 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. |
Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.metrics.topology; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 17 | |
| 18 | import java.util.List; |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 19 | import org.onlab.metrics.EventMetric; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 20 | import org.onosproject.event.Event; |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 21 | |
| 22 | /** |
| 23 | * Service interface exported by TopologyMetrics. |
| 24 | */ |
| 25 | public interface TopologyMetricsService { |
| 26 | /** |
| 27 | * Gets the last saved topology events. |
| 28 | * |
Pavlin Radoslavov | 6aaa1e0 | 2015-03-18 11:12:06 -0700 | [diff] [blame] | 29 | * @return the last saved topology events |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 30 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 31 | List<Event> getEvents(); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 32 | |
| 33 | /** |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 34 | * Gets the Event Metric for the Device Events. |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 35 | * |
Pavlin Radoslavov | 6aaa1e0 | 2015-03-18 11:12:06 -0700 | [diff] [blame] | 36 | * @return the Event Metric for the Device Events |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 37 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 38 | EventMetric topologyDeviceEventMetric(); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 39 | |
| 40 | /** |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 41 | * Gets the Event Metric for the Host Events. |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 42 | * |
Pavlin Radoslavov | 6aaa1e0 | 2015-03-18 11:12:06 -0700 | [diff] [blame] | 43 | * @return the Event Metric for the Host Events |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 44 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 45 | EventMetric topologyHostEventMetric(); |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 46 | |
| 47 | /** |
| 48 | * Gets the Event Metric for the Link Events. |
| 49 | * |
Pavlin Radoslavov | 6aaa1e0 | 2015-03-18 11:12:06 -0700 | [diff] [blame] | 50 | * @return the Event Metric for the Link Events |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 51 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 52 | EventMetric topologyLinkEventMetric(); |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 53 | |
| 54 | /** |
| 55 | * Gets the Event Metric for the Topology Graph Events. |
| 56 | * |
Pavlin Radoslavov | 6aaa1e0 | 2015-03-18 11:12:06 -0700 | [diff] [blame] | 57 | * @return the Event Metric for the Topology Graph Events |
Pavlin Radoslavov | ccc2e33 | 2014-10-23 13:46:28 -0700 | [diff] [blame] | 58 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 59 | EventMetric topologyGraphEventMetric(); |
Pavlin Radoslavov | 6aaa1e0 | 2015-03-18 11:12:06 -0700 | [diff] [blame] | 60 | |
| 61 | /** |
| 62 | * Gets the Event Metric for the Topology Graph Reasons Events. |
| 63 | * |
| 64 | * @return the Event Metric for the Topology Graph Reasons Events |
| 65 | */ |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 66 | EventMetric topologyGraphReasonsEventMetric(); |
Pavlin Radoslavov | 64d9e47 | 2014-10-21 22:01:08 -0700 | [diff] [blame] | 67 | } |