2 * Copyright (c) 2017 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.controller.clustering.it.provider;
11 import com.google.common.util.concurrent.Futures;
12 import com.google.common.util.concurrent.SettableFuture;
13 import java.util.HashMap;
15 import java.util.concurrent.Future;
16 import org.opendaylight.controller.clustering.it.provider.impl.FlappingSingletonService;
17 import org.opendaylight.controller.clustering.it.provider.impl.GetConstantService;
18 import org.opendaylight.controller.clustering.it.provider.impl.PublishNotificationsTask;
19 import org.opendaylight.controller.clustering.it.provider.impl.RoutedGetConstantService;
20 import org.opendaylight.controller.clustering.it.provider.impl.SingletonGetConstantService;
21 import org.opendaylight.controller.clustering.it.provider.impl.YnlListener;
22 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
23 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
24 import org.opendaylight.controller.md.sal.dom.api.DOMRpcImplementationRegistration;
25 import org.opendaylight.controller.md.sal.dom.api.DOMRpcProviderService;
26 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
27 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
28 import org.opendaylight.controller.sal.core.api.model.SchemaService;
29 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
30 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
31 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
32 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.AddShardReplicaInput;
33 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.BecomeModuleLeaderInput;
34 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.BecomePrefixLeaderInput;
35 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.IsClientAbortedOutput;
36 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.OdlMdsalLowlevelControlService;
37 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.ProduceTransactionsInput;
38 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.PublishNotificationsInput;
39 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterBoundConstantInput;
40 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterConstantInput;
41 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterDefaultConstantInput;
42 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterSingletonConstantInput;
43 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RemoveShardReplicaInput;
44 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeYnlInput;
45 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterBoundConstantInput;
46 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterFlappingSingletonOutput;
47 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterFlappingSingletonOutputBuilder;
48 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDdtlOutput;
49 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDtclOutput;
50 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeYnlInput;
51 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeYnlOutput;
52 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsInput;
53 import org.opendaylight.yangtools.concepts.ListenerRegistration;
54 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
55 import org.opendaylight.yangtools.yang.common.RpcError;
56 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
57 import org.opendaylight.yangtools.yang.common.RpcResult;
58 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
59 import org.slf4j.Logger;
60 import org.slf4j.LoggerFactory;
62 public class MdsalLowLevelTestProvider implements OdlMdsalLowlevelControlService {
64 private static final Logger LOG = LoggerFactory.getLogger(MdsalLowLevelTestProvider.class);
66 private final RpcProviderRegistry rpcRegistry;
67 private final BindingAwareBroker.RpcRegistration<OdlMdsalLowlevelControlService> registration;
68 private final BindingNormalizedNodeSerializer bindingNormalizedNodeSerializer;
69 private final NotificationPublishService notificationPublishService;
70 private final NotificationService notificationService;
71 private final SchemaService schemaService;
72 private final ClusterSingletonServiceProvider singletonService;
73 private final DOMRpcProviderService domRpcService;
75 private Map<InstanceIdentifier<?>, DOMRpcImplementationRegistration<RoutedGetConstantService>> routedRegistrations =
78 private Map<String, ListenerRegistration<YnlListener>> ynlRegistrations = new HashMap<>();
80 private DOMRpcImplementationRegistration<GetConstantService> globalGetConstantRegistration = null;
81 private ClusterSingletonServiceRegistration getSingletonConstantRegistration;
82 private FlappingSingletonService flappingSingletonService;
84 public MdsalLowLevelTestProvider(final RpcProviderRegistry rpcRegistry,
85 final DOMRpcProviderService domRpcService,
86 final ClusterSingletonServiceProvider singletonService,
87 final SchemaService schemaService,
88 final BindingNormalizedNodeSerializer bindingNormalizedNodeSerializer,
89 final NotificationPublishService notificationPublishService,
90 final NotificationService notificationService) {
91 this.rpcRegistry = rpcRegistry;
92 this.domRpcService = domRpcService;
93 this.singletonService = singletonService;
94 this.schemaService = schemaService;
95 this.bindingNormalizedNodeSerializer = bindingNormalizedNodeSerializer;
96 this.notificationPublishService = notificationPublishService;
97 this.notificationService = notificationService;
99 registration = rpcRegistry.addRpcImplementation(OdlMdsalLowlevelControlService.class, this);
103 public Future<RpcResult<Void>> unregisterSingletonConstant() {
104 LOG.debug("unregister-singleton-constant");
106 if (getSingletonConstantRegistration == null) {
107 LOG.debug("No get-singleton-constant registration present.");
108 final RpcError rpcError = RpcResultBuilder
109 .newError(ErrorType.APPLICATION, "missing-registration", "No get-singleton-constant rpc registration present.");
110 final RpcResult<Void> result = RpcResultBuilder.<Void>failed().withRpcError(rpcError).build();
111 return Futures.immediateFuture(result);
115 getSingletonConstantRegistration.close();
116 getSingletonConstantRegistration = null;
118 return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
119 } catch (final Exception e) {
120 LOG.debug("There was a problem closing the singleton constant service", e);
121 final RpcError rpcError = RpcResultBuilder
122 .newError(ErrorType.APPLICATION, "error-closing", "There was a problem closing get-singleton-constant");
123 final RpcResult<Void> result = RpcResultBuilder.<Void>failed().withRpcError(rpcError).build();
124 return Futures.immediateFuture(result);
129 public Future<RpcResult<Void>> publishNotifications(final PublishNotificationsInput input) {
130 LOG.debug("publish-notifications, input: {}", input);
132 final PublishNotificationsTask task = new PublishNotificationsTask(notificationPublishService, input.getId(),
133 input.getSeconds(), input.getNotificationsPerSecond());
135 final SettableFuture<RpcResult<Void>> settableFuture = SettableFuture.create();
136 task.start(settableFuture);
138 return settableFuture;
142 public Future<RpcResult<Void>> subscribeDtcl() {
147 public Future<RpcResult<Void>> writeTransactions(WriteTransactionsInput input) {
152 public Future<RpcResult<IsClientAbortedOutput>> isClientAborted() {
157 public Future<RpcResult<Void>> becomeModuleLeader(BecomeModuleLeaderInput input) {
162 public Future<RpcResult<Void>> removeShardReplica(RemoveShardReplicaInput input) {
167 public Future<RpcResult<Void>> subscribeYnl(final SubscribeYnlInput input) {
169 LOG.debug("subscribe-ynl, input: {}", input);
171 if (ynlRegistrations.containsKey(input.getId())) {
172 final RpcError error = RpcResultBuilder.newError(ErrorType.RPC, "Registration present.",
173 "There is already ynl listener registered for this id: " + input.getId());
174 return Futures.immediateFuture(RpcResultBuilder.<Void>failed().withRpcError(error).build());
177 ynlRegistrations.put(input.getId(),
178 notificationService.registerNotificationListener(new YnlListener(input.getId())));
180 return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
184 public Future<RpcResult<Void>> becomePrefixLeader(BecomePrefixLeaderInput input) {
189 public Future<RpcResult<Void>> unregisterBoundConstant(final UnregisterBoundConstantInput input) {
190 LOG.debug("unregister-bound-constant, {}", input);
192 final DOMRpcImplementationRegistration<RoutedGetConstantService> registration =
193 routedRegistrations.remove(input.getContext());
195 if (registration == null) {
196 LOG.debug("No get-contexted-constant registration for context: {}", input.getContext());
197 final RpcError rpcError = RpcResultBuilder
198 .newError(ErrorType.APPLICATION, "missing-registration", "No get-constant rpc registration present.");
199 final RpcResult<Void> result = RpcResultBuilder.<Void>failed().withRpcError(rpcError).build();
200 return Futures.immediateFuture(result);
203 registration.close();
204 return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
208 public Future<RpcResult<Void>> registerSingletonConstant(final RegisterSingletonConstantInput input) {
210 LOG.debug("Received register-singleton-constant rpc, input: {}", input);
212 if (input.getConstant() == null) {
213 final RpcError error = RpcResultBuilder.newError(
214 ErrorType.RPC, "Invalid input.", "Constant value is null");
215 return Futures.immediateFuture(RpcResultBuilder.<Void>failed().withRpcError(error).build());
218 getSingletonConstantRegistration =
219 SingletonGetConstantService.registerNew(singletonService, domRpcService, input.getConstant());
221 return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
225 public Future<RpcResult<Void>> registerDefaultConstant(RegisterDefaultConstantInput input) {
230 public Future<RpcResult<Void>> unregisterConstant() {
232 if (globalGetConstantRegistration == null) {
233 final RpcError rpcError = RpcResultBuilder
234 .newError(ErrorType.APPLICATION, "missing-registration", "No get-constant rpc registration present.");
235 final RpcResult<Void> result = RpcResultBuilder.<Void>failed().withRpcError(rpcError).build();
236 return Futures.immediateFuture(result);
239 globalGetConstantRegistration.close();
240 globalGetConstantRegistration = null;
242 return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
246 public Future<RpcResult<UnregisterFlappingSingletonOutput>> unregisterFlappingSingleton() {
247 LOG.debug("unregister-flapping-singleton received.");
249 if (flappingSingletonService == null) {
250 final RpcError rpcError = RpcResultBuilder
251 .newError(ErrorType.APPLICATION, "missing-registration", "No flapping-singleton registration present.");
252 final RpcResult<UnregisterFlappingSingletonOutput> result =
253 RpcResultBuilder.<UnregisterFlappingSingletonOutput>failed().withRpcError(rpcError).build();
254 return Futures.immediateFuture(result);
257 final long flapCount = flappingSingletonService.setInactive();
258 flappingSingletonService = null;
260 final UnregisterFlappingSingletonOutput output =
261 new UnregisterFlappingSingletonOutputBuilder().setFlapCount(flapCount).build();
263 return Futures.immediateFuture(RpcResultBuilder.success(output).build());
267 public Future<RpcResult<Void>> addShardReplica(AddShardReplicaInput input) {
272 public Future<RpcResult<Void>> subscribeDdtl() {
277 public Future<RpcResult<Void>> registerBoundConstant(final RegisterBoundConstantInput input) {
278 LOG.debug("register-bound-constant: {}", input);
280 if (input.getContext() == null) {
281 final RpcError error = RpcResultBuilder.newError(
282 ErrorType.RPC, "Invalid input.", "Context value is null");
283 return Futures.immediateFuture(RpcResultBuilder.<Void>failed().withRpcError(error).build());
286 if (input.getConstant() == null) {
287 final RpcError error = RpcResultBuilder.newError(
288 ErrorType.RPC, "Invalid input.", "Constant value is null");
289 return Futures.immediateFuture(RpcResultBuilder.<Void>failed().withRpcError(error).build());
292 if (routedRegistrations.containsKey(input.getContext())) {
293 final RpcError error = RpcResultBuilder.newError(ErrorType.RPC, "Registration present.",
294 "There is already a rpc registered for context: " + input.getContext());
295 return Futures.immediateFuture(RpcResultBuilder.<Void>failed().withRpcError(error).build());
298 final DOMRpcImplementationRegistration<RoutedGetConstantService> registration =
299 RoutedGetConstantService.registerNew(bindingNormalizedNodeSerializer, domRpcService,
300 input.getConstant(), input.getContext());
302 routedRegistrations.put(input.getContext(), registration);
303 return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
307 public Future<RpcResult<Void>> registerFlappingSingleton() {
308 LOG.debug("Received register-flapping-singleton.");
310 if (flappingSingletonService != null) {
311 final RpcError error = RpcResultBuilder.newError(
312 ErrorType.RPC, "Registration present.", "flappin-singleton already registered");
313 return Futures.immediateFuture(RpcResultBuilder.<Void>failed().withRpcError(error).build());
316 flappingSingletonService = new FlappingSingletonService(singletonService);
318 return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
322 public Future<RpcResult<UnsubscribeDtclOutput>> unsubscribeDtcl() {
327 public Future<RpcResult<Void>> deconfigureIdIntsShard() {
332 public Future<RpcResult<UnsubscribeYnlOutput>> unsubscribeYnl(final UnsubscribeYnlInput input) {
333 LOG.debug("Received unsubscribe-ynl, input: {}", input);
335 if (!ynlRegistrations.containsKey(input.getId())) {
336 final RpcError rpcError = RpcResultBuilder
337 .newError(ErrorType.APPLICATION, "missing-registration", "No ynl listener with this id registered.");
338 final RpcResult<UnsubscribeYnlOutput> result =
339 RpcResultBuilder.<UnsubscribeYnlOutput>failed().withRpcError(rpcError).build();
340 return Futures.immediateFuture(result);
343 final ListenerRegistration<YnlListener> registration = ynlRegistrations.remove(input.getId());
344 final UnsubscribeYnlOutput output = registration.getInstance().getOutput();
346 registration.close();
348 return Futures.immediateFuture(RpcResultBuilder.<UnsubscribeYnlOutput>success().withResult(output).build());
352 public Future<RpcResult<Void>> produceTransactions(ProduceTransactionsInput input) {
357 public Future<RpcResult<Void>> registerConstant(final RegisterConstantInput input) {
359 LOG.debug("Received register-constant rpc, input: {}", input);
361 if (input.getConstant() == null) {
362 final RpcError error = RpcResultBuilder.newError(
363 ErrorType.RPC, "Invalid input.", "Constant value is null");
364 return Futures.immediateFuture(RpcResultBuilder.<Void>failed().withRpcError(error).build());
367 if (globalGetConstantRegistration != null) {
368 final RpcError error = RpcResultBuilder.newError(ErrorType.RPC, "Registration present.",
369 "There is already a get-constant rpc registered.");
370 return Futures.immediateFuture(RpcResultBuilder.<Void>failed().withRpcError(error).build());
373 globalGetConstantRegistration = GetConstantService.registerNew(domRpcService, input.getConstant());
374 return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
378 public Future<RpcResult<Void>> unregisterDefaultConstant() {
383 public Future<RpcResult<UnsubscribeDdtlOutput>> unsubscribeDdtl() {