Disconnection improvements.
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / statistics / StatisticsContextImpl.java
index 92d03ecf187d8d63e953e9611bac69da2c114e81..d95527476942ea2106d7cd13a22604a4f60a398a 100644 (file)
@@ -9,6 +9,7 @@
 package org.opendaylight.openflowplugin.impl.statistics;
 
 import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Function;
 import com.google.common.base.Preconditions;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.Iterators;
@@ -29,27 +30,30 @@ import javax.annotation.Nullable;
 import javax.annotation.concurrent.GuardedBy;
 import org.opendaylight.mdsal.common.api.TransactionChainClosedException;
 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
+import org.opendaylight.openflowplugin.api.ConnectionException;
 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
 import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
 import org.opendaylight.openflowplugin.api.openflow.device.handlers.ClusterInitializationPhaseHandler;
-import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.MastershipChangeListener;
 import org.opendaylight.openflowplugin.api.openflow.rpc.listener.ItemLifecycleListener;
 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsContext;
 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsManager;
 import org.opendaylight.openflowplugin.impl.rpc.AbstractRequestContext;
 import org.opendaylight.openflowplugin.impl.rpc.listener.ItemLifecycleListenerImpl;
-import org.opendaylight.openflowplugin.impl.services.RequestContextUtil;
+import org.opendaylight.openflowplugin.impl.services.util.RequestContextUtil;
+import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProvider;
 import org.opendaylight.openflowplugin.impl.statistics.services.dedicated.StatisticsGatheringOnTheFlyService;
 import org.opendaylight.openflowplugin.impl.statistics.services.dedicated.StatisticsGatheringService;
 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-class StatisticsContextImpl implements StatisticsContext {
+class StatisticsContextImpl<T extends OfHeader> implements StatisticsContext {
 
     private static final Logger LOG = LoggerFactory.getLogger(StatisticsContextImpl.class);
     private static final String CONNECTION_CLOSED = "Connection closed.";
@@ -59,18 +63,18 @@ class StatisticsContextImpl implements StatisticsContext {
     private final DeviceContext deviceContext;
     private final DeviceState devState;
     private final ListenableFuture<Boolean> emptyFuture;
-    private final boolean shuttingDownStatisticsPolling;
-    private final SinglePurposeMultipartReplyTranslator multipartReplyTranslator;
+    private final boolean isStatisticsPollingOn;
     private final Object collectionStatTypeLock = new Object();
+    private final ConvertorExecutor convertorExecutor;
+    private final MultipartWriterProvider statisticsWriterProvider;
     @GuardedBy("collectionStatTypeLock")
     private List<MultipartType> collectingStatType;
 
-    private StatisticsGatheringService statisticsGatheringService;
-    private StatisticsGatheringOnTheFlyService statisticsGatheringOnTheFlyService;
+    private StatisticsGatheringService<T> statisticsGatheringService;
+    private StatisticsGatheringOnTheFlyService<T> statisticsGatheringOnTheFlyService;
     private Timeout pollTimeout;
     private final DeviceInfo deviceInfo;
     private final StatisticsManager myManager;
-    private final LifecycleService lifecycleService;
 
     private volatile boolean schedulingEnabled;
     private volatile CONTEXT_STATE state;
@@ -79,25 +83,26 @@ class StatisticsContextImpl implements StatisticsContext {
 
     private ListenableFuture<Boolean> lastDataGathering;
 
-    StatisticsContextImpl(@Nonnull final DeviceInfo deviceInfo,
-                          final boolean shuttingDownStatisticsPolling,
-                          @Nonnull final LifecycleService lifecycleService,
+    StatisticsContextImpl(final boolean isStatisticsPollingOn,
+                          @Nonnull final DeviceContext deviceContext,
                           @Nonnull final ConvertorExecutor convertorExecutor,
-                          @Nonnull final StatisticsManager myManager) {
-        this.lifecycleService = lifecycleService;
-        this.deviceContext = lifecycleService.getDeviceContext();
+                          @Nonnull final StatisticsManager myManager,
+                          @Nonnull final MultipartWriterProvider statisticsWriterProvider) {
+        this.deviceContext = deviceContext;
         this.devState = Preconditions.checkNotNull(deviceContext.getDeviceState());
-        this.shuttingDownStatisticsPolling = shuttingDownStatisticsPolling;
-        multipartReplyTranslator = new SinglePurposeMultipartReplyTranslator(convertorExecutor);
+        this.isStatisticsPollingOn = isStatisticsPollingOn;
+        this.convertorExecutor = convertorExecutor;
         emptyFuture = Futures.immediateFuture(false);
-        statisticsGatheringService = new StatisticsGatheringService(this, deviceContext);
-        statisticsGatheringOnTheFlyService = new StatisticsGatheringOnTheFlyService(this, deviceContext, convertorExecutor);
+        statisticsGatheringService = new StatisticsGatheringService<>(this, deviceContext);
+        statisticsGatheringOnTheFlyService = new StatisticsGatheringOnTheFlyService<>(this,
+            deviceContext, convertorExecutor, statisticsWriterProvider);
         itemLifeCycleListener = new ItemLifecycleListenerImpl(deviceContext);
         statListForCollectingInitialization();
-        setState(CONTEXT_STATE.INITIALIZATION);
-        this.deviceInfo = deviceInfo;
+        this.state = CONTEXT_STATE.INITIALIZATION;
+        this.deviceInfo = deviceContext.getDeviceInfo();
         this.myManager = myManager;
         this.lastDataGathering = null;
+        this.statisticsWriterProvider = statisticsWriterProvider;
     }
 
     @Override
@@ -141,7 +146,7 @@ class StatisticsContextImpl implements StatisticsContext {
 
     private ListenableFuture<Boolean> gatherDynamicData(final boolean initial) {
         this.lastDataGathering = null;
-        if (shuttingDownStatisticsPolling) {
+        if (!isStatisticsPollingOn) {
             LOG.debug("Statistics for device {} is not enabled.", getDeviceInfo().getNodeId().getValue());
             return Futures.immediateFuture(Boolean.TRUE);
         }
@@ -228,16 +233,22 @@ class StatisticsContextImpl implements StatisticsContext {
     public void close() {
         if (CONTEXT_STATE.TERMINATION.equals(getState())) {
             if (LOG.isDebugEnabled()) {
-                LOG.debug("Statistics context is already in state TERMINATION.");
+                LOG.debug("StatisticsContext for node {} is already in TERMINATION state.", getDeviceInfo().getLOGValue());
             }
         } else {
-            stopGatheringData();
-            setState(CONTEXT_STATE.TERMINATION);
-            schedulingEnabled = false;
+            try {
+                stopClusterServices(true).get();
+            } catch (Exception e) {
+                LOG.debug("Failed to close StatisticsContext for node {} with exception: ", getDeviceInfo().getLOGValue(), e);
+            }
+
+            this.state = CONTEXT_STATE.TERMINATION;
+
             for (final Iterator<RequestContext<?>> iterator = Iterators.consumingIterator(requestContexts.iterator());
                  iterator.hasNext(); ) {
                 RequestContextUtil.closeRequestContextWithRpcError(iterator.next(), CONNECTION_CLOSED);
             }
+
             if (null != pollTimeout && !pollTimeout.isExpired()) {
                 pollTimeout.cancel();
             }
@@ -267,9 +278,9 @@ class StatisticsContextImpl implements StatisticsContext {
     private void statChainFuture(final Iterator<MultipartType> iterator, final SettableFuture<Boolean> resultFuture, final boolean initial) {
         if (ConnectionContext.CONNECTION_STATE.RIP.equals(deviceContext.getPrimaryConnectionContext().getConnectionState())) {
             final String errMsg = String.format("Device connection is closed for Node : %s.",
-                    getDeviceInfo().getNodeId());
+                getDeviceInfo().getNodeId());
             LOG.debug(errMsg);
-            resultFuture.setException(new IllegalStateException(errMsg));
+            resultFuture.setException(new ConnectionException(errMsg));
             return;
         }
         if ( ! iterator.hasNext()) {
@@ -298,7 +309,7 @@ class StatisticsContextImpl implements StatisticsContext {
      * Method checks a device state. It returns null for be able continue. Otherwise it returns immediateFuture
      * which has to be returned from caller too
      *
-     * @return
+     * @return future
      */
     @VisibleForTesting
     ListenableFuture<Boolean> deviceConnectionCheck() {
@@ -307,7 +318,7 @@ class StatisticsContextImpl implements StatisticsContext {
             switch (deviceContext.getPrimaryConnectionContext().getConnectionState()) {
                 case RIP:
                     final String errMsg = String.format("Device connection doesn't exist anymore. Primary connection status : %s",
-                            deviceContext.getPrimaryConnectionContext().getConnectionState());
+                        deviceContext.getPrimaryConnectionContext().getConnectionState());
                     resultingFuture = Futures.immediateFailedFuture(new Throwable(errMsg));
                     break;
                 default:
@@ -322,92 +333,107 @@ class StatisticsContextImpl implements StatisticsContext {
     //TODO: Refactor twice sending deviceContext into gatheringStatistics
     private ListenableFuture<Boolean> collectFlowStatistics(final MultipartType multipartType, final boolean initial) {
         return devState.isFlowStatisticsAvailable() ? StatisticsGatheringUtils.gatherStatistics(
-                statisticsGatheringOnTheFlyService,
-                getDeviceInfo(),
-                /*MultipartType.OFPMPFLOW*/ multipartType,
-                deviceContext,
-                deviceContext,
-                initial, multipartReplyTranslator) : emptyFuture;
+            statisticsGatheringOnTheFlyService,
+            getDeviceInfo(),
+            /*MultipartType.OFPMPFLOW*/ multipartType,
+            deviceContext,
+            deviceContext,
+            initial,
+            convertorExecutor,
+            statisticsWriterProvider) : emptyFuture;
     }
 
     private ListenableFuture<Boolean> collectTableStatistics(final MultipartType multipartType) {
         return devState.isTableStatisticsAvailable() ? StatisticsGatheringUtils.gatherStatistics(
-                statisticsGatheringService,
-                getDeviceInfo(),
+            statisticsGatheringService,
+            getDeviceInfo(),
                 /*MultipartType.OFPMPTABLE*/ multipartType,
-                deviceContext,
-                deviceContext,
-                false, multipartReplyTranslator) : emptyFuture;
+            deviceContext,
+            deviceContext,
+            false,
+            convertorExecutor,
+            statisticsWriterProvider) : emptyFuture;
     }
 
     private ListenableFuture<Boolean> collectPortStatistics(final MultipartType multipartType) {
         return devState.isPortStatisticsAvailable() ? StatisticsGatheringUtils.gatherStatistics(
-                statisticsGatheringService,
-                getDeviceInfo(),
+            statisticsGatheringService,
+            getDeviceInfo(),
                 /*MultipartType.OFPMPPORTSTATS*/ multipartType,
-                deviceContext,
-                deviceContext,
-                false, multipartReplyTranslator) : emptyFuture;
+            deviceContext,
+            deviceContext,
+            false,
+            convertorExecutor,
+            statisticsWriterProvider) : emptyFuture;
     }
 
     private ListenableFuture<Boolean> collectQueueStatistics(final MultipartType multipartType) {
         return !devState.isQueueStatisticsAvailable() ? emptyFuture : StatisticsGatheringUtils.gatherStatistics(
-                statisticsGatheringService,
-                getDeviceInfo(),
+            statisticsGatheringService,
+            getDeviceInfo(),
                 /*MultipartType.OFPMPQUEUE*/ multipartType,
-                deviceContext,
-                deviceContext,
-                false, multipartReplyTranslator);
+            deviceContext,
+            deviceContext,
+            false,
+            convertorExecutor,
+            statisticsWriterProvider);
     }
 
     private ListenableFuture<Boolean> collectGroupDescStatistics(final MultipartType multipartType) {
         return devState.isGroupAvailable() ? StatisticsGatheringUtils.gatherStatistics(
-                statisticsGatheringService,
-                getDeviceInfo(),
+            statisticsGatheringService,
+            getDeviceInfo(),
                 /*MultipartType.OFPMPGROUPDESC*/ multipartType,
-                deviceContext,
-                deviceContext,
-                false, multipartReplyTranslator) : emptyFuture;
+            deviceContext,
+            deviceContext,
+            false,
+            convertorExecutor,
+            statisticsWriterProvider) : emptyFuture;
     }
 
     private ListenableFuture<Boolean> collectGroupStatistics(final MultipartType multipartType) {
         return devState.isGroupAvailable() ? StatisticsGatheringUtils.gatherStatistics(
-                statisticsGatheringService,
-                getDeviceInfo(),
+            statisticsGatheringService,
+            getDeviceInfo(),
                 /*MultipartType.OFPMPGROUP*/ multipartType,
-                deviceContext,
-                deviceContext,
-                false, multipartReplyTranslator) : emptyFuture;
+            deviceContext,
+            deviceContext,
+            false,
+            convertorExecutor,
+            statisticsWriterProvider) : emptyFuture;
     }
 
     private ListenableFuture<Boolean> collectMeterConfigStatistics(final MultipartType multipartType) {
         return devState.isMetersAvailable() ? StatisticsGatheringUtils.gatherStatistics(
-                statisticsGatheringService,
-                getDeviceInfo(),
+            statisticsGatheringService,
+            getDeviceInfo(),
                 /*MultipartType.OFPMPMETERCONFIG*/ multipartType,
-                deviceContext,
-                deviceContext,
-                false, multipartReplyTranslator) : emptyFuture;
+            deviceContext,
+            deviceContext,
+            false,
+            convertorExecutor,
+            statisticsWriterProvider) : emptyFuture;
     }
 
     private ListenableFuture<Boolean> collectMeterStatistics(final MultipartType multipartType) {
         return devState.isMetersAvailable() ? StatisticsGatheringUtils.gatherStatistics(
-                statisticsGatheringService,
-                getDeviceInfo(),
+            statisticsGatheringService,
+            getDeviceInfo(),
                 /*MultipartType.OFPMPMETER*/ multipartType,
-                deviceContext,
-                deviceContext,
-                false, multipartReplyTranslator) : emptyFuture;
+            deviceContext,
+            deviceContext,
+            false,
+            convertorExecutor,
+            statisticsWriterProvider) : emptyFuture;
     }
 
     @VisibleForTesting
-    void setStatisticsGatheringService(final StatisticsGatheringService statisticsGatheringService) {
+    void setStatisticsGatheringService(final StatisticsGatheringService<T> statisticsGatheringService) {
         this.statisticsGatheringService = statisticsGatheringService;
     }
 
     @VisibleForTesting
-    void setStatisticsGatheringOnTheFlyService(final StatisticsGatheringOnTheFlyService
-                                                             statisticsGatheringOnTheFlyService) {
+    void setStatisticsGatheringOnTheFlyService(final StatisticsGatheringOnTheFlyService<T> statisticsGatheringOnTheFlyService) {
         this.statisticsGatheringOnTheFlyService = statisticsGatheringOnTheFlyService;
     }
 
@@ -421,11 +447,6 @@ class StatisticsContextImpl implements StatisticsContext {
         return this.state;
     }
 
-    @Override
-    public void setState(CONTEXT_STATE state) {
-        this.state = state;
-    }
-
     @Override
     public ServiceGroupIdentifier getServiceIdentifier() {
         return this.deviceInfo.getServiceIdentifier();
@@ -437,10 +458,20 @@ class StatisticsContextImpl implements StatisticsContext {
     }
 
     @Override
-    public ListenableFuture<Void> stopClusterServices(boolean deviceDisconnected) {
-        stopGatheringData();
-        myManager.stopScheduling(deviceInfo);
-        return Futures.immediateFuture(null);
+    public ListenableFuture<Void> stopClusterServices() {
+        if (CONTEXT_STATE.TERMINATION.equals(this.state)) {
+            return Futures.immediateCancelledFuture();
+        }
+
+        return Futures.transform(Futures.immediateFuture(null), new Function<Object, Void>() {
+            @Nullable
+            @Override
+            public Void apply(@Nullable Object input) {
+                schedulingEnabled = false;
+                stopGatheringData();
+                return null;
+            }
+        });
     }
 
     @Override
@@ -450,7 +481,7 @@ class StatisticsContextImpl implements StatisticsContext {
 
     @Override
     public DeviceContext gainDeviceContext() {
-        return this.lifecycleService.getDeviceContext();
+        return this.deviceContext;
     }
 
     @Override
@@ -459,7 +490,8 @@ class StatisticsContextImpl implements StatisticsContext {
             if (LOG.isDebugEnabled()) {
                 LOG.debug("Stop the running statistics gathering for node {}", this.deviceInfo.getLOGValue());
             }
-            this.lastDataGathering.cancel(true);
+
+            lastDataGathering.cancel(true);
         }
     }
 
@@ -469,37 +501,30 @@ class StatisticsContextImpl implements StatisticsContext {
     }
 
     @Override
-    public boolean onContextInstantiateService(final ConnectionContext connectionContext) {
-
-        if (connectionContext.getConnectionState().equals(ConnectionContext.CONNECTION_STATE.RIP)) {
-            LOG.warn("Connection on device {} was interrupted, will stop starting master services.", deviceInfo.getLOGValue());
-            return false;
-        }
-
-        if (!this.shuttingDownStatisticsPolling) {
-
-            LOG.info("Starting statistics context cluster services for node {}", deviceInfo.getLOGValue());
+    public boolean onContextInstantiateService(final MastershipChangeListener mastershipChangeListener) {
 
-            this.statListForCollectingInitialization();
-            Futures.addCallback(this.initialGatherDynamicData(), new FutureCallback<Boolean>() {
+        LOG.info("Starting statistics context cluster services for node {}", deviceInfo.getLOGValue());
 
-                        @Override
-                        public void onSuccess(@Nullable Boolean aBoolean) {
-                            initialSubmitHandler.initialSubmitTransaction();
-                        }
+        this.statListForCollectingInitialization();
+        Futures.addCallback(this.initialGatherDynamicData(), new FutureCallback<Boolean>() {
 
-                        @Override
-                        public void onFailure(Throwable throwable) {
-                            LOG.warn("Initial gathering statistics unsuccessful for node {}", deviceInfo.getLOGValue());
-                            lifecycleService.closeConnection();
-                        }
-                    });
+            @Override
+            public void onSuccess(@Nullable Boolean aBoolean) {
+                initialSubmitHandler.initialSubmitTransaction();
+            }
 
-                    myManager.startScheduling(deviceInfo);
+            @Override
+            public void onFailure(@Nonnull Throwable throwable) {
+                LOG.warn("Initial gathering statistics unsuccessful for node {}", deviceInfo.getLOGValue());
+                mastershipChangeListener.onNotAbleToStartMastership(deviceInfo);
+            }
+        });
 
+        if (this.isStatisticsPollingOn) {
+            myManager.startScheduling(deviceInfo);
         }
 
-        return this.clusterInitializationPhaseHandler.onContextInstantiateService(connectionContext);
+        return this.clusterInitializationPhaseHandler.onContextInstantiateService(mastershipChangeListener);
     }
 
     @Override