Merge "Declare reconciliation artifacts"
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / connection / ConnectionContextImpl.java
index 986bbb178e4fae8ecac206b4c1c4c5095601a1c9..03ad021192ff74989b150d849c67e6ab705423f8 100644 (file)
@@ -1,23 +1,19 @@
-/**
+/*
  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * 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.impl.connection;
 
+import com.google.common.base.MoreObjects;
 import com.google.common.base.Preconditions;
 import java.math.BigInteger;
-import java.net.InetSocketAddress;
-import java.util.Objects;
-import java.util.concurrent.Callable;
-import java.util.concurrent.ExecutionException;
-import java.util.concurrent.Executors;
-import java.util.concurrent.Future;
-import java.util.concurrent.TimeUnit;
-import java.util.concurrent.TimeoutException;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter;
 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueue;
@@ -33,13 +29,11 @@ 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.openflow.protocol.rev130731.PortStatusMessage;
 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/**
- *
- */
 public class ConnectionContextImpl implements ConnectionContext {
 
     private final ConnectionAdapter connectionAdapter;
@@ -52,9 +46,12 @@ public class ConnectionContextImpl implements ConnectionContext {
     private OutboundQueueHandlerRegistration<OutboundQueueProvider> outboundQueueHandlerRegistration;
     private HandshakeContext handshakeContext;
     private DeviceInfo deviceInfo;
+    private final List<PortStatusMessage> portStatusMessages = new ArrayList<>();
 
     /**
-     * @param connectionAdapter
+     * Constructor.
+     *
+     * @param connectionAdapter - connection adapter
      */
     public ConnectionContextImpl(final ConnectionAdapter connectionAdapter) {
         this.connectionAdapter = connectionAdapter;
@@ -102,118 +99,99 @@ public class ConnectionContextImpl implements ConnectionContext {
     }
 
     @Override
-    public void setFeatures(final FeaturesReply featuresReply) {
-        this.featuresReply = featuresReply;
+    public void setFeatures(final FeaturesReply newFeaturesReply) {
+        this.featuresReply = newFeaturesReply;
     }
 
     @Override
     public void closeConnection(final boolean propagate) {
-        if (null == nodeId){
-            SessionStatistics.countEvent(connectionAdapter.getRemoteAddress().toString(), SessionStatistics.ConnectionStatus.CONNECTION_DISCONNECTED_BY_OFP);
-        } else {
-            SessionStatistics.countEvent(nodeId.toString(), SessionStatistics.ConnectionStatus.CONNECTION_DISCONNECTED_BY_OFP);
-        }
-        final BigInteger datapathId = featuresReply != null ? featuresReply.getDatapathId() : BigInteger.ZERO;
-        LOG.debug("Actively closing connection: {}, datapathId: {}",
-                connectionAdapter.getRemoteAddress(), datapathId);
-        connectionState = ConnectionContext.CONNECTION_STATE.RIP;
-
-        Future<Void> future = Executors.newSingleThreadExecutor().submit(new Callable<Void>() {
-            @Override
-            public Void call() throws Exception {
-                unregisterOutboundQueue();
-                return null;
-            }
-        });
-        try {
-            future.get(1, TimeUnit.SECONDS);
-            LOG.info("Unregister outbound queue successful.");
-        } catch (InterruptedException | TimeoutException | ExecutionException e) {
-            LOG.warn("Unregister outbound queue throws exception for node {} ", getSafeNodeIdForLOG());
-            LOG.trace("Unregister outbound queue throws exception for node {} ", getSafeNodeIdForLOG(), e);
-        }
-
-        closeHandshakeContext();
-
-        if (getConnectionAdapter().isAlive()) {
-            getConnectionAdapter().disconnect();
-        }
-
-        if (propagate) {
-            LOG.debug("Propagating device disconnect for node {}", getSafeNodeIdForLOG());
-            propagateDeviceDisconnectedEvent();
-        } else {
-            LOG.debug("Close connection without propagating for node {}", getSafeNodeIdForLOG());
-        }
+        disconnectDevice(propagate, true);
     }
 
     private void closeHandshakeContext() {
         LOG.debug("Trying closing handshake context for node {}", getSafeNodeIdForLOG());
         if (handshakeContext != null) {
-            try {
-                handshakeContext.close();
-            } catch (Exception e) {
-                LOG.error("handshake context closing failed:{} ", e);
-            } finally {
-                handshakeContext = null;
-            }
+            handshakeContext.close();
+            handshakeContext = null;
         }
     }
 
     @Override
     public void onConnectionClosed() {
+        disconnectDevice(true, false);
+    }
 
-        connectionState = ConnectionContext.CONNECTION_STATE.RIP;
-
-        if (null == nodeId){
-            SessionStatistics.countEvent(connectionAdapter.getRemoteAddress().toString(), SessionStatistics.ConnectionStatus.CONNECTION_DISCONNECTED_BY_DEVICE);
-        } else {
-            SessionStatistics.countEvent(nodeId.toString(), SessionStatistics.ConnectionStatus.CONNECTION_DISCONNECTED_BY_DEVICE);
+    private void disconnectDevice(final boolean propagate,
+                                  final boolean forced) {
+        final String device = nodeId != null ? nodeId.getValue() : getConnectionAdapter().getRemoteAddress().toString();
+        final short auxiliaryId = Optional
+                .ofNullable(getFeatures())
+                .flatMap(features -> Optional
+                        .ofNullable(features.getAuxiliaryId()))
+                .orElse((short) 0);
+
+        if (connectionState == CONNECTION_STATE.RIP) {
+            LOG.debug("Connection for device {} with auxiliary ID {} is already {}, so skipping closing.",
+                    device, auxiliaryId, getConnectionState());
+            return;
         }
 
-        final InetSocketAddress remoteAddress = connectionAdapter.getRemoteAddress();
-        final Short auxiliaryId;
-        if (null != getFeatures() && null != getFeatures().getAuxiliaryId()) {
-            auxiliaryId = getFeatures().getAuxiliaryId();
-        } else {
-            auxiliaryId = 0;
-        }
+        connectionState = ConnectionContext.CONNECTION_STATE.RIP;
+
+        SessionStatistics.countEvent(device, forced
+                ? SessionStatistics.ConnectionStatus.CONNECTION_DISCONNECTED_BY_OFP
+                : SessionStatistics.ConnectionStatus.CONNECTION_DISCONNECTED_BY_DEVICE);
 
-        LOG.debug("disconnecting: node={}|auxId={}|connection state = {}",
-                remoteAddress,
+        LOG.debug("{}: device={} | auxiliaryId={} | connectionState={}",
+                forced ? "Actively closing connection" : "Disconnecting",
+                device,
                 auxiliaryId,
                 getConnectionState());
 
+        portStatusMessages.clear();
         unregisterOutboundQueue();
         closeHandshakeContext();
-        propagateDeviceDisconnectedEvent();
+
+        if (forced && getConnectionAdapter().isAlive()) {
+            getConnectionAdapter().disconnect();
+        }
+
+        if (propagate) {
+            propagateDeviceDisconnectedEvent();
+        }
     }
 
     private void propagateDeviceDisconnectedEvent() {
-        if (null != deviceDisconnectedHandler) {
+        if (deviceDisconnectedHandler != null) {
             final BigInteger datapathId = featuresReply != null ? featuresReply.getDatapathId() : BigInteger.ZERO;
-            LOG.debug("Propagating connection closed event: {}, datapathId:{}.",
-                    connectionAdapter.getRemoteAddress(), datapathId);
+            if (LOG.isDebugEnabled()) {
+                LOG.debug("Propagating connection closed event: {}, datapathId:{}.",
+                        connectionAdapter.getRemoteAddress(), datapathId);
+            }
             deviceDisconnectedHandler.onDeviceDisconnected(this);
         }
     }
 
     /**
-     * This method returns safe nodeId for logging
+     * Get safe nodeId for logging.
+     *
      * @return string value od nodeId or string "null"
      */
     @Override
     public String getSafeNodeIdForLOG() {
-        return null == nodeId ? "null" : nodeId.getValue();
+        return nodeId == null ? "null" : nodeId.getValue();
     }
 
     @Override
-    public void setOutboundQueueHandleRegistration(OutboundQueueHandlerRegistration<OutboundQueueProvider> outboundQueueHandlerRegistration) {
-        this.outboundQueueHandlerRegistration = outboundQueueHandlerRegistration;
+    public void setOutboundQueueHandleRegistration(
+            OutboundQueueHandlerRegistration<OutboundQueueProvider> newRegistration) {
+        this.outboundQueueHandlerRegistration = newRegistration;
     }
 
     private void unregisterOutboundQueue() {
-        LOG.debug("Trying unregister outbound queue handler registration for node {}", nodeId);
+        if (LOG.isDebugEnabled()) {
+            LOG.debug("Trying unregister outbound queue handler registration for node {}", getSafeNodeIdForLOG());
+        }
         if (outboundQueueHandlerRegistration != null) {
             outboundQueueHandlerRegistration.close();
             outboundQueueHandlerRegistration = null;
@@ -235,6 +213,24 @@ public class ConnectionContextImpl implements ConnectionContext {
         connectionState = CONNECTION_STATE.WORKING;
     }
 
+    @Override
+    public void handlePortStatusMessage(final PortStatusMessage portStatusMessage) {
+        LOG.info("Received early port status message for node {} with reason {} and state {}",
+                getSafeNodeIdForLOG(),
+                portStatusMessage.getReason(),
+                MoreObjects.firstNonNull(portStatusMessage.getState(), portStatusMessage.getStateV10()));
+
+        LOG.debug("Early port status message body is {}", portStatusMessage);
+        portStatusMessages.add(portStatusMessage);
+    }
+
+    @Override
+    public List<PortStatusMessage> retrieveAndClearPortStatusMessages() {
+        final List<PortStatusMessage> immutablePortStatusMessages = Collections.unmodifiableList(portStatusMessages);
+        portStatusMessages.clear();
+        return immutablePortStatusMessages;
+    }
+
     @Override
     public DeviceInfo getDeviceInfo() {
         return this.deviceInfo;
@@ -258,16 +254,16 @@ public class ConnectionContextImpl implements ConnectionContext {
     }
 
     @Override
-    public boolean equals(Object o) {
-        if (this == o) {
+    public boolean equals(Object object) {
+        if (this == object) {
             return true;
         }
 
-        if (o == null || getClass() != o.getClass()) {
+        if (object == null || getClass() != object.getClass()) {
             return false;
         }
 
-        ConnectionContextImpl that = (ConnectionContextImpl) o;
+        ConnectionContextImpl that = (ConnectionContextImpl) object;
 
         if (!connectionAdapter.equals(that.connectionAdapter)) {
             return false;
@@ -289,7 +285,7 @@ public class ConnectionContextImpl implements ConnectionContext {
         return result;
     }
 
-    private class DeviceInfoImpl implements DeviceInfo {
+    private static class DeviceInfoImpl implements DeviceInfo {
 
         private final NodeId nodeId;
         private final KeyedInstanceIdentifier<Node, NodeKey> nodeII;
@@ -323,7 +319,7 @@ public class ConnectionContextImpl implements ConnectionContext {
         }
 
         @Override
-        public Short getVersion() {
+        public short getVersion() {
             return version;
         }
 
@@ -338,21 +334,21 @@ public class ConnectionContextImpl implements ConnectionContext {
         }
 
         @Override
-        public boolean equals(Object o) {
-            if (this == o) {
+        public boolean equals(Object object) {
+            if (this == object) {
                 return true;
             }
 
-            if (o == null || getClass() != o.getClass()) {
+            if (object == null || getClass() != object.getClass()) {
                 return false;
             }
 
-            DeviceInfoImpl that = (DeviceInfoImpl) o;
+            DeviceInfoImpl that = (DeviceInfoImpl) object;
 
-            return  (nodeId.equals(that.nodeId) &&
-                    nodeII.equals(that.nodeII) &&
-                    version.equals(that.version) &&
-                    datapathId.equals(that.datapathId));
+            return  nodeId.equals(that.nodeId)
+                    && nodeII.equals(that.nodeII)
+                    && version.equals(that.version)
+                    && datapathId.equals(that.datapathId);
 
         }
 
@@ -365,6 +361,11 @@ public class ConnectionContextImpl implements ConnectionContext {
             return result;
         }
 
+        @Override
+        public String toString() {
+            return nodeId == null ? "null" : getNodeId().getValue();
+        }
+
         public void setOutboundQueueProvider(final OutboundQueue outboundQueueProvider) {
             this.outboundQueueProvider = outboundQueueProvider;
         }