1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
/*
* Copyright 2014 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.net.topology;
import org.onosproject.net.DisjointPath;
import org.onosproject.net.ElementId;
import org.onosproject.net.Link;
import org.onosproject.net.Path;
import java.util.Map;
import java.util.Set;
/**
* Service for obtaining pre-computed paths or for requesting computation of
* paths using the current topology snapshot.
*/
public interface PathService {
/**
* Returns the set of all shortest paths between the specified source and
* destination elements. The path is computed using the default edge-weight
* function, which by default is hop-count.
*
* @param src source element
* @param dst destination element
* @return set of all shortest paths between the two elements
*/
Set<Path> getPaths(ElementId src, ElementId dst);
/**
* Returns the set of all shortest paths between the specified source and
* destination network elements. The path is computed using the supplied
* edge-weight function.
*
* @param src source element
* @param dst destination element
* @param weight edge-weight entity
* @return set of all shortest paths between the two element
*/
Set<Path> getPaths(ElementId src, ElementId dst, LinkWeight weight);
/**
* Returns the set of all disjoint shortest path pairs between the
* specified source and destination elements. The path is computed using
* the default edge-weight function, which by default is hop-count.
*
* @param src source device
* @param dst destination device
* @return set of all shortest paths between the two devices
*/
Set<DisjointPath> getDisjointPaths(ElementId src, ElementId dst);
/**
* Returns the set of all disjoint shortest path pairs between the
* specified source and destination elements. The path is computed using
* the supplied edge-weight function.
*
* @param src source device
* @param dst destination device
* @param weight edge-weight entity
* @return set of all shortest paths between the two devices
*/
Set<DisjointPath> getDisjointPaths(ElementId src, ElementId dst,
LinkWeight weight);
/**
* Returns the set of all disjoint shortest path pairs between the
* specified source and destination elements and taking into consideration
* the provided risk profile. The path is computed using the default
* edge-weight function, which by default is hop-count.
*
* @param src source device
* @param dst destination device
* @param riskProfile map of edges to risk profiles
* @return set of all shortest paths between the two devices
*/
Set<DisjointPath> getDisjointPaths(ElementId src, ElementId dst,
Map<Link, Object> riskProfile);
/**
* Returns the set of all disjoint shortest path pairs between the
* specified source and destination elements and taking into consideration
* the provided risk profile. The path is computed using the supplied
* edge-weight function.
*
* @param src source device
* @param dst destination device
* @param weight edge-weight entity
* @param riskProfile map of edges to risk profiles
* @return set of all shortest paths between the two devices
*/
Set<DisjointPath> getDisjointPaths(ElementId src, ElementId dst,
LinkWeight weight,
Map<Link, Object> riskProfile);
}
|
