aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/core/api/src/main/java/org/onosproject/net/topology/PathAdminService.java
blob: 9d077e1e260a66e805e920138c15383e682b0acb (plain)
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
/*
 * Copyright 2014-2015 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.onlab.graph.GraphPathSearch;

/**
 * Provides administrative abilities to tailor the path service behaviours.
 */
public interface PathAdminService {

    /**
     * Sets the specified link-weight function to be used as a default.
     * If null is specified, the builtin default hop-count link-weight will be
     * used.
     *
     * @param linkWeight default link-weight function
     */
    void setDefaultLinkWeight(LinkWeight linkWeight);

    /**
     * Sets the specified graph path search algorightm to be used as a default.
     * If null is specified, the builtin default all-shortest-paths Dijkstra
     * algorithm will be used.
     *
     * @param graphPathSearch default graph path search algorithm
     */
    void setDefaultGraphPathSearch(GraphPathSearch<TopologyVertex, TopologyEdge> graphPathSearch);

}