Bump odlparent to 5.0.0
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / lifecycle / ContextChainHolderImpl.java
index 7ed91e26dc395927c61c39c1f61b4fe8242a8826..56045af70992f6ea48fdde65d4b9bb576efe3f8c 100644 (file)
@@ -11,23 +11,22 @@ import com.google.common.annotations.VisibleForTesting;
 import com.google.common.util.concurrent.FutureCallback;
 import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.MoreExecutors;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
-import java.util.concurrent.ExecutionException;
 import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ExecutionException;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
 import java.util.stream.Collectors;
 import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange;
-import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListenerRegistration;
-import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
-import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
+import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipChange;
+import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipListenerRegistration;
+import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipService;
 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
 import org.opendaylight.openflowplugin.api.openflow.OFPManager;
 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
@@ -50,9 +49,10 @@ import org.opendaylight.openflowplugin.impl.util.DeviceStateUtil;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.core.general.entity.rev150930.Entity;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.rf.state.rev170713.ResultState;
 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -64,6 +64,7 @@ public class ContextChainHolderImpl implements ContextChainHolder, MasterChecker
     private static final String ASYNC_SERVICE_ENTITY_TYPE = "org.opendaylight.mdsal.AsyncServiceCloseEntityType";
 
     private final Map<DeviceInfo, ContextChain> contextChainMap = new ConcurrentHashMap<>();
+    private final Map<DeviceInfo, ? super ConnectionContext> connectingDevices = new ConcurrentHashMap<>();
     private final EntityOwnershipListenerRegistration eosListenerRegistration;
     private final ClusterSingletonServiceProvider singletonServiceProvider;
     private final ExecutorService executorService;
@@ -81,22 +82,22 @@ public class ContextChainHolderImpl implements ContextChainHolder, MasterChecker
         this.executorService = executorService;
         this.ownershipChangeListener = ownershipChangeListener;
         this.ownershipChangeListener.setMasterChecker(this);
