Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Laboratory |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.topology; |
tom | 4774c8f | 2014-09-16 11:17:08 -0700 | [diff] [blame] | 17 | |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 18 | import org.onosproject.net.DisjointPath; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 19 | import org.onosproject.net.ElementId; |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 20 | import org.onosproject.net.Link; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 21 | import org.onosproject.net.Path; |
tom | 4774c8f | 2014-09-16 11:17:08 -0700 | [diff] [blame] | 22 | |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 23 | import java.util.Map; |
tom | 4774c8f | 2014-09-16 11:17:08 -0700 | [diff] [blame] | 24 | import java.util.Set; |
| 25 | |
| 26 | /** |
| 27 | * Service for obtaining pre-computed paths or for requesting computation of |
| 28 | * paths using the current topology snapshot. |
| 29 | */ |
| 30 | public interface PathService { |
| 31 | |
| 32 | /** |
Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [diff] [blame] | 33 | * Returns the set of all shortest paths between the specified source and |
| 34 | * destination elements. The path is computed using the default edge-weight |
| 35 | * function, which by default is hop-count. |
tom | 4774c8f | 2014-09-16 11:17:08 -0700 | [diff] [blame] | 36 | * |
tom | cbefa23 | 2014-09-16 14:17:20 -0700 | [diff] [blame] | 37 | * @param src source element |
| 38 | * @param dst destination element |
| 39 | * @return set of all shortest paths between the two elements |
tom | 4774c8f | 2014-09-16 11:17:08 -0700 | [diff] [blame] | 40 | */ |
tom | cbefa23 | 2014-09-16 14:17:20 -0700 | [diff] [blame] | 41 | Set<Path> getPaths(ElementId src, ElementId dst); |
tom | 4774c8f | 2014-09-16 11:17:08 -0700 | [diff] [blame] | 42 | |
| 43 | /** |
Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [diff] [blame] | 44 | * Returns the set of all shortest paths between the specified source and |
| 45 | * destination network elements. The path is computed using the supplied |
| 46 | * edge-weight function. |
tom | 4774c8f | 2014-09-16 11:17:08 -0700 | [diff] [blame] | 47 | * |
Thomas Vachuska | 48e64e4 | 2015-09-22 15:32:55 -0700 | [diff] [blame] | 48 | * @param src source element |
| 49 | * @param dst destination element |
Yuta HIGUCHI | 5c94727 | 2014-11-03 21:39:21 -0800 | [diff] [blame] | 50 | * @param weight edge-weight entity |
tom | cbefa23 | 2014-09-16 14:17:20 -0700 | [diff] [blame] | 51 | * @return set of all shortest paths between the two element |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 52 | * |
| 53 | * @deprecated in Junco (1.9.0), use version with LinkWeigher instead |
tom | 4774c8f | 2014-09-16 11:17:08 -0700 | [diff] [blame] | 54 | */ |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 55 | @Deprecated |
tom | cbefa23 | 2014-09-16 14:17:20 -0700 | [diff] [blame] | 56 | Set<Path> getPaths(ElementId src, ElementId dst, LinkWeight weight); |
tom | 4774c8f | 2014-09-16 11:17:08 -0700 | [diff] [blame] | 57 | |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 58 | /** |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 59 | * Returns the set of all shortest paths between the specified source and |
| 60 | * destination network elements. The path is computed using the supplied |
| 61 | * edge-weight function. |
| 62 | * |
| 63 | * @param src source element |
| 64 | * @param dst destination element |
| 65 | * @param weigher edge-weight entity |
| 66 | * @return set of all shortest paths between the two element |
| 67 | */ |
| 68 | Set<Path> getPaths(ElementId src, ElementId dst, LinkWeigher weigher); |
| 69 | |
| 70 | /** |
Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [diff] [blame] | 71 | * Returns the set of all disjoint shortest path pairs between the |
| 72 | * specified source and destination elements. The path is computed using |
| 73 | * the default edge-weight function, which by default is hop-count. |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 74 | * |
Thomas Vachuska | 48e64e4 | 2015-09-22 15:32:55 -0700 | [diff] [blame] | 75 | * @param src source device |
| 76 | * @param dst destination device |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 77 | * @return set of all shortest paths between the two devices |
| 78 | */ |
| 79 | Set<DisjointPath> getDisjointPaths(ElementId src, ElementId dst); |
| 80 | |
| 81 | /** |
Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [diff] [blame] | 82 | * Returns the set of all disjoint shortest path pairs between the |
| 83 | * specified source and destination elements. The path is computed using |
| 84 | * the supplied edge-weight function. |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 85 | * |
Thomas Vachuska | 48e64e4 | 2015-09-22 15:32:55 -0700 | [diff] [blame] | 86 | * @param src source device |
| 87 | * @param dst destination device |
| 88 | * @param weight edge-weight entity |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 89 | * @return set of all shortest paths between the two devices |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 90 | * |
| 91 | * @deprecated in Junco (1.9.0), use version with LinkWeigher instead |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 92 | */ |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 93 | @Deprecated |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 94 | Set<DisjointPath> getDisjointPaths(ElementId src, ElementId dst, |
| 95 | LinkWeight weight); |
| 96 | |
| 97 | /** |
Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [diff] [blame] | 98 | * Returns the set of all disjoint shortest path pairs between the |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 99 | * specified source and destination elements. The path is computed using |
| 100 | * the supplied edge-weight function. |
| 101 | * |
| 102 | * @param src source device |
| 103 | * @param dst destination device |
| 104 | * @param weigher edge-weight entity |
| 105 | * @return set of all shortest paths between the two devices |
| 106 | */ |
| 107 | Set<DisjointPath> getDisjointPaths(ElementId src, ElementId dst, |
| 108 | LinkWeigher weigher); |
| 109 | |
| 110 | /** |
| 111 | * Returns the set of all disjoint shortest path pairs between the |
Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [diff] [blame] | 112 | * specified source and destination elements and taking into consideration |
| 113 | * the provided risk profile. The path is computed using the default |
| 114 | * edge-weight function, which by default is hop-count. |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 115 | * |
Thomas Vachuska | 48e64e4 | 2015-09-22 15:32:55 -0700 | [diff] [blame] | 116 | * @param src source device |
| 117 | * @param dst destination device |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 118 | * @param riskProfile map of edges to risk profiles |
| 119 | * @return set of all shortest paths between the two devices |
| 120 | */ |
Thomas Vachuska | 48e64e4 | 2015-09-22 15:32:55 -0700 | [diff] [blame] | 121 | Set<DisjointPath> getDisjointPaths(ElementId src, ElementId dst, |
| 122 | Map<Link, Object> riskProfile); |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 123 | |
| 124 | /** |
Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [diff] [blame] | 125 | * Returns the set of all disjoint shortest path pairs between the |
| 126 | * specified source and destination elements and taking into consideration |
| 127 | * the provided risk profile. The path is computed using the supplied |
| 128 | * edge-weight function. |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 129 | * |
Thomas Vachuska | 48e64e4 | 2015-09-22 15:32:55 -0700 | [diff] [blame] | 130 | * @param src source device |
| 131 | * @param dst destination device |
| 132 | * @param weight edge-weight entity |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 133 | * @param riskProfile map of edges to risk profiles |
| 134 | * @return set of all shortest paths between the two devices |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 135 | * |
| 136 | * @deprecated in Junco (1.9.0), use version with LinkWeigher instead |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 137 | */ |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 138 | @Deprecated |
Thomas Vachuska | 48e64e4 | 2015-09-22 15:32:55 -0700 | [diff] [blame] | 139 | Set<DisjointPath> getDisjointPaths(ElementId src, ElementId dst, |
Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [diff] [blame] | 140 | LinkWeight weight, |
| 141 | Map<Link, Object> riskProfile); |
Nikhil Cheerla | 2ec191f | 2015-07-09 12:34:54 -0700 | [diff] [blame] | 142 | |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 143 | /** |
| 144 | * Returns the set of all disjoint shortest path pairs between the |
| 145 | * specified source and destination elements and taking into consideration |
| 146 | * the provided risk profile. The path is computed using the supplied |
| 147 | * edge-weight function. |
| 148 | * |
| 149 | * @param src source device |
| 150 | * @param dst destination device |
| 151 | * @param weigher edge-weight entity |
| 152 | * @param riskProfile map of edges to risk profiles |
| 153 | * @return set of all shortest paths between the two devices |
| 154 | */ |
| 155 | Set<DisjointPath> getDisjointPaths(ElementId src, ElementId dst, |
| 156 | LinkWeigher weigher, |
| 157 | Map<Link, Object> riskProfile); |
| 158 | |
tom | 4774c8f | 2014-09-16 11:17:08 -0700 | [diff] [blame] | 159 | } |