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 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 ExtensionConverterProvider extensionConverterProvider,
  50                 final ConvertorExecutor convertorExecutor,
  51             final NotificationPublishService notificationPublishService) {
  52         this.rpcProviderRegistry = rpcProviderRegistry;
  53         this.extensionConverterProvider = extensionConverterProvider;
  54         this.convertorExecutor = convertorExecutor;
  55         this.notificationPublishService = notificationPublishService;
  56     }
  57
  58     @Override
  59     public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
  60         deviceInitPhaseHandler = handler;
  61     }
  62
  63     @Override
  64     public void onDeviceContextLevelUp(final DeviceInfo deviceInfo, final LifecycleService lifecycleService) throws Exception {
  65
  66         final DeviceContext deviceContext = Preconditions.checkNotNull(lifecycleService.getDeviceContext());
  67
  68         final RpcContext rpcContext = new RpcContextImpl(
  69                 deviceInfo,
  70                 rpcProviderRegistry,
  71                 deviceContext.getMessageSpy(),
  72                 maxRequestsQuota,
  73                 deviceInfo.getNodeInstanceIdentifier(),
  74                 deviceContext,
  75                 extensionConverterProvider,
  76                 convertorExecutor,
  77                 notificationPublishService);
  78
  79         Verify.verify(contexts.putIfAbsent(deviceInfo, rpcContext) == null, "RpcCtx still not closed for node {}", deviceInfo.getNodeId());
  80         lifecycleService.setRpcContext(rpcContext);
  81         lifecycleService.registerDeviceRemovedHandler(this);
  82         rpcContext.setStatisticsRpcEnabled(isStatisticsRpcEnabled);
  83
  84         // finish device initialization cycle back to DeviceManager
  85         deviceInitPhaseHandler.onDeviceContextLevelUp(deviceInfo, lifecycleService);
  86     }
  87
  88     @Override
  89     public void close() {
  90         for (final Iterator<RpcContext> iterator = Iterators.consumingIterator(contexts.values().iterator());
  91                 iterator.hasNext();) {
  92             iterator.next().close();
  93         }
  94     }
  95
  96     @Override
  97     public void onDeviceContextLevelDown(final DeviceInfo deviceInfo) {
  98         Optional.ofNullable(contexts.get(deviceInfo)).ifPresent(OFPContext::close);
  99         deviceTerminationPhaseHandler.onDeviceContextLevelDown(deviceInfo);
 100     }
 101
 102     @Override
 103     public void setDeviceTerminationPhaseHandler(final DeviceTerminationPhaseHandler handler) {
 104         this.deviceTerminationPhaseHandler = handler;
 105     }
 106
 107     /**
 108      * This method is only for testing
 109      */
 110     @VisibleForTesting
 111     void addRecordToContexts(DeviceInfo deviceInfo, RpcContext rpcContexts) {
 112         if(!contexts.containsKey(deviceInfo)) {
 113             this.contexts.put(deviceInfo,rpcContexts);
 114         }
 115     }
 116
 117
 118     @Override
 119     public void setStatisticsRpcEnabled(boolean statisticsRpcEnabled) {
 120         isStatisticsRpcEnabled = statisticsRpcEnabled;
 121     }
 122
 123     @Override
 124     public void setRpcRequestQuota(final int rpcRequestQuota) {
 125         this.maxRequestsQuota = rpcRequestQuota;
 126     }
 127
 128     @Override
 129     public void onDeviceRemoved(DeviceInfo deviceInfo) {
 130         contexts.remove(deviceInfo);
 131         LOG.debug("Rpc context removed for node {}", deviceInfo.getLOGValue());
 132     }
 133 }