Switch to MD-SAL APIs

[openflowplugin.git] / openflowplugin-api / src / main / java / org / opendaylight / openflowplugin / api / openflow / device / DeviceContext.java

diff --git a/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceContext.java b/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceContext.java
index 676c21c780ba112cc69264d4d2b192c0b30d58e1..5e8cbcba3dee6c4f333eec3332198b5dc9e54836 100644 (file)
--- a/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceContext.java
+++ b/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceContext.java
@@ -5,22 +5,17 @@
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
-
 package org.opendaylight.openflowplugin.api.openflow.device;
 
-import com.google.common.util.concurrent.ListenableFuture;
-import io.netty.util.Timeout;
-import java.math.BigInteger;
 import java.util.List;
-import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
+import org.opendaylight.mdsal.binding.api.NotificationPublishService;
 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
-import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
-import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainStateListener;
 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
 
 /**
  * The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
@@ -38,27 +33,11 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731
  */
 public interface DeviceContext extends
         OFPContext,
-        AutoCloseable,
         DeviceReplyProcessor,
         TxFacade,
-        DeviceRegistry{
-
-    /**
-     * Method close all auxiliary connections and primary connection.
-     */
-    void shutdownConnection();
-
-    /**
-     * Method add auxiliary connection contexts to this context representing single device connection.
-     * @param connectionContext new connection context
-     */
-    void addAuxiliaryConnectionContext(ConnectionContext connectionContext);
-
-    /**
-     * Method removes auxiliary connection context from this context representing single device connection.
-     * @param connectionContext connection which need to be removed
-     */
-    void removeAuxiliaryConnectionContext(ConnectionContext connectionContext);
+        DeviceRegistry,
+        RequestContextStack,
+        ContextChainStateListener {
 
     /**
      * Method provides state of device represented by this device context.
@@ -68,69 +47,62 @@ public interface DeviceContext extends
     DeviceState getDeviceState();
 
     /**
-     * Method has to close TxManager ASAP we are notified about Closed Connection
-     * @return sync. future for Slave and MD-SAL completition for Master
-     */
-    ListenableFuture<Void> shuttingDownDataStoreTransactions();
-
-    /**
+     * Getter.
+     *
      * @return current devices connection context
      */
     ConnectionContext getPrimaryConnectionContext();
 
     /**
-     * @return current devices auxiliary connection contexts
-     */
-    ConnectionContext getAuxiliaryConnectionContexts(BigInteger cookie);
-
-
-    /**
+     * Getter.
+     *
      * @return translator library
      */
     TranslatorLibrary oook();
 
     /**
-     * store cancellable timeout handler of currently running barrier task
+     * Sets notification publish service.
+     *
+     * @param notificationPublishService the notification publish service
      */
-    void setCurrentBarrierTimeout(Timeout timeout);
+    void setNotificationPublishService(NotificationPublishService notificationPublishService);
 
     /**
-     * @return cancellable timeout handle of currently running barrier task
+     * Gets message spy.
+     *
+     * @return the message spy
      */
-    Timeout getBarrierTaskTimeout();
-
-    void setNotificationPublishService(NotificationPublishService notificationPublishService);
-
     MessageSpy getMessageSpy();
 
-    MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);
+    /**
+     * Gets multi msg collector.
+     *
+     * @param <T>            the type parameter
+     * @param requestContext the request context
+     * @return the multi msg collector
+     */
+    <T extends OfHeader> MultiMsgCollector<T> getMultiMsgCollector(RequestContext<List<T>> requestContext);
 
     /**
-     * indicates that device context is fully published (e.g.: packetIn messages should be passed)
+     * Indicates that device context is fully published (e.g.: packetIn messages should be passed).
      */
     void onPublished();
 
     /**
-     * change packetIn rate limiter borders
-     *
+     * change packetIn rate limiter borders.
      * @param upperBound max amount of outstanding packetIns
      */
     void updatePacketInRateLimit(long upperBound);
 
     /**
-     * @return registry point for item life cycle sources of device
+     * Checks if device and controller supports single layer serialization.
+     * @return true if single layer serialization is supported
      */
-    ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
-
-    @Override
-    void close();
-
-    void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory);
+    boolean canUseSingleLayerSerialization();
 
-    void putLifecycleServiceIntoTxChainManager(LifecycleService lifecycleService);
-
-    void replaceConnectionContext(ConnectionContext connectionContext);
-
-    boolean isSkipTableFeatures();
+    /**
+     * Method for initial submit transaction after successful initial gathering.
+     */
+    boolean initialSubmitTransaction();
 }