Improve cleanup after device disconnected event
[openflowplugin.git] / openflowplugin-impl / src / main / java / org / opendaylight / openflowplugin / impl / rpc / RpcManagerImpl.java
1 /**
2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.openflowplugin.impl.rpc;
9
10 import com.google.common.annotations.VisibleForTesting;
11 import com.google.common.base.Preconditions;
12 import com.google.common.base.Verify;
13 import com.google.common.collect.Iterators;
14 import java.util.Iterator;
15 import java.util.Optional;
16 import java.util.concurrent.ConcurrentHashMap;
17 import java.util.concurrent.ConcurrentMap;
18 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
19 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
20 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
21 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
22 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
23 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
24 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
25 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
26 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
27 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcManager;
28 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
29 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
30 import org.slf4j.Logger;
31 import org.slf4j.LoggerFactory;
32
33 public class RpcManagerImpl implements RpcManager {
34
35     private static final Logger LOG = LoggerFactory.getLogger(RpcManagerImpl.class);
36     private final RpcProviderRegistry rpcProviderRegistry;
37     private DeviceInitializationPhaseHandler deviceInitPhaseHandler;
38     private DeviceTerminationPhaseHandler deviceTerminationPhaseHandler;
39     private final int maxRequestsQuota;
40     private final ConcurrentMap<DeviceInfo, RpcContext> contexts = new ConcurrentHashMap<>();
41     private boolean isStatisticsRpcEnabled;
42     private final ExtensionConverterProvider extensionConverterProvider;
43     private final ConvertorExecutor convertorExecutor;
44     private final NotificationPublishService notificationPublishService;
45
46
47     public RpcManagerImpl(
48             final RpcProviderRegistry rpcProviderRegistry,
49             final int quotaValue,
50             final ExtensionConverterProvider extensionConverterProvider,
51                 final ConvertorExecutor convertorExecutor,
52             final NotificationPublishService notificationPublishService) {
53         this.rpcProviderRegistry = rpcProviderRegistry;
54         maxRequestsQuota = quotaValue;
55         this.extensionConverterProvider = extensionConverterProvider;
56         this.convertorExecutor = convertorExecutor;
57         this.notificationPublishService = notificationPublishService;
58     }
59
60     @Override
61     public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
62         deviceInitPhaseHandler = handler;
63     }
64
65     @Override
66     public void onDeviceContextLevelUp(final DeviceInfo deviceInfo, final LifecycleService lifecycleService) throws Exception {
67
68         final DeviceContext deviceContext = Preconditions.checkNotNull(lifecycleService.getDeviceContext());
69
70         final RpcContext rpcContext = new RpcContextImpl(
71                 deviceInfo,
72                 rpcProviderRegistry,
73                 deviceContext.getMessageSpy(),
74                 maxRequestsQuota,
75                 deviceInfo.getNodeInstanceIdentifier(),
76                 deviceContext,
77                 extensionConverterProvider,
78                 convertorExecutor,
79                 notificationPublishService);
80
81         Verify.verify(contexts.putIfAbsent(deviceInfo, rpcContext) == null, "RpcCtx still not closed for node {}", deviceInfo.getNodeId());
82         lifecycleService.setRpcContext(rpcContext);
83         lifecycleService.registerDeviceRemovedHandler(this);
84         rpcContext.setStatisticsRpcEnabled(isStatisticsRpcEnabled);
85
86         // finish device initialization cycle back to DeviceManager
87         deviceInitPhaseHandler.onDeviceContextLevelUp(deviceInfo, lifecycleService);
88     }
89
90     @Override
91     public void close() {
92         for (final Iterator<RpcContext> iterator = Iterators.consumingIterator(contexts.values().iterator());
93                 iterator.hasNext();) {
94             iterator.next().close();
95         }
96     }
97
98     @Override
99     public void onDeviceContextLevelDown(final DeviceInfo deviceInfo) {
100         Optional.ofNullable(contexts.get(deviceInfo)).ifPresent(OFPContext::close);
101         deviceTerminationPhaseHandler.onDeviceContextLevelDown(deviceInfo);
102     }
103
104     @Override
105     public void setDeviceTerminationPhaseHandler(final DeviceTerminationPhaseHandler handler) {
106         this.deviceTerminationPhaseHandler = handler;
107     }
108
109     /**
110      * This method is only for testing
111      */
112     @VisibleForTesting
113     void addRecordToContexts(DeviceInfo deviceInfo, RpcContext rpcContexts) {
114         if(!contexts.containsKey(deviceInfo)) {
115             this.contexts.put(deviceInfo,rpcContexts);
116         }
117     }
118
119
120     @Override
121     public void setStatisticsRpcEnabled(boolean statisticsRpcEnabled) {
122         isStatisticsRpcEnabled = statisticsRpcEnabled;
123     }
124
125     @Override
126     public void onDeviceRemoved(DeviceInfo deviceInfo) {
127         contexts.remove(deviceInfo);
128         LOG.debug("Rpc context removed for node {}", deviceInfo.getLOGValue());
129     }
130 }