Remove Objects.{is,non}Null abuse
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / connection / ConnectionContextImpl.java
index ce6a51e75818c7861c3542d81c02aa3bf4f868e4..03ad021192ff74989b150d849c67e6ab705423f8 100644 (file)
@@ -1,35 +1,43 @@
-/**
+/*
  * 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.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;
 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandlerRegistration;
 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
 import org.opendaylight.openflowplugin.api.openflow.connection.HandshakeContext;
 import org.opendaylight.openflowplugin.api.openflow.connection.OutboundQueueProvider;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceDisconnectedHandler;
 import org.opendaylight.openflowplugin.impl.statistics.ofpspecific.SessionStatistics;
+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.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;
-    private CONNECTION_STATE connectionState;
+    private volatile CONNECTION_STATE connectionState;
     private FeaturesReply featuresReply;
     private NodeId nodeId;
     private DeviceDisconnectedHandler deviceDisconnectedHandler;
@@ -37,9 +45,13 @@ public class ConnectionContextImpl implements ConnectionContext {
     private OutboundQueueProvider outboundQueueProvider;
     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;
@@ -58,6 +70,7 @@ public class ConnectionContextImpl implements ConnectionContext {
     @Override
     public void setOutboundQueueProvider(final OutboundQueueProvider outboundQueueProvider) {
         this.outboundQueueProvider = outboundQueueProvider;
+        ((DeviceInfoImpl)this.deviceInfo).setOutboundQueueProvider(this.outboundQueueProvider);
     }
 
     @Override
@@ -86,88 +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(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;
-
-        unregisterOutboundQueue();
-        closeHandshakeContext();
-
-        if (getConnectionAdapter().isAlive()) {
-            getConnectionAdapter().disconnect();
-        }
-
-        if (propagate) {
-            propagateDeviceDisconnectedEvent();
-        }
+    public void closeConnection(final boolean propagate) {
+        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.info("handshake context closing failed: ", e);
-            } finally {
-                handshakeContext = null;
-            }
+            handshakeContext.close();
+            handshakeContext = null;
         }
     }
 
     @Override
     public void onConnectionClosed() {
-        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);
+        disconnectDevice(true, false);
+    }
+
+    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;
         }
+
         connectionState = ConnectionContext.CONNECTION_STATE.RIP;
 
-        final InetSocketAddress remoteAddress = connectionAdapter.getRemoteAddress();
-        final Short auxiliaryId;
-        if (null != getFeatures() && null != getFeatures().getAuxiliaryId()) {
-            auxiliaryId = getFeatures().getAuxiliaryId();
-        } else {
-            auxiliaryId = 0;
-        }
+        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);
         }
     }
 
+    /**
+     * Get safe nodeId for logging.
+     *
+     * @return string value od nodeId or string "null"
+     */
+    @Override
+    public String getSafeNodeIdForLOG() {
+        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() {
+        if (LOG.isDebugEnabled()) {
+            LOG.debug("Trying unregister outbound queue handler registration for node {}", getSafeNodeIdForLOG());
+        }
         if (outboundQueueHandlerRegistration != null) {
             outboundQueueHandlerRegistration.close();
             outboundQueueHandlerRegistration = null;
@@ -175,22 +199,180 @@ public class ConnectionContextImpl implements ConnectionContext {
     }
 
     @Override
-    public void changeStateToHandshaking() {
+    public synchronized void changeStateToHandshaking() {
         connectionState = CONNECTION_STATE.HANDSHAKING;
     }
 
     @Override
-    public void changeStateToTimeouting() {
+    public synchronized void changeStateToTimeouting() {
         connectionState = CONNECTION_STATE.TIMEOUTING;
     }
 
     @Override
-    public void changeStateToWorking() {
+    public synchronized void changeStateToWorking() {
         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;
+    }
+
+    @Override
+    public void handshakeSuccessful() {
+        Preconditions.checkNotNull(nodeId, "Cannot create DeviceInfo if 'NodeId' is not set!");
+        Preconditions.checkNotNull(featuresReply, "Cannot create DeviceInfo if 'features' is not set!");
+        this.deviceInfo = new DeviceInfoImpl(
+                nodeId,
+                DeviceStateUtil.createNodeInstanceIdentifier(nodeId),
+                featuresReply.getVersion(),
+                featuresReply.getDatapathId(),
+                outboundQueueProvider);
+    }
+
     @Override
     public void setHandshakeContext(HandshakeContext handshakeContext) {
         this.handshakeContext = handshakeContext;
     }
+
+    @Override
+    public boolean equals(Object object) {
+        if (this == object) {
+            return true;
+        }
+
+        if (object == null || getClass() != object.getClass()) {
+            return false;
+        }
+
+        ConnectionContextImpl that = (ConnectionContextImpl) object;
+
+        if (!connectionAdapter.equals(that.connectionAdapter)) {
+            return false;
+        }
+
+        if (featuresReply != null ? !featuresReply.equals(that.featuresReply) : that.featuresReply != null) {
+            return false;
+        }
+
+        return nodeId != null ? nodeId.equals(that.nodeId) : that.nodeId == null;
+
+    }
+
+    @Override
+    public int hashCode() {
+        int result = connectionAdapter.hashCode();
+        result = 31 * result + (featuresReply != null ? featuresReply.hashCode() : 0);
+        result = 31 * result + (nodeId != null ? nodeId.hashCode() : 0);
+        return result;
+    }
+
+    private static class DeviceInfoImpl implements DeviceInfo {
+
+        private final NodeId nodeId;
+        private final KeyedInstanceIdentifier<Node, NodeKey> nodeII;
+        private final Short version;
+        private final BigInteger datapathId;
+        private final ServiceGroupIdentifier serviceGroupIdentifier;
+        private OutboundQueue outboundQueueProvider;
+
+        DeviceInfoImpl(
+                final NodeId nodeId,
+                final KeyedInstanceIdentifier<Node, NodeKey> nodeII,
+                final Short version,
+                final BigInteger datapathId,
+                final OutboundQueue outboundQueueProvider) {
+            this.nodeId = nodeId;
+            this.nodeII = nodeII;
+            this.version = version;
+            this.datapathId = datapathId;
+            this.outboundQueueProvider = outboundQueueProvider;
+            this.serviceGroupIdentifier = ServiceGroupIdentifier.create(this.nodeId.getValue());
+        }
+
+        @Override
+        public NodeId getNodeId() {
+            return nodeId;
+        }
+
+        @Override
+        public KeyedInstanceIdentifier<Node, NodeKey> getNodeInstanceIdentifier() {
+            return nodeII;
+        }
+
+        @Override
+        public short getVersion() {
+            return version;
+        }
+
+        @Override
+        public BigInteger getDatapathId() {
+            return datapathId;
+        }
+
+        @Override
+        public ServiceGroupIdentifier getServiceIdentifier() {
+            return this.serviceGroupIdentifier;
+        }
+
+        @Override
+        public boolean equals(Object object) {
+            if (this == object) {
+                return true;
+            }
+
+            if (object == null || getClass() != object.getClass()) {
+                return false;
+            }
+
+            DeviceInfoImpl that = (DeviceInfoImpl) object;
+
+            return  nodeId.equals(that.nodeId)
+                    && nodeII.equals(that.nodeII)
+                    && version.equals(that.version)
+                    && datapathId.equals(that.datapathId);
+
+        }
+
+        @Override
+        public int hashCode() {
+            int result = nodeId.hashCode();
+            result = 31 * result + nodeII.hashCode();
+            result = 31 * result + version.hashCode();
+            result = 31 * result + datapathId.hashCode();
+            return result;
+        }
+
+        @Override
+        public String toString() {
+            return nodeId == null ? "null" : getNodeId().getValue();
+        }
+
+        public void setOutboundQueueProvider(final OutboundQueue outboundQueueProvider) {
+            this.outboundQueueProvider = outboundQueueProvider;
+        }
+
+        @Override
+        public Long reserveXidForDeviceMessage() {
+            return outboundQueueProvider.reserveEntry();
+        }
+    }
 }