Merge "Merge empty parent Nodes by DeviceManager initialization"
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / device / DeviceManagerImpl.java
index 45bf8d7f3d67b955c686b97c94a07cde9cadfd91..6d935f4e27318c8d0bca03412b5a39596f0248a3 100644 (file)
@@ -14,7 +14,16 @@ import com.google.common.util.concurrent.JdkFutureAdapters;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.SettableFuture;
 import io.netty.util.HashedWheelTimer;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Iterator;
+import java.util.List;
+import java.util.concurrent.TimeUnit;
+import javax.annotation.CheckForNull;
+import javax.annotation.Nonnull;
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
+import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
@@ -24,19 +33,22 @@ import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
 import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
 import org.opendaylight.openflowplugin.api.openflow.device.Xid;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceContextReadyHandler;
+import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
-import org.opendaylight.openflowplugin.api.openflow.rpc.RpcManager;
 import org.opendaylight.openflowplugin.impl.common.MultipartRequestInputFactory;
 import org.opendaylight.openflowplugin.impl.common.NodeStaticReplyTranslatorUtil;
 import org.opendaylight.openflowplugin.impl.device.listener.OpenflowProtocolListenerFullImpl;
 import org.opendaylight.openflowplugin.impl.rpc.RequestContextImpl;
+import org.opendaylight.openflowplugin.impl.services.OFJResult2RequestCtxFuture;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.NodeGroupFeatures;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodesBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.NodeMeterFeatures;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
@@ -55,15 +67,6 @@ import org.opendaylight.yangtools.yang.common.RpcError;
 import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import javax.annotation.CheckForNull;
