2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.openflowplugin.impl;
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;
57 * Created by Martin Bobak <mbobak@cisco.com> on 27.3.2015.
59 public class OpenFlowPluginProviderImpl implements OpenFlowPluginProvider, OpenFlowPluginExtensionRegistratorProvider {
61 private static final Logger LOG = LoggerFactory.getLogger(OpenFlowPluginProviderImpl.class);
62 private static final MessageIntelligenceAgency messageIntelligenceAgency = new MessageIntelligenceAgencyImpl();
64 private final int rpcRequestsQuota;
65 private final long globalNotificationQuota;
66 private long barrierInterval;
67 private int barrierCountLimit;
68 private long echoReplyTimeout;
69 private DeviceManager deviceManager;
70 private RoleManager roleManager;
71 private RpcManager rpcManager;
72 private RpcProviderRegistry rpcProviderRegistry;
73 private StatisticsManager statisticsManager;
74 private ConnectionManager connectionManager;
75 private NotificationService notificationProviderService;
76 private NotificationPublishService notificationPublishService;
77 private EntityOwnershipService entityOwnershipService;
79 private ExtensionConverterManager extensionConverterManager;
81 private DataBroker dataBroker;
82 private Collection<SwitchConnectionProvider> switchConnectionProviders;
83 private boolean switchFeaturesMandatory = false;
84 private boolean isStatisticsPollingOff = false;
85 private boolean isStatisticsRpcEnabled;
87 public OpenFlowPluginProviderImpl(final long rpcRequestsQuota, final Long globalNotificationQuota) {
88 Preconditions.checkArgument(rpcRequestsQuota > 0 && rpcRequestsQuota <= Integer.MAX_VALUE, "rpcRequestQuota has to be in range <1,%s>", Integer.MAX_VALUE);
89 this.rpcRequestsQuota = (int) rpcRequestsQuota;
90 this.globalNotificationQuota = Preconditions.checkNotNull(globalNotificationQuota);
94 public boolean isStatisticsPollingOff() {
95 return isStatisticsPollingOff;
99 public void setIsStatisticsPollingOff(final boolean isStatisticsPollingOff) {
100 this.isStatisticsPollingOff = isStatisticsPollingOff;
103 private void startSwitchConnections() {
104 final List<ListenableFuture<Boolean>> starterChain = new ArrayList<>(switchConnectionProviders.size());
105 for (final SwitchConnectionProvider switchConnectionPrv : switchConnectionProviders) {
106 switchConnectionPrv.setSwitchConnectionHandler(connectionManager);
107 final ListenableFuture<Boolean> isOnlineFuture = switchConnectionPrv.startup();
108 starterChain.add(isOnlineFuture);
111 final ListenableFuture<List<Boolean>> srvStarted = Futures.allAsList(starterChain);
112 Futures.addCallback(srvStarted, new FutureCallback<List<Boolean>>() {
114 public void onSuccess(final List<Boolean> result) {
115 LOG.info("All switchConnectionProviders are up and running ({}).",
120 public void onFailure(final Throwable t) {
121 LOG.warn("Some switchConnectionProviders failed to start.", t);
127 public boolean isSwitchFeaturesMandatory() {
128 return switchFeaturesMandatory;
132 public void setEntityOwnershipService(final EntityOwnershipService entityOwnershipService) {
133 this.entityOwnershipService = entityOwnershipService;
137 public void setBarrierCountLimit(final int barrierCountLimit) {
138 this.barrierCountLimit = barrierCountLimit;
142 public void setBarrierInterval(final long barrierTimeoutLimit) {
143 this.barrierInterval = barrierTimeoutLimit;
147 public void setEchoReplyTimeout(final long echoReplyTimeout) {
148 this.echoReplyTimeout = echoReplyTimeout;
153 public void setSwitchFeaturesMandatory(final boolean switchFeaturesMandatory) {
154 this.switchFeaturesMandatory = switchFeaturesMandatory;
157 public static MessageIntelligenceAgency getMessageIntelligenceAgency() {
158 return OpenFlowPluginProviderImpl.messageIntelligenceAgency;
162 public void setSwitchConnectionProviders(final Collection<SwitchConnectionProvider> switchConnectionProviders) {
163 this.switchConnectionProviders = switchConnectionProviders;
167 public void setDataBroker(final DataBroker dataBroker) {
168 this.dataBroker = dataBroker;
172 public void setRpcProviderRegistry(final RpcProviderRegistry rpcProviderRegistry) {
173 this.rpcProviderRegistry = rpcProviderRegistry;
177 public void initialize() {
179 Preconditions.checkNotNull(dataBroker, "missing data broker");
180 Preconditions.checkNotNull(rpcProviderRegistry, "missing RPC provider registry");
181 Preconditions.checkNotNull(notificationProviderService, "missing notification provider service");
183 extensionConverterManager = new ExtensionConverterManagerImpl();
184 // TODO: copied from OpenFlowPluginProvider (Helium) misusesing the old way of distributing extension converters
185 // TODO: rewrite later!
186 OFSessionUtil.getSessionManager().setExtensionConverterProvider(extensionConverterManager);
188 connectionManager = new ConnectionManagerImpl(echoReplyTimeout);
190 registerMXBean(messageIntelligenceAgency);
192 deviceManager = new DeviceManagerImpl(dataBroker, messageIntelligenceAgency, globalNotificationQuota,
193 switchFeaturesMandatory, barrierInterval, barrierCountLimit);
194 ((ExtensionConverterProviderKeeper) deviceManager).setExtensionConverterProvider(extensionConverterManager);
195 roleManager = new RoleManagerImpl(entityOwnershipService, dataBroker);
196 statisticsManager = new StatisticsManagerImpl(rpcProviderRegistry, isStatisticsPollingOff);
197 rpcManager = new RpcManagerImpl(rpcProviderRegistry, rpcRequestsQuota);
199 roleManager.addRoleChangeListener(LifecycleConductor.getInstance());
201 /* Initialization Phase ordering - OFP Device Context suite */
202 // CM -> DM -> SM -> RPC -> Role -> DM
203 connectionManager.setDeviceConnectedHandler(deviceManager);
204 deviceManager.setDeviceInitializationPhaseHandler(statisticsManager);
205 statisticsManager.setDeviceInitializationPhaseHandler(rpcManager);
206 rpcManager.setDeviceInitializationPhaseHandler(roleManager);
207 roleManager.setDeviceInitializationPhaseHandler(deviceManager);
209 /* Termination Phase ordering - OFP Device Context suite */
210 deviceManager.setDeviceTerminationPhaseHandler(rpcManager);
211 rpcManager.setDeviceTerminationPhaseHandler(statisticsManager);
212 statisticsManager.setDeviceTerminationPhaseHandler(roleManager);
213 roleManager.setDeviceTerminationPhaseHandler(deviceManager);
215 rpcManager.setStatisticsRpcEnabled(isStatisticsRpcEnabled);
216 rpcManager.setNotificationPublishService(notificationPublishService);
218 deviceManager.setNotificationService(this.notificationProviderService);
219 deviceManager.setNotificationPublishService(this.notificationPublishService);
221 LifecycleConductor.getInstance().setDeviceManager(deviceManager);
223 TranslatorLibraryUtil.setBasicTranslatorLibrary(deviceManager);
224 deviceManager.initialize();
226 startSwitchConnections();
229 private static void registerMXBean(final MessageIntelligenceAgency messageIntelligenceAgency) {
230 final MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
232 final String pathToMxBean = String.format("%s:type=%s",
233 MessageIntelligenceAgencyMXBean.class.getPackage().getName(),
234 MessageIntelligenceAgencyMXBean.class.getSimpleName());
235 final ObjectName name = new ObjectName(pathToMxBean);
236 mbs.registerMBean(messageIntelligenceAgency, name);
237 } catch (MalformedObjectNameException
238 | NotCompliantMBeanException
239 | MBeanRegistrationException
240 | InstanceAlreadyExistsException e) {
241 LOG.warn("Error registering MBean {}", e);
246 public void setNotificationProviderService(final NotificationService notificationProviderService) {
247 this.notificationProviderService = notificationProviderService;
251 public void setNotificationPublishService(final NotificationPublishService notificationPublishProviderService) {
252 this.notificationPublishService = notificationPublishProviderService;
256 public ExtensionConverterRegistrator getExtensionConverterRegistrator() {
257 return extensionConverterManager;
261 public void setIsStatisticsRpcEnabled(final boolean isStatisticsRpcEnabled) {
262 this.isStatisticsRpcEnabled = isStatisticsRpcEnabled;
266 public void close() throws Exception {
267 //TODO: consider wrapping each manager into try-catch
268 deviceManager.close();
270 statisticsManager.close();
272 // TODO: needs to close org.opendaylight.openflowplugin.impl.role.OpenflowOwnershipListener after RoleContexts are down
273 // TODO: must not be executed prior to all living RoleContexts have been closed (via closing living DeviceContexts)