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.annotation.Nonnull;
21 import javax.management.InstanceAlreadyExistsException;
22 import javax.management.MBeanRegistrationException;
23 import javax.management.MBeanServer;
24 import javax.management.MalformedObjectNameException;
25 import javax.management.NotCompliantMBeanException;
26 import javax.management.ObjectName;
27 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
28 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
29 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
30 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
31 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
32 import org.opendaylight.openflowjava.protocol.spi.connection.SwitchConnectionProvider;
33 import org.opendaylight.openflowplugin.api.openflow.OpenFlowPluginProvider;
34 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionManager;
35 import org.opendaylight.openflowplugin.api.openflow.device.DeviceManager;
36 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleConductor;
37 import org.opendaylight.openflowplugin.api.openflow.lifecycle.RoleChangeListener;
38 import org.opendaylight.openflowplugin.api.openflow.role.RoleManager;
39 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcManager;
40 import org.opendaylight.openflowplugin.api.openflow.statistics.StatisticsManager;
41 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageIntelligenceAgency;
42 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterProviderKeeper;
43 import org.opendaylight.openflowplugin.extension.api.ExtensionConverterRegistrator;
44 import org.opendaylight.openflowplugin.extension.api.OpenFlowPluginExtensionRegistratorProvider;
45 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterManager;
46 import org.opendaylight.openflowplugin.impl.connection.ConnectionManagerImpl;
47 import org.opendaylight.openflowplugin.impl.device.DeviceManagerImpl;
48 import org.opendaylight.openflowplugin.impl.role.RoleManagerImpl;
49 import org.opendaylight.openflowplugin.impl.rpc.RpcManagerImpl;
50 import org.opendaylight.openflowplugin.impl.statistics.StatisticsManagerImpl;
51 import org.opendaylight.openflowplugin.impl.statistics.ofpspecific.MessageIntelligenceAgencyImpl;
52 import org.opendaylight.openflowplugin.impl.statistics.ofpspecific.MessageIntelligenceAgencyMXBean;
53 import org.opendaylight.openflowplugin.impl.util.TranslatorLibraryUtil;
54 import org.opendaylight.openflowplugin.openflow.md.core.extension.ExtensionConverterManagerImpl;
55 import org.opendaylight.openflowplugin.openflow.md.core.session.OFSessionUtil;
56 import org.slf4j.Logger;
57 import org.slf4j.LoggerFactory;
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 private final LifecycleConductor conductor;
89 public OpenFlowPluginProviderImpl(final long rpcRequestsQuota, final Long globalNotificationQuota) {
90 Preconditions.checkArgument(rpcRequestsQuota > 0 && rpcRequestsQuota <= Integer.MAX_VALUE, "rpcRequestQuota has to be in range <1,%s>", Integer.MAX_VALUE);
91 this.rpcRequestsQuota = (int) rpcRequestsQuota;
92 this.globalNotificationQuota = Preconditions.checkNotNull(globalNotificationQuota);
93 conductor = new LifecycleConductorImpl(messageIntelligenceAgency);
97 public boolean isStatisticsPollingOff() {
98 return isStatisticsPollingOff;
102 public void setIsStatisticsPollingOff(final boolean isStatisticsPollingOff) {
103 this.isStatisticsPollingOff = isStatisticsPollingOff;
106 private void startSwitchConnections() {
107 final List<ListenableFuture<Boolean>> starterChain = new ArrayList<>(switchConnectionProviders.size());
108 for (final SwitchConnectionProvider switchConnectionPrv : switchConnectionProviders) {
109 switchConnectionPrv.setSwitchConnectionHandler(connectionManager);
110 final ListenableFuture<Boolean> isOnlineFuture = switchConnectionPrv.startup();
111 starterChain.add(isOnlineFuture);
114 final ListenableFuture<List<Boolean>> srvStarted = Futures.allAsList(starterChain);
115 Futures.addCallback(srvStarted, new FutureCallback<List<Boolean>>() {
117 public void onSuccess(final List<Boolean> result) {
118 LOG.info("All switchConnectionProviders are up and running ({}).",
123 public void onFailure(@Nonnull final Throwable t) {
124 LOG.warn("Some switchConnectionProviders failed to start.", t);
130 public boolean isSwitchFeaturesMandatory() {
131 return switchFeaturesMandatory;
135 public void setEntityOwnershipService(final EntityOwnershipService entityOwnershipService) {
136 this.entityOwnershipService = entityOwnershipService;
140 public void setBarrierCountLimit(final int barrierCountLimit) {
141 this.barrierCountLimit = barrierCountLimit;
145 public void setBarrierInterval(final long barrierTimeoutLimit) {
146 this.barrierInterval = barrierTimeoutLimit;
150 public void setEchoReplyTimeout(final long echoReplyTimeout) {
151 this.echoReplyTimeout = echoReplyTimeout;
156 public void setSwitchFeaturesMandatory(final boolean switchFeaturesMandatory) {
157 this.switchFeaturesMandatory = switchFeaturesMandatory;
160 public static MessageIntelligenceAgency getMessageIntelligenceAgency() {
161 return OpenFlowPluginProviderImpl.messageIntelligenceAgency;
165 public void setSwitchConnectionProviders(final Collection<SwitchConnectionProvider> switchConnectionProviders) {
166 this.switchConnectionProviders = switchConnectionProviders;
170 public void setDataBroker(final DataBroker dataBroker) {
171 this.dataBroker = dataBroker;
175 public void setRpcProviderRegistry(final RpcProviderRegistry rpcProviderRegistry) {
176 this.rpcProviderRegistry = rpcProviderRegistry;
180 public void initialize() {
182 Preconditions.checkNotNull(dataBroker, "missing data broker");
183 Preconditions.checkNotNull(rpcProviderRegistry, "missing RPC provider registry");
184 Preconditions.checkNotNull(notificationProviderService, "missing notification provider service");
186 extensionConverterManager = new ExtensionConverterManagerImpl();
187 // TODO: copied from OpenFlowPluginProvider (Helium) misusesing the old way of distributing extension converters
188 // TODO: rewrite later!
189 OFSessionUtil.getSessionManager().setExtensionConverterProvider(extensionConverterManager);
191 connectionManager = new ConnectionManagerImpl(echoReplyTimeout);
193 registerMXBean(messageIntelligenceAgency);
195 deviceManager = new DeviceManagerImpl(dataBroker,
196 globalNotificationQuota,
197 switchFeaturesMandatory,
201 ((ExtensionConverterProviderKeeper) deviceManager).setExtensionConverterProvider(extensionConverterManager);
203 conductor.setSafelyManager(deviceManager);
204 conductor.setNotificationPublishService(notificationPublishService);
206 roleManager = new RoleManagerImpl(entityOwnershipService, dataBroker, conductor);
207 statisticsManager = new StatisticsManagerImpl(rpcProviderRegistry, isStatisticsPollingOff, conductor);
208 conductor.setSafelyManager(statisticsManager);
209 rpcManager = new RpcManagerImpl(rpcProviderRegistry, rpcRequestsQuota, conductor);
210 conductor.setSafelyManager(rpcManager);
211 roleManager.addRoleChangeListener((RoleChangeListener) conductor);
213 /* Initialization Phase ordering - OFP Device Context suite */
214 // CM -> DM -> SM -> RPC -> Role -> DM
215 connectionManager.setDeviceConnectedHandler(deviceManager);
216 deviceManager.setDeviceInitializationPhaseHandler(statisticsManager);
217 statisticsManager.setDeviceInitializationPhaseHandler(rpcManager);
218 rpcManager.setDeviceInitializationPhaseHandler(roleManager);
219 roleManager.setDeviceInitializationPhaseHandler(deviceManager);
221 /* Termination Phase ordering - OFP Device Context suite */
222 deviceManager.setDeviceTerminationPhaseHandler(rpcManager);
223 rpcManager.setDeviceTerminationPhaseHandler(statisticsManager);
224 statisticsManager.setDeviceTerminationPhaseHandler(roleManager);
225 roleManager.setDeviceTerminationPhaseHandler(deviceManager);
227 rpcManager.setStatisticsRpcEnabled(isStatisticsRpcEnabled);
229 TranslatorLibraryUtil.setBasicTranslatorLibrary(deviceManager);
230 deviceManager.initialize();
232 startSwitchConnections();
235 private static void registerMXBean(final MessageIntelligenceAgency messageIntelligenceAgency) {
236 final MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
238 final String pathToMxBean = String.format("%s:type=%s",
239 MessageIntelligenceAgencyMXBean.class.getPackage().getName(),
240 MessageIntelligenceAgencyMXBean.class.getSimpleName());
241 final ObjectName name = new ObjectName(pathToMxBean);
242 mbs.registerMBean(messageIntelligenceAgency, name);
243 } catch (MalformedObjectNameException
244 | NotCompliantMBeanException
245 | MBeanRegistrationException
246 | InstanceAlreadyExistsException e) {
247 LOG.warn("Error registering MBean {}", e);
252 public void setNotificationProviderService(final NotificationService notificationProviderService) {
253 this.notificationProviderService = notificationProviderService;
257 public void setNotificationPublishService(final NotificationPublishService notificationPublishProviderService) {
258 this.notificationPublishService = notificationPublishProviderService;
262 public ExtensionConverterRegistrator getExtensionConverterRegistrator() {
263 return extensionConverterManager;
267 public void setIsStatisticsRpcEnabled(final boolean isStatisticsRpcEnabled) {
268 this.isStatisticsRpcEnabled = isStatisticsRpcEnabled;
272 public void close() throws Exception {
273 //TODO: consider wrapping each manager into try-catch
274 deviceManager.close();
276 statisticsManager.close();
278 // TODO: needs to close org.opendaylight.openflowplugin.impl.role.OpenflowOwnershipListener after RoleContexts are down
279 // TODO: must not be executed prior to all living RoleContexts have been closed (via closing living DeviceContexts)