samples/learning-switch/src/main/java/org/opendaylight/openflowplugin/learningswitch/LearningSwitchManager.java

   1 /**
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   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
   9 package org.opendaylight.openflowplugin.learningswitch;
  10
  11 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  12 import org.opendaylight.controller.sal.binding.api.NotificationService;
  13 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketProcessingService;
  14
  15 public interface LearningSwitchManager {
  16
  17     /**
  18      * Stops this manager.
  19      */
  20     void stop();
  21
  22     /**
  23      * Starts this manager.
  24      */
  25     void start();
  26
  27     /**
  28      * Set's Data Broker dependency.
  29      *
  30      * <p>
  31      * Data Broker is used to access overall operational and configuration tree.
  32      *
  33      * <p>
  34      * In simple Learning Switch handler, data broker is used to listen
  35      * for changes in Openflow tables and to configure flows which will
  36      * be provisioned down to the Openflow switch.
  37      *
  38      * <p>
  39      * inject {@link DataBroker}
  40      */
  41     void setDataBroker(DataBroker data);
  42
  43     /**
  44      * Set's Packet Processing dependency.
  45      *
  46      * <p>
  47      * Packet Processing service is used to send packet Out on Openflow switch.
  48      *
  49      * <p>
  50      * inject {@link PacketProcessingService}
  51      */
  52     void setPacketProcessingService(
  53             PacketProcessingService packetProcessingService);
  54
  55     /**
  56      * Set's Notification service dependency.
  57      *
  58      * <p>
  59      * Notification service is used to register for listening packet-in notifications.
  60      *
  61      * <p>
  62      * inject {@link NotificationService}
  63      */
  64     void setNotificationService(NotificationService notificationService);
  65 }