/*
 * Copyright 2017-present Open Networking Foundation
 *
 * 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.t3.api;

import org.onlab.packet.EthType;
import org.onlab.packet.VlanId;
import org.onosproject.net.ConnectPoint;
import org.onosproject.net.HostId;
import org.onosproject.net.flow.TrafficSelector;
import org.onosproject.t3.impl.Generator;

import java.util.List;
import java.util.Set;

/**
 * API for troubleshooting services, providing static analysis of installed
 * flows and groups.
 */
public interface TroubleshootService {

    /**
     * Requests a static trace be performed between all hosts in the network, given a type of traffic.
     *
     * @param type the etherType of the traffic we want to trace.
     * @return trace result
     */
    List<StaticPacketTrace> pingAll(EthType.EtherType type);

    /**
     * Requests a static trace be performed between all hosts in the network, given a type of traffic.
     *
     * @param type the etherType of the traffic we want to trace.
     * @return trace result
     */
    Generator<Set<StaticPacketTrace>> pingAllGenerator(EthType.EtherType type);

    /**
     * Requests a static trace be performed for all mcast Routes in the network.
     *
     * @param vlanId the vlanId configured for multicast.
     * @return set of trace result yielded one by one.
     */
    Generator<Set<StaticPacketTrace>> traceMcast(VlanId vlanId);

    /**
     * Requests a static trace be performed between the two hosts in the network, given a type of traffic.
     *
     * @param sourceHost      source host
     * @param destinationHost destination host
     * @param type            the etherType of the traffic we want to trace.
     * @return trace result
     */
    Set<StaticPacketTrace> trace(HostId sourceHost, HostId destinationHost, EthType.EtherType type);

    /**
     * Requests a static trace be performed for the given traffic selector
     * starting at the given connect point.
     *
     * @param packet description of packet
     * @param in     point at which packet starts
     * @return trace result
     */
    StaticPacketTrace trace(TrafficSelector packet, ConnectPoint in);

    /**
     * Requests list of static trace to be performed for all mcast routes in the network.
     *
     * @param vlanId the vlan id configured for multicast
     * @return list of trace result
     */
    List<Set<StaticPacketTrace>> getMulitcastTrace(VlanId vlanId);

    /**
     * Checks the validity of NIBs applied to the manager.
     *
     * @return true only if all NIBs are in the valid state.
     */
    boolean checkNibValidity();

    /**
     * Returns a summary describing all the NIBs applied to the manager.
     *
     * @return string for the summary
     */
    String printNibSummary();

}