Do not use OpenflowProtocolListener in ConnectionAdapter
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / connection / listener / OpenflowProtocolListenerInitialImpl.java
index 05b636b70454fde4bafc181b5f98a027697d7d73..bd5cb34fce8c298d5a14b5c93a35d5b397e4f256 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
@@ -7,73 +7,82 @@
  */
 package org.opendaylight.openflowplugin.impl.connection.listener;
 
-import com.google.common.base.Objects;
+import com.google.common.util.concurrent.FutureCallback;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.MoreExecutors;
+import java.util.Objects;
+import org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter.MessageListener;
 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
 import org.opendaylight.openflowplugin.api.openflow.connection.HandshakeContext;
 import org.opendaylight.openflowplugin.impl.connection.HandshakeStepWrapper;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoReplyInputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoReplyOutput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoRequestMessage;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessage;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessage;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OpenflowProtocolListener;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
+import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/**
- *
- */
-public class OpenflowProtocolListenerInitialImpl implements OpenflowProtocolListener {
-
+public class OpenflowProtocolListenerInitialImpl implements MessageListener {
     private static final Logger LOG = LoggerFactory.getLogger(OpenflowProtocolListenerInitialImpl.class);
 
     private final ConnectionContext connectionContext;
     private final HandshakeContext handshakeContext;
 
     /**
-     * @param connectionContext
-     * @param handshakeContext
+     * Constructor.
+     *
+     * @param connectionContext - connection context
+     * @param handshakeContext - handshake context
      */
     public OpenflowProtocolListenerInitialImpl(final ConnectionContext connectionContext,
-                                               final HandshakeContext handshakeContext) {
+            final HandshakeContext handshakeContext) {
         this.connectionContext = connectionContext;
         this.handshakeContext = handshakeContext;
     }
 
     @Override
-    public void onEchoRequestMessage(final EchoRequestMessage echoRequestMessage) {
-        if (LOG.isDebugEnabled()) {
-            LOG.debug("echo request received: {}", echoRequestMessage.getXid());
-        }
-        EchoReplyInputBuilder builder = new EchoReplyInputBuilder();
-        builder.setVersion(echoRequestMessage.getVersion());
-        builder.setXid(echoRequestMessage.getXid());
-        builder.setData(echoRequestMessage.getData());
+    public void onEchoRequest(final EchoRequestMessage echoRequestMessage) {
+        final var xid = echoRequestMessage.getXid();
+        LOG.debug("echo request received: {}", xid);
+        Futures.addCallback(connectionContext.getConnectionAdapter().echoReply(
+            new EchoReplyInputBuilder().setXid(xid).setData(echoRequestMessage.getData()).build()),
+            new FutureCallback<>() {
+                @Override
+                public void onSuccess(final RpcResult<EchoReplyOutput> result) {
+                    LOG.debug("echo reply sent: {}", xid);
+                }
 
-        connectionContext.getConnectionAdapter().echoReply(builder.build());
+                @Override
+                public void onFailure(final Throwable cause) {
+                    LOG.debug("echo reply failed: {}", xid, cause);
+                }
+            }, MoreExecutors.directExecutor());
     }
 
     @Override
-    public void onErrorMessage(final ErrorMessage notification) {
+    public void onError(final ErrorMessage notification) {
         LOG.debug("NOOP: Error message received during handshake phase: {}", notification);
     }
 
     @Override
-    public void onExperimenterMessage(final ExperimenterMessage notification) {
+    public void onExperimenter(final ExperimenterMessage notification) {
         LOG.debug("NOOP: Experimenter message during handshake phase not supported: {}", notification);
     }
 
     @Override
-    public void onFlowRemovedMessage(final FlowRemovedMessage notification) {
+    public void onFlowRemoved(final FlowRemovedMessage notification) {
         LOG.debug("NOOP: Flow-removed message during handshake phase not supported: {}", notification);
     }
 
     @Override
-    public void onHelloMessage(final HelloMessage hello) {
+    public void onHello(final HelloMessage hello) {
         LOG.debug("processing HELLO.xid: {} from device {}", hello.getXid(),
                 connectionContext.getConnectionAdapter().getRemoteAddress());
         final ConnectionContext.CONNECTION_STATE connectionState = connectionContext.getConnectionState();
@@ -86,8 +95,8 @@ public class OpenflowProtocolListenerInitialImpl implements OpenflowProtocolList
                 }
 
                 if (checkState(ConnectionContext.CONNECTION_STATE.HANDSHAKING)) {
-                    final HandshakeStepWrapper handshakeStepWrapper = new HandshakeStepWrapper(
-                            hello, handshakeContext.getHandshakeManager(), connectionContext.getConnectionAdapter());
+                    final var handshakeStepWrapper = new HandshakeStepWrapper(hello,
+                        handshakeContext.getHandshakeManager(), connectionContext.getConnectionAdapter());
                     // use up netty thread
                     handshakeStepWrapper.run();
                 } else {
@@ -104,26 +113,28 @@ public class OpenflowProtocolListenerInitialImpl implements OpenflowProtocolList
     }
 
     @Override
-    public void onMultipartReplyMessage(final MultipartReplyMessage notification) {
+    public void onMultipartReply(final MultipartReplyMessage notification) {
         LOG.debug("NOOP: Multipart-reply message during handshake phase not supported: {}", notification);
     }
 
     @Override
-    public void onPacketInMessage(final PacketInMessage notification) {
+    public void onPacketIn(final PacketInMessage notification) {
         LOG.debug("NOOP: Packet-in message during handshake phase not supported: {}", notification);
     }
 
     @Override
-    public void onPortStatusMessage(final PortStatusMessage notification) {
+    public void onPortStatus(final PortStatusMessage notification) {
         connectionContext.handlePortStatusMessage(notification);
     }
 
     /**
-     * @param expectedState
+     * Check state of the connection context.
+     *
+     * @param expectedState - the expected state
      */
     protected boolean checkState(final ConnectionContext.CONNECTION_STATE expectedState) {
         boolean verdict = true;
-        if (! Objects.equal(connectionContext.getConnectionState(), expectedState)) {
+        if (!Objects.equals(connectionContext.getConnectionState(), expectedState)) {
             verdict = false;
             LOG.info("Expected state: {}, actual state: {}", expectedState,
                     connectionContext.getConnectionState());