PathComputer.java

Go to the documentation of this file.

/* Copyright 2017 Telstra Open Source
 *
 *   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.openkilda.pce.provider;

import org.openkilda.messaging.info.event.SwitchInfoData;
import org.openkilda.messaging.info.event.IslInfoData;
import org.openkilda.messaging.info.event.PathInfoData;
import org.openkilda.messaging.model.Flow;
import org.openkilda.messaging.model.ImmutablePair;
import org.openkilda.pce.RecoverableException;
import org.openkilda.pce.model.AvailableNetwork;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

public interface PathComputer extends Serializable {

    enum Strategy {
        HOPS, COST, LATENCY, EXTERNAL
    }

    default Long getWeight(IslInfoData isl) {
        return 1L;
    }

    ImmutablePair<PathInfoData, PathInfoData> getPath(Flow flow, AvailableNetwork network, Strategy strategy)
            throws UnroutablePathException, RecoverableException;

    ImmutablePair<PathInfoData, PathInfoData> getPath(Flow flow, Strategy strategy)
            throws UnroutablePathException, RecoverableException;

    default List<FlowInfo> getFlowInfo() {
        return new ArrayList<>();
    }

    default List<Flow> getAllFlows() {
        return new ArrayList<>();
    }

    default List<Flow> getFlow(String flowId) {
        return null;
    }

    /*
     * @return all flows (forward and reverse) by id, if exist.
     */
    default List<Flow> getFlows(String flowId) {
        return null;
    }

    default List<SwitchInfoData> getSwitches() {
        return null;
    }

    default List<IslInfoData> getIsls() {
        return null;
    }

    AvailableNetwork getAvailableNetwork(boolean ignoreBandwidth, long requestedBandwidth);
}