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.concurrent.ConcurrentHashMap;
  16 import java.util.concurrent.ConcurrentMap;
  17 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  18 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  19 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
  20 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  21 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  22 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceInitializationPhaseHandler;
  23 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceTerminationPhaseHandler;
  24 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleConductor;
  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 deviceTerminPhaseHandler;
  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 NotificationPublishService notificationPublishService;
  44
  45     private final LifecycleConductor conductor;
  46     private final ConvertorExecutor convertorExecutor;
  47
  48     public RpcManagerImpl(
  49             final RpcProviderRegistry rpcProviderRegistry,
  50             final int quotaValue,
  51
  52             final LifecycleConductor lifecycleConductor,
  53             final ExtensionConverterProvider extensionConverterProvider,
  54                 final ConvertorExecutor convertorExecutor,
  55             final NotificationPublishService notificationPublishService) {
  56         this.rpcProviderRegistry = rpcProviderRegistry;
  57         maxRequestsQuota = quotaValue;
  58         this.extensionConverterProvider = extensionConverterProvider;
  59         this.conductor = lifecycleConductor;
  60         this.convertorExecutor = convertorExecutor;
  61         this.notificationPublishService = notificationPublishService;
  62     }
  63
  64     @Override
  65     public void setDeviceInitializationPhaseHandler(final DeviceInitializationPhaseHandler handler) {
  66         deviceInitPhaseHandler = handler;
  67     }
  68
  69     @Override
  70     public void onDeviceContextLevelUp(final DeviceInfo deviceInfo, final LifecycleService lifecycleService) throws Exception {
  71
  72         final DeviceContext deviceContext = Preconditions.checkNotNull(conductor.getDeviceContext(deviceInfo));
  73
  74         final RpcContext rpcContext = new RpcContextImpl(
  75                 deviceInfo,
  76                 rpcProviderRegistry,
  77                 deviceContext,
  78                 deviceContext.getMessageSpy(),
  79                 maxRequestsQuota,
  80                 deviceInfo.getNodeInstanceIdentifier(),
  81                 deviceContext,
  82                 extensionConverterProvider,
  83                 convertorExecutor,
  84                 notificationPublishService);
  85
  86         Verify.verify(contexts.putIfAbsent(deviceInfo, rpcContext) == null, "RpcCtx still not closed for node {}", deviceInfo.getNodeId());
  87         lifecycleService.setRpcContext(rpcContext);
  88         rpcContext.setStatisticsRpcEnabled(isStatisticsRpcEnabled);
  89
  90         // finish device initialization cycle back to DeviceManager
  91         deviceInitPhaseHandler.onDeviceContextLevelUp(deviceInfo, lifecycleService);
  92     }
  93
  94     @Override
  95     public void close() {
  96         for (final Iterator<RpcContext> iterator = Iterators.consumingIterator(contexts.values().iterator());
  97                 iterator.hasNext();) {
  98             iterator.next().close();
  99         }
 100     }
 101
 102     @Override
 103     public void onDeviceContextLevelDown(final DeviceInfo deviceInfo) {
 104         final RpcContext removedContext = contexts.remove(deviceInfo);
 105         if (removedContext != null) {
 106             LOG.info("Unregister RPCs services for device context closure");
 107             removedContext.close();
 108         }
 109         deviceTerminPhaseHandler.onDeviceContextLevelDown(deviceInfo);
 110     }
 111
 112     @Override
 113     public void setDeviceTerminationPhaseHandler(final DeviceTerminationPhaseHandler handler) {
 114         this.deviceTerminPhaseHandler = handler;
 115     }
 116
 117     /**
 118      * This method is only for testing
 119      */
 120     @VisibleForTesting
 121     void addRecordToContexts(DeviceInfo deviceInfo, RpcContext rpcContexts) {
 122         if(!contexts.containsKey(deviceInfo)) {
 123             this.contexts.put(deviceInfo,rpcContexts);
 124         }
 125     }
 126
 127     @Override
 128     public <T extends OFPContext> T gainContext(DeviceInfo deviceInfo) {
 129         return (T) contexts.get(deviceInfo);
 130     }
 131
 132
 133     @Override
 134     public void setStatisticsRpcEnabled(boolean statisticsRpcEnabled) {
 135         isStatisticsRpcEnabled = statisticsRpcEnabled;
 136     }
 137 }