Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [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 | 41fe1ec | 2015-12-03 23:17:02 -0800 | [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 | |
| 17 | package org.onosproject.net.topology; |
| 18 | |
| 19 | import org.onlab.graph.GraphPathSearch; |
| 20 | |
| 21 | /** |
| 22 | * Provides administrative abilities to tailor the path service behaviours. |
| 23 | */ |
| 24 | public interface PathAdminService { |
| 25 | |
| 26 | /** |
| 27 | * Sets the specified link-weight function to be used as a default. |
| 28 | * If null is specified, the builtin default hop-count link-weight will be |
| 29 | * used. |
| 30 | * |
Andrey Komarov | 2398d96 | 2016-09-26 15:11:23 +0300 | [diff] [blame] | 31 | * @param linkWeigher link-weight function to be used as default |
| 32 | */ |
| 33 | void setDefaultLinkWeigher(LinkWeigher linkWeigher); |
| 34 | |
| 35 | /** |
Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [diff] [blame] | 36 | * Sets the specified graph path search algorightm to be used as a default. |
| 37 | * If null is specified, the builtin default all-shortest-paths Dijkstra |
| 38 | * algorithm will be used. |
| 39 | * |
| 40 | * @param graphPathSearch default graph path search algorithm |
| 41 | */ |
| 42 | void setDefaultGraphPathSearch(GraphPathSearch<TopologyVertex, TopologyEdge> graphPathSearch); |
| 43 | |
Thomas Vachuska | 9017741 | 2020-11-15 23:27:36 -0800 | [diff] [blame] | 44 | /** |
| 45 | * Sets the default maximum path count to be used when computing paths. If |
| 46 | * -1 is specified, the builtin default <code>ALL_PATHS</code>, signifying |
| 47 | * that all available paths should be returned is used. |
| 48 | * |
| 49 | * @param maxPaths new default max path count |
| 50 | */ |
| 51 | default void setDefaultMaxPaths(int maxPaths) {}; |
| 52 | |
Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [diff] [blame] | 53 | } |