ISwitchManager.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.floodlight.switchmanager;

import org.openkilda.messaging.command.switches.ConnectModeRequest;
import org.openkilda.messaging.command.switches.DeleteRulesCriteria;
import org.openkilda.messaging.payload.flow.OutputVlanType;

import net.floodlightcontroller.core.IOFSwitch;
import net.floodlightcontroller.core.module.IFloodlightService;
import org.projectfloodlight.openflow.protocol.OFFlowStatsEntry;
import org.projectfloodlight.openflow.protocol.OFMeterConfigStatsReply;
import org.projectfloodlight.openflow.types.DatapathId;

import java.util.List;
import java.util.Map;


public interface ISwitchManager extends IFloodlightService {
    String OVS_MANUFACTURER = "Nicira, Inc.";
    long DROP_RULE_COOKIE = 0x8000000000000001L;
    long VERIFICATION_BROADCAST_RULE_COOKIE = 0x8000000000000002L;
    long VERIFICATION_UNICAST_RULE_COOKIE = 0x8000000000000003L;

    ConnectModeRequest.Mode connectMode(final ConnectModeRequest.Mode mode);


    void installDefaultRules(final DatapathId dpid) throws SwitchOperationException;

    void installVerificationRule(final DatapathId dpid, final boolean isBroadcast)
            throws SwitchOperationException;

    void installDropFlow(final DatapathId dpid) throws SwitchOperationException;

    void installDropFlowCustom(final DatapathId dpid, String dstMac, String dstMask,
                               final long cookie, final int priority) throws SwitchOperationException;


    long installIngressFlow(final DatapathId dpid, final String flowId, final Long cookie,
                                                    final int inputPort, final int outputPort, final int inputVlanId,
                                                    final int transitVlanId, final OutputVlanType outputVlanType,
                                                    final long meterId) throws SwitchOperationException;

    long installEgressFlow(final DatapathId dpid, final String flowId, final Long cookie,
                                                   final int inputPort, final int outputPort, final int transitVlanId,
                                                   final int outputVlanId, final OutputVlanType outputVlanType)
            throws SwitchOperationException;

    long installTransitFlow(final DatapathId dpid, final String flowId, final Long cookie,
                                                    final int inputPort, final int outputPort, final int transitVlanId)
            throws SwitchOperationException;

    long installOneSwitchFlow(final DatapathId dpid, final String flowId, final Long cookie,
                                                      final int inputPort, final int outputPort, int inputVlanId,
                                                      int outputVlanId, final OutputVlanType outputVlanType,
                                                      final long meterId) throws SwitchOperationException;

    List<OFFlowStatsEntry> dumpFlowTable(final DatapathId dpid);

    OFMeterConfigStatsReply dumpMeters(final DatapathId dpid) throws SwitchOperationException;

    long installMeter(final DatapathId dpid, final long bandwidth, final long burstSize,
                                              final long meterId) throws SwitchOperationException;

    long deleteMeter(final DatapathId dpid, final long meterId) throws SwitchOperationException;


    Map<DatapathId, IOFSwitch> getAllSwitchMap();

    List<Long> deleteAllNonDefaultRules(DatapathId dpid) throws SwitchOperationException;

    List<Long> deleteDefaultRules(DatapathId dpid) throws SwitchOperationException;

    List<Long> deleteRulesByCriteria(DatapathId dpid, DeleteRulesCriteria... criteria) throws SwitchOperationException;

    void startSafeMode(final DatapathId dpid) throws SwitchOperationException;

    void stopSafeMode(final DatapathId dpid);

    void safeModeTick();

    void sendSwitchActivate(final IOFSwitch sw) throws SwitchOperationException;

    void sendPortUpEvents(final IOFSwitch sw) throws SwitchOperationException;

    void configurePort(DatapathId dpId, int portNumber, Boolean portAdminDown) throws SwitchOperationException;
}