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
8 package org.opendaylight.openflowplugin.impl.util;
10 import com.google.common.base.Preconditions;
11 import com.google.common.base.Verify;
12 import com.google.common.reflect.TypeToken;
13 import java.util.concurrent.atomic.AtomicLong;
14 import javax.annotation.CheckForNull;
15 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
16 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
17 import org.opendaylight.openflowplugin.api.openflow.rpc.RpcContext;
18 import org.opendaylight.openflowplugin.api.openflow.statistics.compatibility.Delegator;
19 import org.opendaylight.openflowplugin.extension.api.core.extension.ExtensionConverterProvider;
20 import org.opendaylight.openflowplugin.impl.services.FlowCapableTransactionServiceImpl;
21 import org.opendaylight.openflowplugin.impl.services.NodeConfigServiceImpl;
22 import org.opendaylight.openflowplugin.impl.services.PacketProcessingServiceImpl;
23 import org.opendaylight.openflowplugin.impl.services.SalEchoServiceImpl;
24 import org.opendaylight.openflowplugin.impl.services.SalExperimenterMessageServiceImpl;
25 import org.opendaylight.openflowplugin.impl.services.SalFlatBatchServiceImpl;
26 import org.opendaylight.openflowplugin.impl.services.SalFlowServiceImpl;
27 import org.opendaylight.openflowplugin.impl.services.SalFlowsBatchServiceImpl;
28 import org.opendaylight.openflowplugin.impl.services.SalGroupServiceImpl;
29 import org.opendaylight.openflowplugin.impl.services.SalGroupsBatchServiceImpl;
30 import org.opendaylight.openflowplugin.impl.services.SalMeterServiceImpl;
31 import org.opendaylight.openflowplugin.impl.services.SalMetersBatchServiceImpl;
32 import org.opendaylight.openflowplugin.impl.services.SalPortServiceImpl;
33 import org.opendaylight.openflowplugin.impl.services.SalTableServiceImpl;
34 import org.opendaylight.openflowplugin.impl.statistics.services.OpendaylightFlowStatisticsServiceImpl;
35 import org.opendaylight.openflowplugin.impl.statistics.services.OpendaylightFlowTableStatisticsServiceImpl;
36 import org.opendaylight.openflowplugin.impl.statistics.services.OpendaylightGroupStatisticsServiceImpl;
37 import org.opendaylight.openflowplugin.impl.statistics.services.OpendaylightMeterStatisticsServiceImpl;
38 import org.opendaylight.openflowplugin.impl.statistics.services.OpendaylightPortStatisticsServiceImpl;
39 import org.opendaylight.openflowplugin.impl.statistics.services.OpendaylightQueueStatisticsServiceImpl;
40 import org.opendaylight.openflowplugin.impl.statistics.services.compatibility.OpendaylightFlowStatisticsServiceDelegateImpl;
41 import org.opendaylight.openflowplugin.impl.statistics.services.direct.FlowDirectStatisticsService;
42 import org.opendaylight.openflowplugin.impl.statistics.services.direct.GroupDirectStatisticsService;
43 import org.opendaylight.openflowplugin.impl.statistics.services.direct.MeterDirectStatisticsService;
44 import org.opendaylight.openflowplugin.impl.statistics.services.direct.NodeConnectorDirectStatisticsService;
45 import org.opendaylight.openflowplugin.impl.statistics.services.direct.OpendaylightDirectStatisticsServiceImpl;
46 import org.opendaylight.openflowplugin.impl.statistics.services.direct.OpendaylightDirectStatisticsServiceProvider;
47 import org.opendaylight.openflowplugin.impl.statistics.services.direct.QueueDirectStatisticsService;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.direct.statistics.rev160511.OpendaylightDirectStatisticsService;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.echo.service.rev150305.SalEchoService;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.experimenter.message.service.rev151020.SalExperimenterMessageService;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.SalFlatBatchService;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.OpendaylightFlowStatisticsService;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.table.statistics.rev131215.OpendaylightFlowTableStatisticsService;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.FlowCapableTransactionService;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.SalGroupService;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.OpendaylightGroupStatisticsService;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.SalMeterService;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.OpendaylightMeterStatisticsService;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.module.config.rev141015.NodeConfigService;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketProcessingService;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.service.rev131107.SalPortService;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.port.statistics.rev131214.OpendaylightPortStatisticsService;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.queue.statistics.rev131216.OpendaylightQueueStatisticsService;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.OfpRole;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.service.rev131026.SalTableService;
68 public class MdSalRegistrationUtils {
70 //TODO: Make one register and one unregister method for all services
72 private static final TypeToken<Delegator<OpendaylightFlowStatisticsService>> COMPOSITE_SERVICE_TYPE_TOKEN =
73 new TypeToken<Delegator<OpendaylightFlowStatisticsService>>() {
77 private MdSalRegistrationUtils() {
78 throw new IllegalStateException();
82 * Method registers all OF services for role {@link OfpRole#BECOMEMASTER}
84 * @param rpcContext - registration processing is implemented in {@link RpcContext}
85 * @param deviceContext - every service needs {@link DeviceContext} as input parameter
87 public static void registerServices(@CheckForNull final RpcContext rpcContext,
88 @CheckForNull final DeviceContext deviceContext,
89 final ExtensionConverterProvider extensionConverterProvider) {
90 Preconditions.checkArgument(rpcContext != null);
91 Preconditions.checkArgument(deviceContext != null);
93 // create service instances
94 final SalFlowServiceImpl salFlowService = new SalFlowServiceImpl(rpcContext, deviceContext);
95 final FlowCapableTransactionServiceImpl flowCapableTransactionService = new FlowCapableTransactionServiceImpl(rpcContext, deviceContext);
96 final SalGroupServiceImpl salGroupService = new SalGroupServiceImpl(rpcContext, deviceContext);
97 final SalMeterServiceImpl salMeterService = new SalMeterServiceImpl(rpcContext, deviceContext);
99 // register routed service instances
100 rpcContext.registerRpcServiceImplementation(SalEchoService.class, new SalEchoServiceImpl(rpcContext, deviceContext));
101 rpcContext.registerRpcServiceImplementation(SalFlowService.class, salFlowService);
102 //TODO: add constructors with rcpContext and deviceContext to meter, group, table constructors
103 rpcContext.registerRpcServiceImplementation(FlowCapableTransactionService.class, flowCapableTransactionService);
104 rpcContext.registerRpcServiceImplementation(SalMeterService.class, salMeterService);
105 rpcContext.registerRpcServiceImplementation(SalGroupService.class, salGroupService);
106 rpcContext.registerRpcServiceImplementation(SalTableService.class, new SalTableServiceImpl(rpcContext, deviceContext, deviceContext.getPrimaryConnectionContext().getNodeId()));
107 rpcContext.registerRpcServiceImplementation(SalPortService.class, new SalPortServiceImpl(rpcContext, deviceContext));
108 rpcContext.registerRpcServiceImplementation(PacketProcessingService.class, new PacketProcessingServiceImpl(rpcContext, deviceContext));
109 rpcContext.registerRpcServiceImplementation(NodeConfigService.class, new NodeConfigServiceImpl(rpcContext, deviceContext));
110 rpcContext.registerRpcServiceImplementation(OpendaylightFlowStatisticsService.class, OpendaylightFlowStatisticsServiceImpl.createWithOook(rpcContext, deviceContext));
112 // Direct statistics gathering
113 final OpendaylightDirectStatisticsServiceProvider statisticsProvider = new OpendaylightDirectStatisticsServiceProvider();
114 statisticsProvider.register(FlowDirectStatisticsService.class, new FlowDirectStatisticsService(rpcContext, deviceContext));
115 statisticsProvider.register(GroupDirectStatisticsService.class, new GroupDirectStatisticsService(rpcContext, deviceContext));
116 statisticsProvider.register(MeterDirectStatisticsService.class, new MeterDirectStatisticsService(rpcContext, deviceContext));
117 statisticsProvider.register(NodeConnectorDirectStatisticsService.class, new NodeConnectorDirectStatisticsService(rpcContext, deviceContext));
118 statisticsProvider.register(QueueDirectStatisticsService.class, new QueueDirectStatisticsService(rpcContext, deviceContext));
119 rpcContext.registerRpcServiceImplementation(OpendaylightDirectStatisticsService.class, new OpendaylightDirectStatisticsServiceImpl(statisticsProvider));
121 final SalFlatBatchServiceImpl salFlatBatchService = new SalFlatBatchServiceImpl(
122 new SalFlowsBatchServiceImpl(salFlowService, flowCapableTransactionService),
123 new SalGroupsBatchServiceImpl(salGroupService, flowCapableTransactionService),
124 new SalMetersBatchServiceImpl(salMeterService, flowCapableTransactionService)
126 rpcContext.registerRpcServiceImplementation(SalFlatBatchService.class, salFlatBatchService);
128 // TODO: experimenter symmetric and multipart message services
129 rpcContext.registerRpcServiceImplementation(SalExperimenterMessageService.class,
130 new SalExperimenterMessageServiceImpl(rpcContext, deviceContext, extensionConverterProvider));
134 * Method unregisters all OF services.
136 * @param rpcContext - unregistration processing is implemented in {@link RpcContext}
138 public static void unregisterServices(@CheckForNull final RpcContext rpcContext) {
139 Preconditions.checkArgument(rpcContext != null);
141 rpcContext.unregisterRpcServiceImplementation(SalEchoService.class);
142 rpcContext.unregisterRpcServiceImplementation(SalFlowService.class);
143 //TODO: add constructors with rcpContext and deviceContext to meter, group, table constructors
144 rpcContext.unregisterRpcServiceImplementation(FlowCapableTransactionService.class);
145 rpcContext.unregisterRpcServiceImplementation(SalMeterService.class);
146 rpcContext.unregisterRpcServiceImplementation(SalGroupService.class);
147 rpcContext.unregisterRpcServiceImplementation(SalTableService.class);
148 rpcContext.unregisterRpcServiceImplementation(SalPortService.class);
149 rpcContext.unregisterRpcServiceImplementation(PacketProcessingService.class);
150 rpcContext.unregisterRpcServiceImplementation(NodeConfigService.class);
151 rpcContext.unregisterRpcServiceImplementation(OpendaylightFlowStatisticsService.class);
152 rpcContext.unregisterRpcServiceImplementation(SalFlatBatchService.class);
153 // TODO: experimenter symmetric and multipart message services
154 rpcContext.unregisterRpcServiceImplementation(SalExperimenterMessageService.class);
155 rpcContext.unregisterRpcServiceImplementation(OpendaylightDirectStatisticsService.class);
159 * Support deprecated statistic related services for backward compatibility. The only exception from deprecation is
160 * the aggregated flow statistic with match criteria input.
163 * @param deviceContext
164 * @param notificationPublishService
166 public static void registerStatCompatibilityServices(final RpcContext rpcContext, final DeviceContext deviceContext,
167 final NotificationPublishService notificationPublishService) {
169 AtomicLong compatibilityXidSeed = new AtomicLong();
170 // pickup low statistics service
171 final OpendaylightFlowStatisticsService flowStatisticsService = Preconditions.checkNotNull(
172 rpcContext.lookupRpcService(OpendaylightFlowStatisticsService.class));
173 Preconditions.checkArgument(COMPOSITE_SERVICE_TYPE_TOKEN.isAssignableFrom(flowStatisticsService.getClass()));
174 // attach delegate to flow statistics service (to cover all but aggregated stats with match filter input)
175 final OpendaylightFlowStatisticsServiceDelegateImpl flowStatisticsDelegate =
176 new OpendaylightFlowStatisticsServiceDelegateImpl(rpcContext, deviceContext, notificationPublishService, new AtomicLong());
177 ((Delegator<OpendaylightFlowStatisticsService>) flowStatisticsService).setDelegate(flowStatisticsDelegate);
179 // register all statistics (deprecated) services
180 rpcContext.registerRpcServiceImplementation(OpendaylightFlowTableStatisticsService.class,
181 new OpendaylightFlowTableStatisticsServiceImpl(rpcContext, deviceContext, compatibilityXidSeed, notificationPublishService));
182 rpcContext.registerRpcServiceImplementation(OpendaylightGroupStatisticsService.class,
183 new OpendaylightGroupStatisticsServiceImpl(rpcContext, deviceContext, compatibilityXidSeed, notificationPublishService));
184 rpcContext.registerRpcServiceImplementation(OpendaylightMeterStatisticsService.class,
185 new OpendaylightMeterStatisticsServiceImpl(rpcContext, deviceContext, compatibilityXidSeed, notificationPublishService));
186 rpcContext.registerRpcServiceImplementation(OpendaylightQueueStatisticsService.class,
187 new OpendaylightQueueStatisticsServiceImpl(rpcContext, deviceContext, compatibilityXidSeed, notificationPublishService));
188 rpcContext.registerRpcServiceImplementation(OpendaylightPortStatisticsService.class,
189 new OpendaylightPortStatisticsServiceImpl(rpcContext, deviceContext, compatibilityXidSeed, notificationPublishService));