-import javax.annotation.Nonnull;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.Iterator;
-import java.util.List;
-import java.util.concurrent.Future;
-import java.util.concurrent.TimeUnit;
 
 /**
  *
@@ -74,26 +77,29 @@ public class DeviceManagerImpl implements DeviceManager {
 
     private static final long TICK_DURATION = 500; // 0.5 sec.
 
-    private final RpcManager rpcManager;
     private final DataBroker dataBroker;
     private final HashedWheelTimer hashedWheelTimer;
     private RequestContextStack dummyRequestContextStack;
     private TranslatorLibrary translatorLibrary;
+    private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
 
 
-    public DeviceManagerImpl(@Nonnull final RpcManager rpcManager, @Nonnull final DataBroker dataBroker) {
-        this.rpcManager = Preconditions.checkNotNull(rpcManager);
+    public DeviceManagerImpl(@Nonnull final DataBroker dataBroker) {
         this.dataBroker = Preconditions.checkNotNull(dataBroker);
         hashedWheelTimer = new HashedWheelTimer(TICK_DURATION, TimeUnit.MILLISECONDS, 10);
+        /* merge empty nodes to oper DS to predict any problems with missing parent for Node */
+        final WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
+        tx.merge(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(Nodes.class), new NodesBuilder().build());
+        tx.submit();
 
         dummyRequestContextStack = new RequestContextStack() {
             @Override
-            public <T> void forgetRequestContext(RequestContext<T> requestContext) {
+            public <T> void forgetRequestContext(final RequestContext<T> requestContext) {
                 //NOOP
             }
 
             @Override
-            public <T> SettableFuture<RpcResult<T>> storeOrFail(RequestContext<T> data) {
+            public <T> SettableFuture<RpcResult<T>> storeOrFail(final RequestContext<T> data) {
                 return data.getFuture();
             }
 
@@ -104,40 +110,55 @@ public class DeviceManagerImpl implements DeviceManager {
         };
     }
 
+    @Override
+    public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
+        deviceInitPhaseHandler = handler;
+    }
+
+    @Override
+    public void onDeviceContextLevelUp(final DeviceContext deviceContext) {
+        // final phase - we have to add new Device to MD-SAL DataStore
+        Preconditions.checkNotNull(deviceContext != null);
+        ((DeviceContextImpl) deviceContext).submitTransaction();
+    }
+
     @Override
     public void deviceConnected(@CheckForNull final ConnectionContext connectionContext) {
         Preconditions.checkArgument(connectionContext != null);
+
         final DeviceState deviceState = new DeviceStateImpl(connectionContext.getFeatures(), connectionContext.getNodeId());
+
         final DeviceContextImpl deviceContext = new DeviceContextImpl(connectionContext, deviceState, dataBroker, hashedWheelTimer);
+
+        deviceContext.writeToTransaction(LogicalDatastoreType.OPERATIONAL, deviceState.getNodeInstanceIdentifier(), new NodeBuilder().setId(deviceState.getNodeId()).build());
+
         deviceContext.setTranslatorLibrary(translatorLibrary);
+
         final OpenflowProtocolListenerFullImpl messageListener = new OpenflowProtocolListenerFullImpl(
                 connectionContext.getConnectionAdapter(), deviceContext);
-        connectionContext.getConnectionAdapter().setMessageListener(messageListener);
 
-        final Xid nodeDescXid = deviceContext.getNextXid();
-        final ListenableFuture<Collection<MultipartReply>> replyDesc = getNodeStaticInfo(nodeDescXid, messageListener,
+        deviceContext.attachOpenflowMessageListener(messageListener);
+
+        final ListenableFuture<RpcResult<List<MultipartReply>>> replyDesc = getNodeStaticInfo(messageListener,
                 MultipartType.OFPMPDESC, deviceContext, deviceState.getNodeInstanceIdentifier(), deviceState.getVersion());
 
-        final Xid nodeMeterXid = deviceContext.getNextXid();
-        final ListenableFuture<Collection<MultipartReply>> replyMeterFeature = getNodeStaticInfo(nodeMeterXid, messageListener,
+        final ListenableFuture<RpcResult<List<MultipartReply>>> replyMeterFeature = getNodeStaticInfo(messageListener,
                 MultipartType.OFPMPMETERFEATURES, deviceContext, deviceState.getNodeInstanceIdentifier(), deviceState.getVersion());
 
-        final Xid nodeGroupXid = deviceContext.getNextXid();
-        final ListenableFuture<Collection<MultipartReply>> replyGroupFeatures = getNodeStaticInfo(nodeGroupXid, messageListener,
+        final ListenableFuture<RpcResult<List<MultipartReply>>> replyGroupFeatures = getNodeStaticInfo(messageListener,
                 MultipartType.OFPMPGROUPFEATURES, deviceContext, deviceState.getNodeInstanceIdentifier(), deviceState.getVersion());
 
-        final Xid nodeTableXid = deviceContext.getNextXid();
-        final ListenableFuture<Collection<MultipartReply>> replyTableFeatures = getNodeStaticInfo(nodeTableXid, messageListener,
+        final ListenableFuture<RpcResult<List<MultipartReply>>> replyTableFeatures = getNodeStaticInfo(messageListener,
                 MultipartType.OFPMPTABLEFEATURES, deviceContext, deviceState.getNodeInstanceIdentifier(), deviceState.getVersion());
 
-        final ListenableFuture<List<Collection<MultipartReply>>> deviceFeaturesFuture =
+        final ListenableFuture<List<RpcResult<List<MultipartReply>>>> deviceFeaturesFuture =
                 Futures.allAsList(Arrays.asList(replyDesc, replyMeterFeature, replyGroupFeatures, replyTableFeatures));
-        Futures.addCallback(deviceFeaturesFuture, new FutureCallback<List<Collection<MultipartReply>>>() {
+
+        Futures.addCallback(deviceFeaturesFuture, new FutureCallback<List<RpcResult<List<MultipartReply>>>>() {
             @Override
-            public void onSuccess(final List<Collection<MultipartReply>> result) {
-                // FIXME : add statistics
-                rpcManager.deviceConnected(deviceContext);
-                deviceContext.submitTransaction();
+            public void onSuccess(final List<RpcResult<List<MultipartReply>>> result) {
+                // wake up statistics
+                deviceInitPhaseHandler.onDeviceContextLevelUp(deviceContext);
             }
 
             @Override
@@ -147,11 +168,6 @@ public class DeviceManagerImpl implements DeviceManager {
         });
     }
 
-    @Override
-    public void addRequestContextReadyHandler(final DeviceContextReadyHandler deviceContextReadyHandler) {
-        // TODO Auto-generated method stub
-    }
-
     @Override
     public TranslatorLibrary oook() {
         return translatorLibrary;
@@ -162,28 +178,30 @@ public class DeviceManagerImpl implements DeviceManager {
         this.translatorLibrary = translatorLibrary;
     }
 
-    private ListenableFuture<Collection<MultipartReply>> getNodeStaticInfo(final Xid xid,
-                                                                           final MultiMsgCollector multiMsgCollector, final MultipartType type, final DeviceContext dContext,
-                                                                           final InstanceIdentifier<Node> nodeII, final short version) {
-        final ListenableFuture<Collection<MultipartReply>> future = multiMsgCollector.registerMultipartMsg(xid.getValue());
+    private ListenableFuture<RpcResult<List<MultipartReply>>> getNodeStaticInfo(final MultiMsgCollector multiMsgCollector, final MultipartType type, final DeviceContext deviceContext,
+                                                                                final InstanceIdentifier<Node> nodeII, final short version) {
 
-        RequestContext<List<MultipartReply>> requestContext = dummyRequestContextStack.createRequestContext();
-        dContext.hookRequestCtx(xid, requestContext);
+        final Xid xid = deviceContext.getNextXid();
+        final RequestContext<List<MultipartReply>> requestContext = dummyRequestContextStack.createRequestContext();
+        requestContext.setXid(xid);
+        multiMsgCollector.registerMultipartXid(xid.getValue());
         Futures.addCallback(requestContext.getFuture(), new FutureCallback<RpcResult<List<MultipartReply>>>() {
             @Override
             public void onSuccess(final RpcResult<List<MultipartReply>> rpcResult) {
-                List<MultipartReply> result = rpcResult.getResult();
+                final List<MultipartReply> result = rpcResult.getResult();
                 if (result != null) {
-                    translateAndWriteReply(type, dContext, nodeII, result);
+                    translateAndWriteReply(type, deviceContext, nodeII, result);
                 } else {
-                    Iterator<RpcError> rpcErrorIterator = rpcResult.getErrors().iterator();
+                    final Iterator<RpcError> rpcErrorIterator = rpcResult.getErrors().iterator();
                     while (rpcErrorIterator.hasNext()) {
-                        Throwable t = rpcErrorIterator.next().getCause();
-                        LOG.info("Failed to retrieve static node {} info: {}", type, t.getMessage());
-                        LOG.trace("Detailed error:", t);
+                        final RpcError rpcError = rpcErrorIterator.next();
+                        LOG.info("Failed to retrieve static node {} info: {}", type, rpcError.getMessage());
+                        if (null != rpcError.getCause()) {
+                            LOG.trace("Detailed error:", rpcError.getCause());
+                        }
                     }
                     if (MultipartType.OFPMPTABLE.equals(type)) {
-                        makeEmptyTables(dContext, nodeII, dContext.getPrimaryConnectionContext().getFeatures().getTables());
+                        makeEmptyTables(deviceContext, nodeII, deviceContext.getPrimaryConnectionContext().getFeatures().getTables());
                     }
                 }
             }
@@ -194,20 +212,12 @@ public class DeviceManagerImpl implements DeviceManager {
             }
         });
 
-        final Future<RpcResult<Void>> rpcFuture = dContext.getPrimaryConnectionContext().getConnectionAdapter()
-                .multipartRequest(MultipartRequestInputFactory.makeMultipartRequestInput(xid.getValue(), version, type));
-        Futures.addCallback(JdkFutureAdapters.listenInPoolThread(rpcFuture), new FutureCallback<RpcResult<Void>>() {
-            @Override
-            public void onSuccess(final RpcResult<Void> result) {
-                // NOOP
-            }
+        final ListenableFuture<RpcResult<Void>> rpcFuture = JdkFutureAdapters.listenInPoolThread(deviceContext.getPrimaryConnectionContext().getConnectionAdapter()
+                .multipartRequest(MultipartRequestInputFactory.makeMultipartRequestInput(xid.getValue(), version, type)));
+        final OFJResult2RequestCtxFuture OFJResult2RequestCtxFuture = new OFJResult2RequestCtxFuture(requestContext, deviceContext);
+        OFJResult2RequestCtxFuture.processResultFromOfJava(rpcFuture);
 
-            @Override
-            public void onFailure(final Throwable t) {
-                future.cancel(true);
-            }
-        });
-        return future;
+        return requestContext.getFuture();
     }
 
     // FIXME : remove after ovs tableFeatures fix