openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/api/NetworkingProvider.java

   1 /*
   2  * Copyright (C) 2014 Red Hat, Inc.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  *  Authors : Dave Tucker
   9  */
  10
  11 package org.opendaylight.ovsdb.openstack.netvirt.api;
  12
  13 import org.opendaylight.neutron.spi.NeutronNetwork;
  14 import org.opendaylight.ovsdb.schema.openvswitch.Interface;
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
  16 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  17
  18 /**
  19  * The NetworkingProvider interface is implemented by Neutron Networking Providers
  20  */
  21 public interface NetworkingProvider {
  22
  23     /**
  24      * Returns the name of the NetworkingProvider
  25      */
  26     public String getName();
  27
  28     /**
  29      * Return true if the provider supports Network Service Instances
  30      */
  31     public boolean supportsServices();
  32
  33     /**
  34      * Return true if the provider supports per-tenant or "static" tunneling
  35      */
  36     public boolean hasPerTenantTunneling();
  37
  38     /**
  39      * Handle Interface Update Callback Method
  40      */
  41     public Status handleInterfaceUpdate(String tunnelType, String tunnelKey);
  42
  43     /**
  44      * Handle Interface Update Callback Method
  45      */
  46     public Status handleInterfaceUpdate(NeutronNetwork network, Node source, OvsdbTerminationPointAugmentation intf);
  47
  48     /**
  49      * Handle Interface Delete Callback Method
  50      */
  51     public Status handleInterfaceDelete(String tunnelType, NeutronNetwork network, Node source,
  52                                         OvsdbTerminationPointAugmentation intf, boolean isLastInstanceOnNode);
  53
  54     /**
  55      * Initialize the Flow rules given the OVSDB node.
  56      * This method provides a set of common functionalities to initialize the Flow rules of an OVSDB node
  57      * that are Openflow Version specific. Hence we have this method in addition to the following
  58      * Openflow Node specific initialization method.
  59      */
  60     public void initializeFlowRules(Node node);
  61
  62     /**
  63      * Initialize the Flow rules for a given OpenFlow node
  64      */
  65     public void initializeOFFlowRules(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node openflowNode);
  66
  67     /**
  68      * Generate event to announce flow capable node.
  69      * @param dpid the data path id of the node
  70      * @param action the type of update for the given dpid
  71      */
  72     public void notifyFlowCapableNodeEvent(Long dpid, Action action);
  73 }