Merge "Bug-4957: Make async operational DS Read"

[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 740ba139d29bb86a402b4589fef9f376ee16e53b..d0c282d0ab42896d54dfeec212584903234fd00a 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
@@ -8,19 +8,22 @@
 
 package org.opendaylight.openflowplugin.api.openflow.device;
 
+import javax.annotation.CheckForNull;
+import com.google.common.util.concurrent.ListenableFuture;
 import io.netty.util.Timeout;
 import java.math.BigInteger;
 import java.util.List;
+
+import io.netty.util.Timeout;
 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.binding.api.ReadOnlyTransaction;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.openflowplugin.api.openflow.OpenFlowPluginTimer;
 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.MessageHandler;
 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;
@@ -29,6 +32,7 @@ import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRe
 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.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
 import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 
@@ -51,7 +55,6 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  */
 public interface DeviceContext extends AutoCloseable,
         OpenFlowPluginTimer,
-        MessageHandler,
         DeviceReplyProcessor,
         DeviceDisconnectedHandler,
         PortNumberCache {
@@ -79,6 +82,17 @@ public interface DeviceContext extends AutoCloseable,
      */
     DeviceState getDeviceState();
 
+    /**
+     * Method has to activate (MASTER) or deactivate (SLAVE) TransactionChainManager.
+     * TransactionChainManager represents possibility to write or delete Node subtree data
+     * for actual Controller Cluster Node. We are able to have an active TxManager only if
+     * newRole is {@link OfpRole#BECOMESLAVE}.
+     * Parameters are used as marker to be sure it is change to SLAVE from MASTER or from
+     * MASTER to SLAVE and the last parameter "cleanDataStore" is used for validation only.
+     * @param role - NewRole expect to be {@link OfpRole#BECOMESLAVE} or {@link OfpRole#BECOMEMASTER}
+     */
+    ListenableFuture<Void> onClusterRoleChange(@CheckForNull OfpRole role);
+
     /**
      * Method creates put operation using provided data in underlying transaction chain.
      */
@@ -100,8 +114,9 @@ public interface DeviceContext extends AutoCloseable,
      * 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.
+     * @return readOnlyTransaction - Don't forget to close it after finish reading
      */
-    ReadTransaction getReadTransaction();
+    ReadOnlyTransaction getReadTransaction();
 
 
     /**
@@ -196,9 +211,7 @@ public interface DeviceContext extends AutoCloseable,
 
     RpcContext getRpcContext();
 
-    /**
-     * Callback when confirmed that device is disconnected from cluster
-      */
-    void onDeviceDisconnectedFromCluster();
+    @Override
+    void close();
 }