openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/OpenFlowPluginProvider.java

   1 /*
   2  * Copyright (c) 2015 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.api.openflow;
  10
  11 import java.util.Collection;
  12 import java.util.Map;
  13 import org.opendaylight.controller.md.sal.binding.api.BindingService;
  14 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  15 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  16 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
  17 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
  18 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  19 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  20 import org.opendaylight.openflowjava.protocol.spi.connection.SwitchConnectionProvider;
  21
  22 /**
  23  * Plugin services provider
  24  */
  25 public interface OpenFlowPluginProvider extends AutoCloseable, BindingService {
  26
  27     /**
  28      * Method sets openflow java's connection providers.
  29      */
  30     void setSwitchConnectionProviders(Collection<SwitchConnectionProvider> switchConnectionProvider);
  31
  32     /**
  33      * setter
  34      *
  35      * @param dataBroker
  36      */
  37     void setDataBroker(DataBroker dataBroker);
  38
  39     void setRpcProviderRegistry(RpcProviderRegistry rpcProviderRegistry);
  40
  41     void setNotificationProviderService(NotificationService notificationProviderService);
  42
  43     void setNotificationPublishService(NotificationPublishService notificationPublishService);
  44
  45     /**
  46      * Method initializes all DeviceManager, RpcManager and related contexts.
  47      */
  48     void initialize();
  49
  50     /**
  51      * This parameter indicates whether it is mandatory for switch to support OF1.3 features : table, flow, meter,group.
  52      * If this is set to true and switch doesn't support these features its connection will be denied.
  53      * @param switchFeaturesMandatory
  54      */
  55     void setSwitchFeaturesMandatory(final boolean switchFeaturesMandatory);
  56
  57     boolean isSwitchFeaturesMandatory();
  58
  59     boolean isStatisticsPollingOn();
  60
  61     void setIsStatisticsPollingOn(final boolean isStatisticsPollingOn);
  62
  63     /**
  64      * Backward compatibility feature - exposing rpc for statistics polling (result is provided in form of async notification)
  65      *
  66      * @param isStatisticsRpcEnabled
  67      */
  68     void setIsStatisticsRpcEnabled(boolean isStatisticsRpcEnabled);
  69
  70     void setBarrierCountLimit(int barrierCountLimit);
  71
  72     void setBarrierInterval(long barrierTimeoutLimit);
  73
  74     void setEchoReplyTimeout(long echoReplyTimeout);
  75
  76     void setNotificationFlowRemovedOff(boolean isNotificationFlowRemovedOff);
  77
  78     void update(Map<String,Object> props);
  79
  80     void setClusteringSingletonServicesProvider(ClusterSingletonServiceProvider singletonServicesProvider);
  81
  82     void setSkipTableFeatures(boolean skipTableFeatures);
  83 }