Bug 5596 Cleaning part 1
[openflowplugin.git] / openflowplugin-api / src / main / java / org / opendaylight / openflowplugin / api / openflow / device / DeviceContext.java
index 413131105b20f17b2c972a0a15f1f410f8118ec6..c7dca5069ad58c2d8c97c429a833c8be21e2f2b1 100644 (file)
@@ -8,28 +8,18 @@
 
 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.controller.md.sal.binding.api.NotificationService;
-import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
-import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.openflowplugin.api.openflow.OpenFlowPluginTimer;
+import org.opendaylight.openflowplugin.api.openflow.OFPContext;
 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceContextClosedHandler;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceDisconnectedHandler;
 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
-import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
-import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
-import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
-import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
-import org.opendaylight.yangtools.yang.binding.DataObject;
-import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 
 /**
  * <p>
@@ -46,29 +36,33 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  * Context can have at any point in time. Should this quota be exceeded, any further attempt to make
  * a request to the switch will fail immediately, with proper error indication.
  * </p>
- * Created by Martin Bobak &lt;mbobak@cisco.com&gt; on 25.2.2015.
  */
-public interface DeviceContext extends AutoCloseable,
-        OpenFlowPluginTimer,
+public interface DeviceContext extends
+        OFPContext,
+        AutoCloseable,
         DeviceReplyProcessor,
-        DeviceDisconnectedHandler,
-        PortNumberCache {
+        TxFacade,
+        XidSequencer,
+        DeviceRegistry{
 
+    /**
+     * Method close all auxiliary connections and primary connection.
+     */
+    void shutdownConnection();
+
+    void initialSubmitTransaction();
 
     /**
      * Method add auxiliary connection contexts to this context representing single device connection.
-     *
-     * @param connectionContext
+     * @param connectionContext new connection context
      */
-    void addAuxiliaryConenctionContext(ConnectionContext connectionContext);
+    void addAuxiliaryConnectionContext(ConnectionContext connectionContext);
 
     /**
      * Method removes auxiliary connection context from this context representing single device connection.
-     *
-     * @param connectionContext
+     * @param connectionContext connection which need to be removed
      */
-    void removeAuxiliaryConenctionContext(ConnectionContext connectionContext);
-
+    void removeAuxiliaryConnectionContext(ConnectionContext connectionContext);
 
     /**
      * Method provides state of device represented by this device context.
@@ -78,65 +72,21 @@ public interface DeviceContext extends AutoCloseable,
     DeviceState getDeviceState();
 
     /**
-     * Method creates put operation using provided data in underlying transaction chain.
-     */
-    <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store, final InstanceIdentifier<T> path, final T data);
-
-    /**
-     * Method creates delete operation for provided path in underlying transaction chain.
-     */
-    <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path);
-
-    /**
-     * Method submits Transaction to DataStore.
-     * @return transaction is submitted successfully
-     */
-    boolean submitTransaction();
-
-    /**
-     * Method exposes transaction created for device
-     * represented by this context. This read only transaction has a fresh dataStore snapshot.
-     * There is a possibility to get different data set from  DataStore
-     * as write transaction in this context.
+     * Method has to close TxManager ASAP we are notified about Closed Connection
+     * @return sync. future for Slave and MD-SAL completition for Master
      */
-    ReadTransaction getReadTransaction();
-
+    ListenableFuture<Void> shuttingDownDataStoreTransactions();
 
     /**
-     * Method provides current devices connection context.
-     *
-     * @return
+     * @return current devices connection context
      */
     ConnectionContext getPrimaryConnectionContext();
 
     /**
-     * Method provides current devices auxiliary connection contexts.
-     *
-     * @return
+     * @return current devices auxiliary connection contexts
      */
     ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
 
-    /**
-     * Method exposes flow registry used for storing flow ids identified by calculated flow hash.
-     *
-     * @return
-     */
-    DeviceFlowRegistry getDeviceFlowRegistry();
-
-    /**
-     * Method exposes device group registry used for storing group ids.
-     *
-     * @return
-     */
-    DeviceGroupRegistry getDeviceGroupRegistry();
-
-    /**
-     * Method exposes device meter registry used for storing meter ids.
-     *
-     * @return
-     */
-    DeviceMeterRegistry getDeviceMeterRegistry();
-
 
     /**
      * @return translator library
@@ -153,26 +103,12 @@ public interface DeviceContext extends AutoCloseable,
      */
     Timeout getBarrierTaskTimeout();
 
-    /**
-     * Sets notification service
-     *
-     * @param notificationService
-     */
-    void setNotificationService(NotificationService notificationService);
-
     void setNotificationPublishService(NotificationPublishService notificationPublishService);
 
     MessageSpy getMessageSpy();
 
-    /**
-     * Method sets reference to handler used for cleanup after device context about to be closed.
-     */
-    void addDeviceContextClosedHandler(DeviceContextClosedHandler deviceContextClosedHandler);
-
     MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);
 
-    Long getReservedXid();
-
     /**
      * indicates that device context is fully published (e.g.: packetIn messages should be passed)
      */
@@ -190,13 +126,10 @@ public interface DeviceContext extends AutoCloseable,
      */
     ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
 
-    void setRpcContext(RpcContext rpcContext);
+    @Override
+    void close();
 
-    RpcContext getRpcContext();
+    void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory);
 
-    /**
-     * Callback when confirmed that device is disconnected from cluster
-      */
-    void onDeviceDisconnectedFromCluster();
 }