-        this.eosListenerRegistration = Objects.requireNonNull(entityOwnershipService
-                .registerListener(ASYNC_SERVICE_ENTITY_TYPE, this));
+        this.eosListenerRegistration = Objects
+                .requireNonNull(entityOwnershipService.registerListener(ASYNC_SERVICE_ENTITY_TYPE, this));
     }
 
     @Override
     public <T extends OFPManager> void addManager(final T manager) {
-        if (Objects.isNull(deviceManager) && manager instanceof DeviceManager) {
+        if (deviceManager == null && manager instanceof DeviceManager) {
             LOG.trace("Context chain holder: Device manager OK.");
             deviceManager = (DeviceManager) manager;
-        } else if (Objects.isNull(rpcManager) && manager instanceof RpcManager) {
+        } else if (rpcManager == null && manager instanceof RpcManager) {
             LOG.trace("Context chain holder: RPC manager OK.");
             rpcManager = (RpcManager) manager;
-        } else if (Objects.isNull(statisticsManager) && manager instanceof StatisticsManager) {
+        } else if (statisticsManager == null && manager instanceof StatisticsManager) {
             LOG.trace("Context chain holder: Statistics manager OK.");
             statisticsManager = (StatisticsManager) manager;
-        } else if (Objects.isNull(roleManager) && manager instanceof RoleManager) {
+        } else if (roleManager == null && manager instanceof RoleManager) {
             LOG.trace("Context chain holder: Role manager OK.");
             roleManager = (RoleManager) manager;
         }
@@ -114,7 +115,8 @@ public class ContextChainHolderImpl implements ContextChainHolder, MasterChecker
         rpcContext.registerMastershipWatcher(this);
         LOG.debug("RPC" + CONTEXT_CREATED_FOR_CONNECTION, deviceInfo);
 
-        final StatisticsContext statisticsContext = statisticsManager.createContext(deviceContext);
+        final StatisticsContext statisticsContext = statisticsManager
+                .createContext(deviceContext, ownershipChangeListener.isReconciliationFrameworkRegistered());
         statisticsContext.registerMastershipWatcher(this);
         LOG.debug("Statistics" + CONTEXT_CREATED_FOR_CONNECTION, deviceInfo);
 
@@ -122,8 +124,7 @@ public class ContextChainHolderImpl implements ContextChainHolder, MasterChecker
         roleContext.registerMastershipWatcher(this);
         LOG.debug("Role" + CONTEXT_CREATED_FOR_CONNECTION, deviceInfo);
 
-        final ContextChain contextChain = new ContextChainImpl(this, connectionContext,
-                executorService);
+        final ContextChain contextChain = new ContextChainImpl(this, connectionContext, executorService);
         contextChain.registerDeviceRemovedHandler(deviceManager);
         contextChain.registerDeviceRemovedHandler(rpcManager);
         contextChain.registerDeviceRemovedHandler(statisticsManager);
@@ -134,6 +135,7 @@ public class ContextChainHolderImpl implements ContextChainHolder, MasterChecker
         contextChain.addContext(statisticsContext);
         contextChain.addContext(roleContext);
         contextChainMap.put(deviceInfo, contextChain);
+        connectingDevices.remove(deviceInfo);
         LOG.debug("Context chain" + CONTEXT_CREATED_FOR_CONNECTION, deviceInfo);
 
         deviceContext.onPublished();
@@ -141,35 +143,59 @@ public class ContextChainHolderImpl implements ContextChainHolder, MasterChecker
     }
 
     @Override
-    public ConnectionStatus deviceConnected(final ConnectionContext connectionContext) throws Exception {
+    public ConnectionStatus deviceConnected(final ConnectionContext connectionContext) {
         final DeviceInfo deviceInfo = connectionContext.getDeviceInfo();
         final ContextChain contextChain = contextChainMap.get(deviceInfo);
-        LOG.info("Device {} connected.", deviceInfo);
-
-        if (Objects.nonNull(contextChain)) {
-            if (contextChain.isClosing()) {
-                LOG.warn("Device {} is already in termination state, closing all incoming connections.", deviceInfo);
-                return ConnectionStatus.CLOSING;
+        final FeaturesReply featuresReply = connectionContext.getFeatures();
+        final Short auxiliaryId = featuresReply != null ? featuresReply.getAuxiliaryId() : null;
+
+        if (auxiliaryId != null && auxiliaryId != 0) {
+            if (contextChain == null) {
+                LOG.warn("An auxiliary connection for device {}, but no primary connection. Refusing connection.",
+                         deviceInfo);
+                return ConnectionStatus.REFUSING_AUXILIARY_CONNECTION;
+            } else {
+                if (contextChain.addAuxiliaryConnection(connectionContext)) {
+                    LOG.info("An auxiliary connection was added to device: {}", deviceInfo);
+                    return ConnectionStatus.MAY_CONTINUE;
+                } else {
+                    LOG.warn("Not able to add auxiliary connection to the device {}", deviceInfo);
+                    return ConnectionStatus.REFUSING_AUXILIARY_CONNECTION;
+                }
+            }
+        } else {
+            LOG.info("Device {} connected.", deviceInfo);
+            final boolean contextExists = contextChain != null;
+            final boolean isClosing = contextExists && contextChain.isClosing();
+
+            if (!isClosing && connectingDevices.putIfAbsent(deviceInfo, connectionContext) != null) {
+                LOG.warn("Device {} is already trying to connect, wait until succeeded or disconnected.", deviceInfo);
+                return ConnectionStatus.ALREADY_CONNECTED;
             }
 
-            if (contextChain.addAuxiliaryConnection(connectionContext)) {
-                LOG.info("An auxiliary connection was added to device: {}", deviceInfo);
-                return ConnectionStatus.MAY_CONTINUE;
+            if (contextExists) {
+                if (isClosing) {
+                    LOG.warn("Device {} is already in termination state, closing all incoming connections.",
+                             deviceInfo);
+                    return ConnectionStatus.CLOSING;
+                }
+
+                LOG.warn("Device {} already connected. Closing previous connection", deviceInfo);
+                destroyContextChain(deviceInfo);
+                LOG.info("Old connection dropped, creating new context chain for device {}", deviceInfo);
+                createContextChain(connectionContext);
+            } else {
+                LOG.info("No context chain found for device: {}, creating new.", deviceInfo);
+                createContextChain(connectionContext);
             }
 
-            LOG.warn("Device {} already connected. Closing all connection to the device.", deviceInfo);
-            destroyContextChain(deviceInfo);
-            return ConnectionStatus.ALREADY_CONNECTED;
+            return ConnectionStatus.MAY_CONTINUE;
         }
 
-        LOG.debug("No context chain found for device: {}, creating new.", deviceInfo);
-        createContextChain(connectionContext);
-        return ConnectionStatus.MAY_CONTINUE;
     }
 
     @Override
-    public void onNotAbleToStartMastership(@Nonnull final DeviceInfo deviceInfo,
-                                           @Nonnull final String reason,
+    public void onNotAbleToStartMastership(@Nonnull final DeviceInfo deviceInfo, @Nonnull final String reason,
                                            final boolean mandatory) {
         LOG.warn("Not able to set MASTER role on device {}, reason: {}", deviceInfo, reason);
 
@@ -178,7 +204,8 @@ public class ContextChainHolderImpl implements ContextChainHolder, MasterChecker
         }
 
         Optional.ofNullable(contextChainMap.get(deviceInfo)).ifPresent(contextChain -> {
-            LOG.warn("This mastering is mandatory, destroying context chain and closing connection for device {}.", deviceInfo);
+            LOG.warn("This mastering is mandatory, destroying context chain and closing connection for device {}.",
+                     deviceInfo);
             destroyContextChain(deviceInfo);
         });
     }
@@ -187,19 +214,14 @@ public class ContextChainHolderImpl implements ContextChainHolder, MasterChecker
     public void onMasterRoleAcquired(@Nonnull final DeviceInfo deviceInfo,
                                      @Nonnull final ContextChainMastershipState mastershipState) {
         Optional.ofNullable(contextChainMap.get(deviceInfo)).ifPresent(contextChain -> {
-            if (ownershipChangeListener.isReconciliationFrameworkRegistered()) {
-                if (mastershipState == ContextChainMastershipState.INITIAL_SUBMIT) {
-                    LOG.error("Initial submit is not allowed here if using reconciliation framework.");
-                } else {
-                    contextChain.isMastered(mastershipState);
-                    if (contextChain.isPrepared()) {
-                        Futures.addCallback(
-                                ownershipChangeListener.becomeMasterBeforeSubmittedDS(deviceInfo),
-                                reconciliationFrameworkCallback(deviceInfo, contextChain),
-                                MoreExecutors.directExecutor());
-                    }
+            if (ownershipChangeListener.isReconciliationFrameworkRegistered()
+                    && !ContextChainMastershipState.INITIAL_SUBMIT.equals(mastershipState)) {
+                if (contextChain.isMastered(mastershipState, true)) {
+                    Futures.addCallback(ownershipChangeListener.becomeMasterBeforeSubmittedDS(deviceInfo),
+                                        reconciliationFrameworkCallback(deviceInfo, contextChain),
+                                        MoreExecutors.directExecutor());
                 }
-            } else if (contextChain.isMastered(mastershipState)) {
+            } else if (contextChain.isMastered(mastershipState, false)) {
                 LOG.info("Role MASTER was granted to device {}", deviceInfo);
                 ownershipChangeListener.becomeMaster(deviceInfo);
                 deviceManager.sendNodeAddedNotification(deviceInfo.getNodeInstanceIdentifier());
@@ -224,28 +246,28 @@ public class ContextChainHolderImpl implements ContextChainHolder, MasterChecker
     public void onDeviceDisconnected(final ConnectionContext connectionContext) {
         final DeviceInfo deviceInfo = connectionContext.getDeviceInfo();
 
-        Optional.ofNullable(connectionContext.getDeviceInfo())
-                .map(contextChainMap::get)
-                .ifPresent(contextChain -> {
-                    if (contextChain.auxiliaryConnectionDropped(connectionContext)) {
-                        LOG.info("Auxiliary connection from device {} disconnected.", deviceInfo);
-                    } else {
-                        LOG.info("Device {} disconnected.", deviceInfo);
-                        destroyContextChain(deviceInfo);
-                    }
-                });
+        Optional.ofNullable(connectionContext.getDeviceInfo()).map(contextChainMap::get).ifPresent(contextChain -> {
+            if (contextChain.auxiliaryConnectionDropped(connectionContext)) {
+                LOG.info("Auxiliary connection from device {} disconnected.", deviceInfo);
+            } else {
+                LOG.info("Device {} disconnected.", deviceInfo);
+                destroyContextChain(deviceInfo);
+            }
+        });
     }
 
     @VisibleForTesting
     boolean checkAllManagers() {
-        return Objects.nonNull(deviceManager)
-                && Objects.nonNull(rpcManager)
-                && Objects.nonNull(statisticsManager)
-                && Objects.nonNull(roleManager);
+        return deviceManager != null && rpcManager != null && statisticsManager != null && roleManager != null;
+    }
+
+    @Override
+    public ContextChain getContextChain(final DeviceInfo deviceInfo) {
+        return contextChainMap.get(deviceInfo);
     }
 
     @Override
-    public void close() throws Exception {
+    public void close() {
         Map<DeviceInfo, ContextChain> copyOfChains = new HashMap<>(contextChainMap);
         copyOfChains.keySet().forEach(this::destroyContextChain);
         copyOfChains.clear();
@@ -254,30 +276,35 @@ public class ContextChainHolderImpl implements ContextChainHolder, MasterChecker
     }
 
     @Override
+    @SuppressFBWarnings("BC_UNCONFIRMED_CAST_OF_RETURN_VALUE")
     public void ownershipChanged(EntityOwnershipChange entityOwnershipChange) {
-        if (entityOwnershipChange.hasOwner()) {
+        if (entityOwnershipChange.getState().hasOwner()) {
             return;
         }
 
-        final String entityName = getEntityNameFromOwnershipChange(entityOwnershipChange);
+        // Findbugs flags a false violation for "Unchecked/unconfirmed cast" from GenericEntity to Entity hence the
+        // suppression above. The suppression is temporary until EntityOwnershipChange is modified to eliminate the
+        // violation.
+        final String entityName = entityOwnershipChange
+                .getEntity()
+                .getIdentifier()
+                .firstKeyOf(Entity.class)
+                .getName();
 
-        if (Objects.nonNull(entityName)) {
+        if (entityName != null) {
             LOG.debug("Entity {} has no owner", entityName);
-            final NodeId nodeId = new NodeId(entityName);
-
             try {
+                //TODO:Remove notifications
                 final KeyedInstanceIdentifier<Node, NodeKey> nodeInstanceIdentifier =
-                        DeviceStateUtil.createNodeInstanceIdentifier(nodeId);
-
+                        DeviceStateUtil.createNodeInstanceIdentifier(new NodeId(entityName));
                 deviceManager.sendNodeRemovedNotification(nodeInstanceIdentifier);
 
-                LOG.info("Try to remove device {} from operational DS", nodeId);
-                deviceManager
-                        .removeDeviceFromOperationalDS(nodeInstanceIdentifier)
+                LOG.info("Try to remove device {} from operational DS", entityName);
+                deviceManager.removeDeviceFromOperationalDS(nodeInstanceIdentifier)
                         .get(REMOVE_DEVICE_FROM_DS_TIMEOUT, TimeUnit.MILLISECONDS);
-                LOG.info("Removing device from operational DS {} was successful", nodeId);
+                LOG.info("Removing device from operational DS {} was successful", entityName);
             } catch (TimeoutException | ExecutionException | NullPointerException | InterruptedException e) {
-                LOG.warn("Not able to remove device {} from operational DS. ",nodeId, e);
+                LOG.warn("Not able to remove device {} from operational DS. ", entityName, e);
             }
         }
     }
@@ -287,45 +314,23 @@ public class ContextChainHolderImpl implements ContextChainHolder, MasterChecker
         Optional.ofNullable(contextChainMap.get(deviceInfo)).ifPresent(contextChain -> {
             deviceManager.sendNodeRemovedNotification(deviceInfo.getNodeInstanceIdentifier());
             contextChain.close();
+            connectingDevices.remove(deviceInfo);
         });
     }
 
     @Override
     public List<DeviceInfo> listOfMasteredDevices() {
-        return contextChainMap
-                .entrySet()
-                .stream()
-                .filter(deviceInfoContextChainEntry -> deviceInfoContextChainEntry
-                        .getValue()
-                        .isMastered(ContextChainMastershipState.CHECK))
-                .map(Map.Entry::getKey)
+        return contextChainMap.entrySet().stream()
+                .filter(deviceInfoContextChainEntry -> deviceInfoContextChainEntry.getValue()
+                        .isMastered(ContextChainMastershipState.CHECK, false)).map(Map.Entry::getKey)
                 .collect(Collectors.toList());
     }
 
     @Override
     public boolean isAnyDeviceMastered() {
-        return contextChainMap
-                .entrySet()
-                .stream()
-                .findAny()
+        return contextChainMap.entrySet().stream().findAny()
                 .filter(deviceInfoContextChainEntry -> deviceInfoContextChainEntry.getValue()
-                        .isMastered(ContextChainMastershipState.CHECK))
-                .isPresent();
-    }
-
-    private String getEntityNameFromOwnershipChange(final EntityOwnershipChange entityOwnershipChange) {
-        final YangInstanceIdentifier.NodeIdentifierWithPredicates lastIdArgument =
-                (YangInstanceIdentifier.NodeIdentifierWithPredicates) entityOwnershipChange
-                        .getEntity()
-                        .getId()
-                        .getLastPathArgument();
-
-        return lastIdArgument
-                .getKeyValues()
-                .values()
-                .iterator()
-                .next()
-                .toString();
+                        .isMastered(ContextChainMastershipState.CHECK, false)).isPresent();
     }
 
     @Override
@@ -334,21 +339,14 @@ public class ContextChainHolderImpl implements ContextChainHolder, MasterChecker
         LOG.debug("Context chain removed for node {}", deviceInfo);
     }
 
-    private FutureCallback<ResultState> reconciliationFrameworkCallback(
-            @Nonnull DeviceInfo deviceInfo,
-            ContextChain contextChain) {
+    private FutureCallback<ResultState> reconciliationFrameworkCallback(@Nonnull DeviceInfo deviceInfo,
+                                                                        ContextChain contextChain) {
         return new FutureCallback<ResultState>() {
             @Override
-            public void onSuccess(@Nullable ResultState result) {
+            public void onSuccess(ResultState result) {
                 if (ResultState.DONOTHING == result) {
                     LOG.info("Device {} connection is enabled by reconciliation framework.", deviceInfo);
-                    if (!contextChain.continueInitializationAfterReconciliation()) {
-                        LOG.warn("Initialization submit after reconciliation failed for device {}", deviceInfo);
-                        destroyContextChain(deviceInfo);
-                    } else {
-                        ownershipChangeListener.becomeMaster(deviceInfo);
-                        deviceManager.sendNodeAddedNotification(deviceInfo.getNodeInstanceIdentifier());
-                    }
+                    contextChain.continueInitializationAfterReconciliation();
                 } else {
                     LOG.warn("Reconciliation framework failure for device {}", deviceInfo);
                     destroyContextChain(deviceInfo);
@@ -356,7 +354,7 @@ public class ContextChainHolderImpl implements ContextChainHolder, MasterChecker
             }
 
             @Override
-            public void onFailure(@Nonnull Throwable t) {
+            public void onFailure(Throwable throwable) {
                 LOG.warn("Reconciliation framework failure.");
                 destroyContextChain(deviceInfo);
             }