openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/OpenFlowPluginProviderImpl.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
   9 package org.opendaylight.openflowplugin.impl;
  10
  11
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import java.lang.management.ManagementFactory;
  17 import java.util.ArrayList;
  18 import java.util.Collection;
  19 import java.util.List;
  20 import javax.management.InstanceAlreadyExistsException;
  21 import javax.management.MBeanRegistrationException;
  22 import javax.management.MBeanServer;
  23 import javax.management.MalformedObjectNameException;
  24 import javax.management.NotCompliantMBeanException;
  25 import javax.management.ObjectName;
  26 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  27 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  28 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
  29 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
  30 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
  31 import org.opendaylight.openflowjava.protocol.spi.connection.SwitchConnectionProvider;
  32 import org.opendaylight.openflowplugin.api.openflow.OpenFlowPluginProvider;
  33 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionManager;
  34 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
  35 import org.opendaylight.openflowplugin.api.openflow.role.RoleManager;
  36 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcManager;
  37 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsManager;
  38 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageIntelligenceAgency;
  39 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
  40 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterRegistrator;
  41 import org.opendaylight.openflowplugin.extension.api.OpenFlowPluginExtensionRegistratorProvider;
  42 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterManager;
  43 import org.opendaylight.openflowplugin.impl.connection.ConnectionManagerImpl;
  44 import org.opendaylight.openflowplugin.impl.device.DeviceManagerImpl;
  45 import org.opendaylight.openflowplugin.impl.role.RoleManagerImpl;
  46 import org.opendaylight.openflowplugin.impl.rpc.RpcManagerImpl;
  47 import org.opendaylight.openflowplugin.impl.statistics.StatisticsManagerImpl;
  48 import org.opendaylight.openflowplugin.impl.statistics.ofpspecific.MessageIntelligenceAgencyImpl;
  49 import org.opendaylight.openflowplugin.impl.statistics.ofpspecific.MessageIntelligenceAgencyMXBean;
  50 import org.opendaylight.openflowplugin.impl.util.TranslatorLibraryUtil;
  51 import org.opendaylight.openflowplugin.openflow.md.core.extension.ExtensionConverterManagerImpl;
  52 import org.opendaylight.openflowplugin.openflow.md.core.session.OFSessionUtil;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 /**
  57  * Created by Martin Bobak &lt;mbobak@cisco.com&gt; on 27.3.2015.
  58  */
  59 public class OpenFlowPluginProviderImpl implements OpenFlowPluginProvider, OpenFlowPluginExtensionRegistratorProvider {
  60
  61     private static final Logger LOG = LoggerFactory.getLogger(OpenFlowPluginProviderImpl.class);
  62     private static final MessageIntelligenceAgency messageIntelligenceAgency = new MessageIntelligenceAgencyImpl();
  63
  64     private final int rpcRequestsQuota;
  65     private final long globalNotificationQuota;
  66     private DeviceManager deviceManager;
  67     private RoleManager roleManager;
  68     private RpcManager rpcManager;
  69     private RpcProviderRegistry rpcProviderRegistry;
  70     private StatisticsManager statisticsManager;
  71     private ConnectionManager connectionManager;
  72     private NotificationService notificationProviderService;
  73     private NotificationPublishService notificationPublishService;
  74     private EntityOwnershipService entityOwnershipService;
  75
  76     private ExtensionConverterManager extensionConverterManager;
  77
  78     private DataBroker dataBroker;
  79     private Collection<SwitchConnectionProvider> switchConnectionProviders;
  80     private boolean switchFeaturesMandatory = false;
  81     private boolean isStatisticsPollingOff = false;
  82     private boolean isStatisticsRpcEnabled;
  83
  84     public OpenFlowPluginProviderImpl(final long rpcRequestsQuota, final Long globalNotificationQuota) {
  85         Preconditions.checkArgument(rpcRequestsQuota > 0 && rpcRequestsQuota <= Integer.MAX_VALUE, "rpcRequestQuota has to be in range <1,%s>", Integer.MAX_VALUE);
  86         this.rpcRequestsQuota = (int) rpcRequestsQuota;
  87         this.globalNotificationQuota = Preconditions.checkNotNull(globalNotificationQuota);
  88     }
  89
  90     @Override
  91     public boolean isStatisticsPollingOff() {
  92         return isStatisticsPollingOff;
  93     }
  94
  95     @Override
  96     public void setIsStatisticsPollingOff(final boolean isStatisticsPollingOff) {
  97         this.isStatisticsPollingOff = isStatisticsPollingOff;
  98     }
  99
 100     private void startSwitchConnections() {
 101         final List<ListenableFuture<Boolean>> starterChain = new ArrayList<>(switchConnectionProviders.size());
 102         for (final SwitchConnectionProvider switchConnectionPrv : switchConnectionProviders) {
 103             switchConnectionPrv.setSwitchConnectionHandler(connectionManager);
 104             final ListenableFuture<Boolean> isOnlineFuture = switchConnectionPrv.startup();
 105             starterChain.add(isOnlineFuture);
 106         }
 107
 108         final ListenableFuture<List<Boolean>> srvStarted = Futures.allAsList(starterChain);
 109         Futures.addCallback(srvStarted, new FutureCallback<List<Boolean>>() {
 110             @Override
 111             public void onSuccess(final List<Boolean> result) {
 112                 LOG.info("All switchConnectionProviders are up and running ({}).",
 113                         result.size());
 114             }
 115
 116             @Override
 117             public void onFailure(final Throwable t) {
 118                 LOG.warn("Some switchConnectionProviders failed to start.", t);
 119             }
 120         });
 121     }
 122
 123     public boolean isSwitchFeaturesMandatory() {
 124         return switchFeaturesMandatory;
 125     }
 126
 127     @Override
 128     public void setEntityOwnershipService(EntityOwnershipService entityOwnershipService) {
 129         this.entityOwnershipService = entityOwnershipService;
 130     }
 131
 132     public void setSwitchFeaturesMandatory(final boolean switchFeaturesMandatory) {
 133         this.switchFeaturesMandatory = switchFeaturesMandatory;
 134     }
 135
 136     public static MessageIntelligenceAgency getMessageIntelligenceAgency() {
 137         return OpenFlowPluginProviderImpl.messageIntelligenceAgency;
 138     }
 139
 140     @Override
 141     public void setSwitchConnectionProviders(final Collection<SwitchConnectionProvider> switchConnectionProviders) {
 142         this.switchConnectionProviders = switchConnectionProviders;
 143     }
 144
 145     @Override
 146     public void setDataBroker(final DataBroker dataBroker) {
 147         this.dataBroker = dataBroker;
 148     }
 149
 150     @Override
 151     public void setRpcProviderRegistry(final RpcProviderRegistry rpcProviderRegistry) {
 152         this.rpcProviderRegistry = rpcProviderRegistry;
 153     }
 154
 155     @Override
 156     public void initialize() {
 157
 158         Preconditions.checkNotNull(dataBroker, "missing data broker");
 159         Preconditions.checkNotNull(rpcProviderRegistry, "missing RPC provider registry");
 160         Preconditions.checkNotNull(notificationProviderService, "missing notification provider service");
 161
 162         extensionConverterManager = new ExtensionConverterManagerImpl();
 163         // TODO: copied from OpenFlowPluginProvider (Helium) misusesing the old way of distributing extension converters
 164         // TODO: rewrite later!
 165         OFSessionUtil.getSessionManager().setExtensionConverterProvider(extensionConverterManager);
 166
 167         connectionManager = new ConnectionManagerImpl();
 168
 169         registerMXBean(messageIntelligenceAgency);
 170
 171         deviceManager = new DeviceManagerImpl(dataBroker, messageIntelligenceAgency, switchFeaturesMandatory, globalNotificationQuota);
 172         ((ExtensionConverterProviderKeeper) deviceManager).setExtensionConverterProvider(extensionConverterManager);
 173
 174         roleManager = new RoleManagerImpl(rpcProviderRegistry, entityOwnershipService);
 175         statisticsManager = new StatisticsManagerImpl(rpcProviderRegistry, isStatisticsPollingOff);
 176         rpcManager = new RpcManagerImpl(rpcProviderRegistry, rpcRequestsQuota);
 177
 178         // CM -> DM -> Role -> SM -> RPC -> DM
 179         connectionManager.setDeviceConnectedHandler(deviceManager);
 180         deviceManager.setDeviceInitializationPhaseHandler(roleManager);
 181         roleManager.setDeviceInitializationPhaseHandler(statisticsManager);
 182         statisticsManager.setDeviceInitializationPhaseHandler(rpcManager);
 183         rpcManager.setDeviceInitializationPhaseHandler(deviceManager);
 184         rpcManager.setStatisticsRpcEnabled(isStatisticsRpcEnabled);
 185         rpcManager.setNotificationPublishService(notificationPublishService);
 186
 187         deviceManager.setNotificationService(this.notificationProviderService);
 188         deviceManager.setNotificationPublishService(this.notificationPublishService);
 189
 190         TranslatorLibraryUtil.setBasicTranslatorLibrary(deviceManager);
 191         deviceManager.initialize();
 192
 193         startSwitchConnections();
 194     }
 195
 196     private static void registerMXBean(final MessageIntelligenceAgency messageIntelligenceAgency) {
 197         MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
 198         try {
 199             String pathToMxBean = String.format("%s:type=%s",
 200                     MessageIntelligenceAgencyMXBean.class.getPackage().getName(),
 201                     MessageIntelligenceAgencyMXBean.class.getSimpleName());
 202             ObjectName name = new ObjectName(pathToMxBean);
 203             mbs.registerMBean(messageIntelligenceAgency, name);
 204         } catch (MalformedObjectNameException
 205                 | NotCompliantMBeanException
 206                 | MBeanRegistrationException
 207                 | InstanceAlreadyExistsException e) {
 208             LOG.warn("Error registering MBean {}", e);
 209         }
 210     }
 211
 212     @Override
 213     public void setNotificationProviderService(final NotificationService notificationProviderService) {
 214         this.notificationProviderService = notificationProviderService;
 215     }
 216
 217     @Override
 218     public void setNotificationPublishService(final NotificationPublishService notificationPublishProviderService) {
 219         this.notificationPublishService = notificationPublishProviderService;
 220     }
 221
 222     @Override
 223     public ExtensionConverterRegistrator getExtensionConverterRegistrator() {
 224         return extensionConverterManager;
 225     }
 226
 227     @Override
 228     public void setIsStatisticsRpcEnabled(final boolean isStatisticsRpcEnabled) {
 229         this.isStatisticsRpcEnabled = isStatisticsRpcEnabled;
 230     }
 231
 232     @Override
 233     public void close() throws Exception {
 234         deviceManager.close();
 235         rpcManager.close();
 236         statisticsManager.close();
 237         roleManager.close();
 238     }
 239 }