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
8 package org.opendaylight.controller.clustering.it.provider;
10 import akka.actor.ActorRef;
11 import akka.dispatch.Futures;
12 import akka.dispatch.OnComplete;
13 import akka.pattern.Patterns;
14 import com.google.common.base.Strings;
15 import com.google.common.collect.ImmutableClassToInstanceMap;
16 import com.google.common.util.concurrent.ListenableFuture;
17 import com.google.common.util.concurrent.SettableFuture;
18 import java.util.HashMap;
20 import java.util.Optional;
21 import java.util.concurrent.ExecutionException;
22 import java.util.concurrent.TimeUnit;
23 import java.util.concurrent.TimeoutException;
24 import javax.annotation.PreDestroy;
25 import javax.inject.Inject;
26 import javax.inject.Singleton;
27 import org.opendaylight.controller.cluster.datastore.DistributedDataStoreInterface;
28 import org.opendaylight.controller.cluster.datastore.utils.ActorUtils;
29 import org.opendaylight.controller.cluster.raft.client.messages.Shutdown;
30 import org.opendaylight.controller.clustering.it.provider.impl.FlappingSingletonService;
31 import org.opendaylight.controller.clustering.it.provider.impl.GetConstantService;
32 import org.opendaylight.controller.clustering.it.provider.impl.IdIntsListener;
33 import org.opendaylight.controller.clustering.it.provider.impl.PublishNotificationsTask;
34 import org.opendaylight.controller.clustering.it.provider.impl.RoutedGetConstantService;
35 import org.opendaylight.controller.clustering.it.provider.impl.SingletonGetConstantService;
36 import org.opendaylight.controller.clustering.it.provider.impl.WriteTransactionsHandler;
37 import org.opendaylight.controller.clustering.it.provider.impl.YnlListener;
38 import org.opendaylight.mdsal.binding.api.NotificationPublishService;
39 import org.opendaylight.mdsal.binding.api.NotificationService;
40 import org.opendaylight.mdsal.binding.api.RpcProviderService;
41 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
42 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
43 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
44 import org.opendaylight.mdsal.dom.api.DOMDataBroker.DataTreeChangeExtension;
45 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
46 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
47 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
48 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
49 import org.opendaylight.mdsal.singleton.api.ClusterSingletonServiceProvider;
50 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.AddShardReplica;
51 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.AddShardReplicaInput;
52 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.AddShardReplicaOutput;
53 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.CheckPublishNotifications;
54 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.CheckPublishNotificationsInput;
55 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.CheckPublishNotificationsOutput;
56 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.CheckPublishNotificationsOutputBuilder;
57 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.IsClientAborted;
58 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.IsClientAbortedInput;
59 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.IsClientAbortedOutput;
60 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterBoundConstant;
61 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterBoundConstantInput;
62 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterBoundConstantOutput;
63 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterBoundConstantOutputBuilder;
64 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterConstant;
65 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterConstantInput;
66 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterConstantOutput;
67 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterConstantOutputBuilder;
68 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterDefaultConstant;
69 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterDefaultConstantInput;
70 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterDefaultConstantOutput;
71 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterFlappingSingleton;
72 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterFlappingSingletonInput;
73 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterFlappingSingletonOutput;
74 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterFlappingSingletonOutputBuilder;
75 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterSingletonConstant;
76 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterSingletonConstantInput;
77 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterSingletonConstantOutput;
78 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterSingletonConstantOutputBuilder;
79 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RemoveShardReplica;
80 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RemoveShardReplicaInput;
81 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RemoveShardReplicaOutput;
82 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.ShutdownShardReplica;
83 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.ShutdownShardReplicaInput;
84 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.ShutdownShardReplicaOutput;
85 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.ShutdownShardReplicaOutputBuilder;
86 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.StartPublishNotifications;
87 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.StartPublishNotificationsInput;
88 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.StartPublishNotificationsOutput;
89 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.StartPublishNotificationsOutputBuilder;
90 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeDdtl;
91 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeDdtlInput;
92 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeDdtlOutput;
93 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeDtcl;
94 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeDtclInput;
95 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeDtclOutput;
96 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeDtclOutputBuilder;
97 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeYnl;
98 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeYnlInput;
99 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeYnlOutput;
100 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeYnlOutputBuilder;
101 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterBoundConstant;
102 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterBoundConstantInput;
103 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterBoundConstantOutput;
104 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterBoundConstantOutputBuilder;
105 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterConstant;
106 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterConstantInput;
107 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterConstantOutput;
108 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterConstantOutputBuilder;
109 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterDefaultConstant;
110 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterDefaultConstantInput;
111 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterDefaultConstantOutput;
112 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterFlappingSingleton;
113 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterFlappingSingletonInput;
114 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterFlappingSingletonOutput;
115 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterFlappingSingletonOutputBuilder;
116 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterSingletonConstant;
117 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterSingletonConstantInput;
118 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterSingletonConstantOutput;
119 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterSingletonConstantOutputBuilder;
120 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDdtl;
121 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDdtlInput;
122 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDdtlOutput;
123 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDtcl;
124 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDtclInput;
125 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDtclOutput;
126 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDtclOutputBuilder;
127 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeYnl;
128 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeYnlInput;
129 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeYnlOutput;
130 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactions;
131 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsInput;
132 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsOutput;
133 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.target.rev170215.IdSequence;
134 import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
135 import org.opendaylight.yangtools.concepts.ObjectRegistration;
136 import org.opendaylight.yangtools.concepts.Registration;
137 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
138 import org.opendaylight.yangtools.yang.binding.Rpc;
139 import org.opendaylight.yangtools.yang.common.ErrorTag;
140 import org.opendaylight.yangtools.yang.common.ErrorType;
141 import org.opendaylight.yangtools.yang.common.RpcResult;
142 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
143 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
144 import org.osgi.service.component.annotations.Activate;
145 import org.osgi.service.component.annotations.Component;
146 import org.osgi.service.component.annotations.Deactivate;
147 import org.osgi.service.component.annotations.Reference;
148 import org.slf4j.Logger;
149 import org.slf4j.LoggerFactory;
150 import scala.concurrent.duration.FiniteDuration;
153 @Component(service = {})
154 public final class MdsalLowLevelTestProvider {
155 private static final Logger LOG = LoggerFactory.getLogger(MdsalLowLevelTestProvider.class);
157 private final Registration registration;
158 private final DistributedDataStoreInterface configDataStore;
159 private final BindingNormalizedNodeSerializer bindingNormalizedNodeSerializer;
160 private final DOMDataBroker domDataBroker;
161 private final NotificationPublishService notificationPublishService;
162 private final NotificationService notificationService;
163 private final ClusterSingletonServiceProvider singletonService;
164 private final DOMRpcProviderService domRpcService;
165 private final DataTreeChangeExtension dataTreeChangeExtension;
167 private final Map<InstanceIdentifier<?>, Registration> routedRegistrations = new HashMap<>();
168 private final Map<String, ObjectRegistration<YnlListener>> ynlRegistrations = new HashMap<>();
169 private final Map<String, PublishNotificationsTask> publishNotificationsTasks = new HashMap<>();
171 private Registration globalGetConstantRegistration = null;
172 private Registration getSingletonConstantRegistration;
173 private FlappingSingletonService flappingSingletonService;
174 private Registration dtclReg;
175 private IdIntsListener idIntsListener;
179 public MdsalLowLevelTestProvider(
180 @Reference final RpcProviderService rpcRegistry,
181 @Reference final DOMRpcProviderService domRpcService,
182 @Reference final ClusterSingletonServiceProvider singletonService,
183 @Reference final DOMSchemaService schemaService,
184 @Reference final BindingNormalizedNodeSerializer bindingNormalizedNodeSerializer,
185 @Reference final NotificationPublishService notificationPublishService,
186 @Reference final NotificationService notificationService,
187 @Reference final DOMDataBroker domDataBroker,
188 @Reference final DistributedDataStoreInterface configDataStore) {
189 this.domRpcService = domRpcService;
190 this.singletonService = singletonService;
191 this.bindingNormalizedNodeSerializer = bindingNormalizedNodeSerializer;
192 this.notificationPublishService = notificationPublishService;
193 this.notificationService = notificationService;
194 this.domDataBroker = domDataBroker;
195 this.configDataStore = configDataStore;
197 dataTreeChangeExtension = domDataBroker.extension(DataTreeChangeExtension.class);
199 registration = rpcRegistry.registerRpcImplementations(ImmutableClassToInstanceMap.<Rpc<?, ?>>builder()
200 .put(UnregisterSingletonConstant.class, this::unregisterSingletonConstant)
201 .put(StartPublishNotifications.class, this::startPublishNotifications)
202 .put(SubscribeDdtl.class, this::subscribeDdtl)
203 .put(WriteTransactions.class, this::writeTransactions)
204 .put(IsClientAborted.class, this::isClientAborted)
205 .put(RemoveShardReplica.class, this::removeShardReplica)
206 .put(SubscribeYnl.class, this::subscribeYnl)
207 .put(UnregisterBoundConstant.class, this::unregisterBoundConstant)
208 .put(RegisterSingletonConstant.class, this::registerSingletonConstant)
209 .put(RegisterDefaultConstant.class, this::registerDefaultConstant)
210 .put(UnregisterConstant.class, this::unregisterConstant)
211 .put(UnregisterFlappingSingleton.class, this::unregisterFlappingSingleton)
212 .put(AddShardReplica.class, this::addShardReplica)
213 .put(RegisterBoundConstant.class, this::registerBoundConstant)
214 .put(RegisterFlappingSingleton.class, this::registerFlappingSingleton)
215 .put(UnsubscribeDdtl.class, this::unsubscribeDdtl)
216 .put(UnsubscribeYnl.class, this::unsubscribeYnl)
217 .put(CheckPublishNotifications.class, this::checkPublishNotifications)
218 .put(ShutdownShardReplica.class, this::shutdownShardReplica)
219 .put(RegisterConstant.class, this::registerConstant)
220 .put(UnregisterDefaultConstant.class, this::unregisterDefaultConstant)
221 .put(SubscribeDtcl.class, this::subscribeDtcl)
222 .put(UnsubscribeDtcl.class, this::unsubscribeDtcl)
228 public void close() {
229 registration.close();
232 @SuppressWarnings("checkstyle:IllegalCatch")
233 private ListenableFuture<RpcResult<UnregisterSingletonConstantOutput>> unregisterSingletonConstant(
234 final UnregisterSingletonConstantInput input) {
235 LOG.info("In unregisterSingletonConstant");
237 if (getSingletonConstantRegistration == null) {
238 return RpcResultBuilder.<UnregisterSingletonConstantOutput>failed()
239 .withError(ErrorType.RPC, ErrorTag.DATA_MISSING, "No prior RPC was registered")
244 getSingletonConstantRegistration.close();
245 getSingletonConstantRegistration = null;
247 return RpcResultBuilder.success(new UnregisterSingletonConstantOutputBuilder().build()).buildFuture();
248 } catch (Exception e) {
249 String msg = "Error closing the singleton constant service";
251 return RpcResultBuilder.<UnregisterSingletonConstantOutput>failed().withError(
252 ErrorType.APPLICATION, msg, e).buildFuture();
256 private ListenableFuture<RpcResult<StartPublishNotificationsOutput>> startPublishNotifications(
257 final StartPublishNotificationsInput input) {
258 LOG.info("In startPublishNotifications - input: {}", input);
260 final PublishNotificationsTask task = new PublishNotificationsTask(notificationPublishService, input.getId(),
261 input.getSeconds().toJava(), input.getNotificationsPerSecond().toJava());
263 publishNotificationsTasks.put(input.getId(), task);
267 return RpcResultBuilder.success(new StartPublishNotificationsOutputBuilder().build()).buildFuture();
270 private ListenableFuture<RpcResult<SubscribeDtclOutput>> subscribeDtcl(final SubscribeDtclInput input) {
271 LOG.info("In subscribeDtcl - input: {}", input);
273 if (dtclReg != null) {
274 return RpcResultBuilder.<SubscribeDtclOutput>failed().withError(ErrorType.RPC, ErrorTag.DATA_EXISTS,
275 "There is already a DataTreeChangeListener registered for id-ints")
279 idIntsListener = new IdIntsListener();
281 dtclReg = dataTreeChangeExtension.registerDataTreeChangeListener(
282 new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION, WriteTransactionsHandler.ID_INT_YID),
285 return RpcResultBuilder.success(new SubscribeDtclOutputBuilder().build()).buildFuture();
288 private ListenableFuture<RpcResult<WriteTransactionsOutput>> writeTransactions(final WriteTransactionsInput input) {
289 return WriteTransactionsHandler.start(domDataBroker, input);
292 private ListenableFuture<RpcResult<IsClientAbortedOutput>> isClientAborted(final IsClientAbortedInput input) {
296 private ListenableFuture<RpcResult<RemoveShardReplicaOutput>> removeShardReplica(
297 final RemoveShardReplicaInput input) {
301 private ListenableFuture<RpcResult<SubscribeYnlOutput>> subscribeYnl(final SubscribeYnlInput input) {
302 LOG.info("In subscribeYnl - input: {}", input);
304 if (ynlRegistrations.containsKey(input.getId())) {
305 return RpcResultBuilder.<SubscribeYnlOutput>failed()
306 .withError(ErrorType.RPC, ErrorTag.DATA_EXISTS,
307 "There is already a listener registered for id: " + input.getId())
311 final var id = input.getId();
312 final var listener = new YnlListener(id);
313 final var reg = notificationService.registerListener(IdSequence.class, listener);
314 ynlRegistrations.put(id, new AbstractObjectRegistration<>(listener) {
316 protected void removeRegistration() {
321 return RpcResultBuilder.success(new SubscribeYnlOutputBuilder().build()).buildFuture();
325 private ListenableFuture<RpcResult<UnregisterBoundConstantOutput>> unregisterBoundConstant(
326 final UnregisterBoundConstantInput input) {
327 LOG.info("In unregisterBoundConstant - {}", input);
329 final var rpcRegistration = routedRegistrations.remove(input.getContext());
330 if (rpcRegistration == null) {
331 return RpcResultBuilder.<UnregisterBoundConstantOutput>failed()
332 .withError(ErrorType.RPC, ErrorTag.DATA_MISSING,
333 "No prior RPC was registered for " + input.getContext())
337 rpcRegistration.close();
338 return RpcResultBuilder.success(new UnregisterBoundConstantOutputBuilder().build()).buildFuture();
341 private ListenableFuture<RpcResult<RegisterSingletonConstantOutput>> registerSingletonConstant(
342 final RegisterSingletonConstantInput input) {
343 LOG.info("In registerSingletonConstant - input: {}", input);
345 if (input.getConstant() == null) {
346 return RpcResultBuilder.<RegisterSingletonConstantOutput>failed()
347 .withError(ErrorType.RPC, ErrorTag.INVALID_VALUE, "Constant value is null")
351 getSingletonConstantRegistration =
352 SingletonGetConstantService.registerNew(singletonService, domRpcService, input.getConstant());
354 return RpcResultBuilder.success(new RegisterSingletonConstantOutputBuilder().build()).buildFuture();
357 private ListenableFuture<RpcResult<RegisterDefaultConstantOutput>> registerDefaultConstant(
358 final RegisterDefaultConstantInput input) {
362 private ListenableFuture<RpcResult<UnregisterConstantOutput>> unregisterConstant(
363 final UnregisterConstantInput input) {
364 LOG.info("In unregisterConstant");
366 if (globalGetConstantRegistration == null) {
367 return RpcResultBuilder.<UnregisterConstantOutput>failed()
368 .withError(ErrorType.RPC, ErrorTag.DATA_MISSING, "No prior RPC was registered")
372 globalGetConstantRegistration.close();
373 globalGetConstantRegistration = null;
375 return RpcResultBuilder.success(new UnregisterConstantOutputBuilder().build()).buildFuture();
378 private ListenableFuture<RpcResult<UnregisterFlappingSingletonOutput>> unregisterFlappingSingleton(
379 final UnregisterFlappingSingletonInput input) {
380 LOG.info("In unregisterFlappingSingleton");
382 if (flappingSingletonService == null) {
383 return RpcResultBuilder.<UnregisterFlappingSingletonOutput>failed()
384 .withError(ErrorType.RPC, ErrorTag.DATA_MISSING, "No prior RPC was registered")
388 final long flapCount = flappingSingletonService.setInactive();
389 flappingSingletonService = null;
391 return RpcResultBuilder.success(new UnregisterFlappingSingletonOutputBuilder().setFlapCount(flapCount).build())
395 private ListenableFuture<RpcResult<AddShardReplicaOutput>> addShardReplica(final AddShardReplicaInput input) {
396 throw new UnsupportedOperationException();
399 private ListenableFuture<RpcResult<SubscribeDdtlOutput>> subscribeDdtl(final SubscribeDdtlInput input) {
400 throw new UnsupportedOperationException();
403 private ListenableFuture<RpcResult<RegisterBoundConstantOutput>> registerBoundConstant(
404 final RegisterBoundConstantInput input) {
405 LOG.info("In registerBoundConstant - input: {}", input);
407 if (input.getContext() == null) {
408 return RpcResultBuilder.<RegisterBoundConstantOutput>failed().withError(
409 ErrorType.RPC, ErrorTag.INVALID_VALUE, "Context value is null").buildFuture();
412 if (input.getConstant() == null) {
413 return RpcResultBuilder.<RegisterBoundConstantOutput>failed().withError(
414 ErrorType.RPC, ErrorTag.INVALID_VALUE, "Constant value is null").buildFuture();
417 if (routedRegistrations.containsKey(input.getContext())) {
418 return RpcResultBuilder.<RegisterBoundConstantOutput>failed().withError(ErrorType.RPC,
419 ErrorTag.DATA_EXISTS, "There is already an rpc registered for context: " + input.getContext())
423 final var rpcRegistration = RoutedGetConstantService.registerNew(bindingNormalizedNodeSerializer, domRpcService,
424 input.getConstant(), input.getContext());
426 routedRegistrations.put(input.getContext(), rpcRegistration);
427 return RpcResultBuilder.success(new RegisterBoundConstantOutputBuilder().build()).buildFuture();
430 private ListenableFuture<RpcResult<RegisterFlappingSingletonOutput>> registerFlappingSingleton(
431 final RegisterFlappingSingletonInput input) {
432 LOG.info("In registerFlappingSingleton");
434 if (flappingSingletonService != null) {
435 return RpcResultBuilder.<RegisterFlappingSingletonOutput>failed()
436 .withError(ErrorType.RPC, ErrorTag.DATA_EXISTS, "There is already an rpc registered")
440 flappingSingletonService = new FlappingSingletonService(singletonService);
442 return RpcResultBuilder.success(new RegisterFlappingSingletonOutputBuilder().build()).buildFuture();
445 private ListenableFuture<RpcResult<UnsubscribeDtclOutput>> unsubscribeDtcl(final UnsubscribeDtclInput input) {
446 LOG.info("In unsubscribeDtcl");
448 if (idIntsListener == null || dtclReg == null) {
449 return RpcResultBuilder.<UnsubscribeDtclOutput>failed()
450 .withError(ErrorType.RPC, ErrorTag.DATA_MISSING, "No prior listener was registered")
456 idIntsListener.tryFinishProcessing().get(timeout, TimeUnit.SECONDS);
457 } catch (InterruptedException | ExecutionException | TimeoutException e) {
458 LOG.error("Unable to finish notification processing", e);
459 return RpcResultBuilder.<UnsubscribeDtclOutput>failed().withError(ErrorType.APPLICATION,
460 "Unable to finish notification processing in " + timeout + " seconds", e).buildFuture();
466 if (!idIntsListener.hasTriggered()) {
467 return RpcResultBuilder.<UnsubscribeDtclOutput>failed()
468 .withError(ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED,
469 "id-ints listener has not received any notifications.")
473 try (DOMDataTreeReadTransaction rTx = domDataBroker.newReadOnlyTransaction()) {
474 final Optional<NormalizedNode> readResult = rTx.read(LogicalDatastoreType.CONFIGURATION,
475 WriteTransactionsHandler.ID_INT_YID).get();
477 if (!readResult.isPresent()) {
478 return RpcResultBuilder.<UnsubscribeDtclOutput>failed()
479 .withError(ErrorType.APPLICATION, ErrorTag.DATA_MISSING, "No data read from id-ints list")
483 final boolean nodesEqual = idIntsListener.checkEqual(readResult.orElseThrow());
485 LOG.error("Final read of id-int does not match IdIntsListener's copy. {}",
486 idIntsListener.diffWithLocalCopy(readResult.orElseThrow()));
489 return RpcResultBuilder.success(new UnsubscribeDtclOutputBuilder().setCopyMatches(nodesEqual).build())
492 } catch (final InterruptedException | ExecutionException e) {
493 LOG.error("Final read of id-ints failed", e);
494 return RpcResultBuilder.<UnsubscribeDtclOutput>failed().withError(ErrorType.APPLICATION,
495 "Final read of id-ints failed", e).buildFuture();
499 private ListenableFuture<RpcResult<UnsubscribeYnlOutput>> unsubscribeYnl(final UnsubscribeYnlInput input) {
500 LOG.info("In unsubscribeYnl - input: {}", input);
502 if (!ynlRegistrations.containsKey(input.getId())) {
503 return RpcResultBuilder.<UnsubscribeYnlOutput>failed()
504 .withError(ErrorType.RPC, ErrorTag.DATA_MISSING,
505 "No prior listener was registered for " + input.getId())
509 try (var reg = ynlRegistrations.remove(input.getId())) {
510 return RpcResultBuilder.<UnsubscribeYnlOutput>success()
511 .withResult(reg.getInstance().getOutput())
516 private ListenableFuture<RpcResult<CheckPublishNotificationsOutput>> checkPublishNotifications(
517 final CheckPublishNotificationsInput input) {
518 LOG.info("In checkPublishNotifications - input: {}", input);
520 final PublishNotificationsTask task = publishNotificationsTasks.get(input.getId());
523 return RpcResultBuilder.success(new CheckPublishNotificationsOutputBuilder().setActive(false).build())
527 final CheckPublishNotificationsOutputBuilder checkPublishNotificationsOutputBuilder =
528 new CheckPublishNotificationsOutputBuilder().setActive(!task.isFinished());
530 if (task.getLastError() != null) {
531 LOG.error("Last error for {}", task, task.getLastError());
532 checkPublishNotificationsOutputBuilder.setLastError(task.getLastError().toString());
535 final CheckPublishNotificationsOutput output =
536 checkPublishNotificationsOutputBuilder.setPublishCount(task.getCurrentNotif()).build();
538 return RpcResultBuilder.success(output).buildFuture();
541 private ListenableFuture<RpcResult<ShutdownShardReplicaOutput>> shutdownShardReplica(
542 final ShutdownShardReplicaInput input) {
543 LOG.info("In shutdownShardReplica - input: {}", input);
545 final String shardName = input.getShardName();
546 if (Strings.isNullOrEmpty(shardName)) {
547 return RpcResultBuilder.<ShutdownShardReplicaOutput>failed()
548 .withError(ErrorType.RPC, ErrorTag.BAD_ELEMENT, shardName + "is not a valid shard name")
552 return shutdownShardGracefully(shardName, new ShutdownShardReplicaOutputBuilder().build());
555 private <T> SettableFuture<RpcResult<T>> shutdownShardGracefully(final String shardName, final T success) {
556 final SettableFuture<RpcResult<T>> rpcResult = SettableFuture.create();
557 final ActorUtils context = configDataStore.getActorUtils();
559 long timeoutInMS = Math.max(context.getDatastoreContext().getShardRaftConfig()
560 .getElectionTimeOutInterval().$times(3).toMillis(), 10000);
561 final FiniteDuration duration = FiniteDuration.apply(timeoutInMS, TimeUnit.MILLISECONDS);
562 final scala.concurrent.Promise<Boolean> shutdownShardAsk = Futures.promise();
564 context.findLocalShardAsync(shardName).onComplete(new OnComplete<ActorRef>() {
566 public void onComplete(final Throwable throwable, final ActorRef actorRef) {
567 if (throwable != null) {
568 shutdownShardAsk.failure(throwable);
570 shutdownShardAsk.completeWith(Patterns.gracefulStop(actorRef, duration, Shutdown.INSTANCE));
573 }, context.getClientDispatcher());
575 shutdownShardAsk.future().onComplete(new OnComplete<Boolean>() {
577 public void onComplete(final Throwable throwable, final Boolean gracefulStopResult) {
578 if (throwable != null) {
579 final RpcResult<T> failedResult = RpcResultBuilder.<T>failed()
580 .withError(ErrorType.APPLICATION, "Failed to gracefully shutdown shard", throwable).build();
581 rpcResult.set(failedResult);
583 // according to Patterns.gracefulStop API, we don't have to
584 // check value of gracefulStopResult
585 rpcResult.set(RpcResultBuilder.success(success).build());
588 }, context.getClientDispatcher());
592 private ListenableFuture<RpcResult<RegisterConstantOutput>> registerConstant(final RegisterConstantInput input) {
593 LOG.info("In registerConstant - input: {}", input);
595 if (input.getConstant() == null) {
596 return RpcResultBuilder.<RegisterConstantOutput>failed()
597 .withError(ErrorType.RPC, ErrorTag.INVALID_VALUE, "Constant value is null")
601 if (globalGetConstantRegistration != null) {
602 return RpcResultBuilder.<RegisterConstantOutput>failed()
603 .withError(ErrorType.RPC, ErrorTag.DATA_EXISTS, "There is already an rpc registered")
607 globalGetConstantRegistration = GetConstantService.registerNew(domRpcService, input.getConstant());
608 return RpcResultBuilder.success(new RegisterConstantOutputBuilder().build()).buildFuture();
611 private ListenableFuture<RpcResult<UnregisterDefaultConstantOutput>> unregisterDefaultConstant(
612 final UnregisterDefaultConstantInput input) {
613 throw new UnsupportedOperationException();
616 @SuppressWarnings("checkstyle:IllegalCatch")
617 private ListenableFuture<RpcResult<UnsubscribeDdtlOutput>> unsubscribeDdtl(final UnsubscribeDdtlInput input) {
618 throw new UnsupportedOperationException();