Bug 4957 Role lifecycle support for TxChainManager in DeviceContext

[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 6eb8b322a89c7db5dc7981b3e1985926cd55e542..ac5e920df4a25aa339e775301dd6e831e741ffc0 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,9 +8,11 @@
 
 package org.opendaylight.openflowplugin.api.openflow.device;
 
-import io.netty.util.Timeout;
+import javax.annotation.CheckForNull;
 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;
@@ -20,14 +22,15 @@ 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;
 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.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
 import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 
@@ -50,7 +53,6 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  */
 public interface DeviceContext extends AutoCloseable,
         OpenFlowPluginTimer,
-        MessageHandler,
         DeviceReplyProcessor,
         DeviceDisconnectedHandler,
         PortNumberCache {
@@ -78,6 +80,24 @@ 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}
+     */
+    void onClusterRoleChange(@CheckForNull OfpRole role);
+
+    /**
+     * Same as {@link DeviceContext#onClusterRoleChange(OfpRole)} but it should be call for new
+     * connection initialization only, because submit transaction is not active in this time.
+     * @param role - NewRole expect to be {@link OfpRole#BECOMESLAVE} or {@link OfpRole#BECOMEMASTER}
+     */
+    void onInitClusterRoleChange(@CheckForNull final OfpRole role);
+
     /**
      * Method creates put operation using provided data in underlying transaction chain.
      */
@@ -190,5 +210,14 @@ public interface DeviceContext extends AutoCloseable,
      * @return registry point for item life cycle sources of device
      */
     ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
+
+    void setRpcContext(RpcContext rpcContext);
+
+    RpcContext getRpcContext();
+
+    /**
+     * Callback when confirmed that device is disconnected from cluster
+      */
+    void onDeviceDisconnectedFromCluster(final boolean removeNodeFromDS);
 }