opendaylight/md-sal/samples/clustering-test-app/provider/src/main/java/org/opendaylight/controller/clustering/it/provider/MdsalLowLevelTestProvider.java

   1 /*
   2  * Copyright (c) 2017 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.clustering.it.provider;
   9
  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.util.concurrent.ListenableFuture;
  16 import com.google.common.util.concurrent.SettableFuture;
  17 import java.util.HashMap;
  18 import java.util.Map;
  19 import java.util.Optional;
  20 import java.util.concurrent.ExecutionException;
  21 import java.util.concurrent.TimeUnit;
  22 import java.util.concurrent.TimeoutException;
  23 import javax.annotation.PreDestroy;
  24 import javax.inject.Inject;
  25 import javax.inject.Singleton;
  26 import org.opendaylight.controller.cluster.datastore.DistributedDataStoreInterface;
  27 import org.opendaylight.controller.cluster.datastore.utils.ActorUtils;
  28 import org.opendaylight.controller.cluster.raft.client.messages.Shutdown;
  29 import org.opendaylight.controller.clustering.it.provider.impl.FlappingSingletonService;
  30 import org.opendaylight.controller.clustering.it.provider.impl.GetConstantService;
  31 import org.opendaylight.controller.clustering.it.provider.impl.IdIntsListener;
  32 import org.opendaylight.controller.clustering.it.provider.impl.PublishNotificationsTask;
  33 import org.opendaylight.controller.clustering.it.provider.impl.RoutedGetConstantService;
  34 import org.opendaylight.controller.clustering.it.provider.impl.SingletonGetConstantService;
  35 import org.opendaylight.controller.clustering.it.provider.impl.WriteTransactionsHandler;
  36 import org.opendaylight.controller.clustering.it.provider.impl.YnlListener;
  37 import org.opendaylight.mdsal.binding.api.NotificationPublishService;
  38 import org.opendaylight.mdsal.binding.api.NotificationService;
  39 import org.opendaylight.mdsal.binding.api.RpcProviderService;
  40 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  41 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  42 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  43 import org.opendaylight.mdsal.dom.api.DOMDataBroker.DataTreeChangeExtension;
  44 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  45 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
  46 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
  47 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  48 import org.opendaylight.mdsal.singleton.api.ClusterSingletonServiceProvider;
  49 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.AddShardReplica;
  50 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.AddShardReplicaInput;
  51 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.AddShardReplicaOutput;
  52 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.CheckPublishNotifications;
  53 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.CheckPublishNotificationsInput;
  54 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.CheckPublishNotificationsOutput;
  55 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.CheckPublishNotificationsOutputBuilder;
  56 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.IsClientAborted;
  57 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.IsClientAbortedInput;
  58 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.IsClientAbortedOutput;
  59 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterBoundConstant;
  60 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterBoundConstantInput;
  61 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterBoundConstantOutput;
  62 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterBoundConstantOutputBuilder;
  63 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterConstant;
  64 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterConstantInput;
  65 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterConstantOutput;
  66 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterConstantOutputBuilder;
  67 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterDefaultConstant;
  68 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterDefaultConstantInput;
  69 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterDefaultConstantOutput;
  70 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterFlappingSingleton;
  71 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterFlappingSingletonInput;
  72 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterFlappingSingletonOutput;
  73 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterFlappingSingletonOutputBuilder;
  74 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterSingletonConstant;
  75 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterSingletonConstantInput;
  76 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterSingletonConstantOutput;
  77 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RegisterSingletonConstantOutputBuilder;
  78 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RemoveShardReplica;
  79 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RemoveShardReplicaInput;
  80 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.RemoveShardReplicaOutput;
  81 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.ShutdownShardReplica;
  82 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.ShutdownShardReplicaInput;
  83 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.ShutdownShardReplicaOutput;
  84 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.ShutdownShardReplicaOutputBuilder;
  85 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.StartPublishNotifications;
  86 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.StartPublishNotificationsInput;
  87 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.StartPublishNotificationsOutput;
  88 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.StartPublishNotificationsOutputBuilder;
  89 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeDdtl;
  90 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeDdtlInput;
  91 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeDdtlOutput;
  92 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeDtcl;
  93 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeDtclInput;
  94 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeDtclOutput;
  95 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeDtclOutputBuilder;
  96 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeYnl;
  97 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeYnlInput;
  98 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeYnlOutput;
  99 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.SubscribeYnlOutputBuilder;
 100 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterBoundConstant;
 101 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterBoundConstantInput;
 102 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterBoundConstantOutput;
 103 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterBoundConstantOutputBuilder;
 104 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterConstant;
 105 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterConstantInput;
 106 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterConstantOutput;
 107 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterConstantOutputBuilder;
 108 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterDefaultConstant;
 109 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterDefaultConstantInput;
 110 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterDefaultConstantOutput;
 111 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterFlappingSingleton;
 112 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterFlappingSingletonInput;
 113 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterFlappingSingletonOutput;
 114 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterFlappingSingletonOutputBuilder;
 115 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterSingletonConstant;
 116 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterSingletonConstantInput;
 117 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterSingletonConstantOutput;
 118 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnregisterSingletonConstantOutputBuilder;
 119 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDdtl;
 120 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDdtlInput;
 121 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDdtlOutput;
 122 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDtcl;
 123 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDtclInput;
 124 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDtclOutput;
 125 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeDtclOutputBuilder;
 126 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeYnl;
 127 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeYnlInput;
 128 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.UnsubscribeYnlOutput;
 129 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactions;
 130 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsInput;
 131 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.control.rev170215.WriteTransactionsOutput;
 132 import org.opendaylight.yang.gen.v1.tag.opendaylight.org._2017.controller.yang.lowlevel.target.rev170215.IdSequence;
 133 import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
 134 import org.opendaylight.yangtools.concepts.ObjectRegistration;
 135 import org.opendaylight.yangtools.concepts.Registration;
 136 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 137 import org.opendaylight.yangtools.yang.common.ErrorTag;
 138 import org.opendaylight.yangtools.yang.common.ErrorType;
 139 import org.opendaylight.yangtools.yang.common.RpcResult;
 140 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
 141 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 142 import org.osgi.service.component.annotations.Activate;
 143 import org.osgi.service.component.annotations.Component;
 144 import org.osgi.service.component.annotations.Deactivate;
 145 import org.osgi.service.component.annotations.Reference;
 146 import org.slf4j.Logger;
 147 import org.slf4j.LoggerFactory;
 148 import scala.concurrent.duration.FiniteDuration;
 149
 150 @Singleton
 151 @Component(service = {})
 152 public final class MdsalLowLevelTestProvider {
 153     private static final Logger LOG = LoggerFactory.getLogger(MdsalLowLevelTestProvider.class);
 154
 155     private final Registration registration;
 156     private final DistributedDataStoreInterface configDataStore;
 157     private final BindingNormalizedNodeSerializer bindingNormalizedNodeSerializer;
 158     private final DOMDataBroker domDataBroker;
 159     private final NotificationPublishService notificationPublishService;
 160     private final NotificationService notificationService;
 161     private final ClusterSingletonServiceProvider singletonService;
 162     private final DOMRpcProviderService domRpcService;
 163     private final DataTreeChangeExtension dataTreeChangeExtension;
 164
 165     private final Map<InstanceIdentifier<?>, Registration> routedRegistrations = new HashMap<>();
 166     private final Map<String, ObjectRegistration<YnlListener>> ynlRegistrations = new HashMap<>();
 167     private final Map<String, PublishNotificationsTask> publishNotificationsTasks = new HashMap<>();
 168
 169     private Registration globalGetConstantRegistration = null;
 170     private Registration getSingletonConstantRegistration;
 171     private FlappingSingletonService flappingSingletonService;
 172     private Registration dtclReg;
 173     private IdIntsListener idIntsListener;
 174
 175     @Inject
 176     @Activate
 177     public MdsalLowLevelTestProvider(
 178             @Reference final RpcProviderService rpcRegistry,
 179             @Reference final DOMRpcProviderService domRpcService,
 180             @Reference final ClusterSingletonServiceProvider singletonService,
 181             @Reference final DOMSchemaService schemaService,
 182             @Reference final BindingNormalizedNodeSerializer bindingNormalizedNodeSerializer,
 183             @Reference final NotificationPublishService notificationPublishService,
 184             @Reference final NotificationService notificationService,
 185             @Reference final DOMDataBroker domDataBroker,
 186             @Reference final DistributedDataStoreInterface configDataStore) {
 187         this.domRpcService = domRpcService;
 188         this.singletonService = singletonService;
 189         this.bindingNormalizedNodeSerializer = bindingNormalizedNodeSerializer;
 190         this.notificationPublishService = notificationPublishService;
 191         this.notificationService = notificationService;
 192         this.domDataBroker = domDataBroker;
 193         this.configDataStore = configDataStore;
 194
 195         dataTreeChangeExtension = domDataBroker.extension(DataTreeChangeExtension.class);
 196
 197         registration = rpcRegistry.registerRpcImplementations(
 198             (UnregisterSingletonConstant) this::unregisterSingletonConstant,
 199             (StartPublishNotifications) this::startPublishNotifications,
 200             (SubscribeDdtl) this::subscribeDdtl,
 201             (WriteTransactions) this::writeTransactions,
 202             (IsClientAborted) this::isClientAborted,
 203             (RemoveShardReplica) this::removeShardReplica,
 204             (SubscribeYnl) this::subscribeYnl,
 205             (UnregisterBoundConstant) this::unregisterBoundConstant,
 206             (RegisterSingletonConstant) this::registerSingletonConstant,
 207             (RegisterDefaultConstant) this::registerDefaultConstant,
 208             (UnregisterConstant) this::unregisterConstant,
 209             (UnregisterFlappingSingleton) this::unregisterFlappingSingleton,
 210             (AddShardReplica) this::addShardReplica,
 211             (RegisterBoundConstant) this::registerBoundConstant,
 212             (RegisterFlappingSingleton) this::registerFlappingSingleton,
 213             (UnsubscribeDdtl) this::unsubscribeDdtl,
 214             (UnsubscribeYnl) this::unsubscribeYnl,
 215             (CheckPublishNotifications) this::checkPublishNotifications,
 216             (ShutdownShardReplica) this::shutdownShardReplica,
 217             (RegisterConstant) this::registerConstant,
 218             (UnregisterDefaultConstant) this::unregisterDefaultConstant,
 219             (SubscribeDtcl) this::subscribeDtcl,
 220             (UnsubscribeDtcl) this::unsubscribeDtcl);
 221     }
 222
 223     @PreDestroy
 224     @Deactivate
 225     public void close() {
 226         registration.close();
 227     }
 228
 229     @SuppressWarnings("checkstyle:IllegalCatch")
 230     private ListenableFuture<RpcResult<UnregisterSingletonConstantOutput>> unregisterSingletonConstant(
 231             final UnregisterSingletonConstantInput input) {
 232         LOG.info("In unregisterSingletonConstant");
 233
 234         if (getSingletonConstantRegistration == null) {
 235             return RpcResultBuilder.<UnregisterSingletonConstantOutput>failed()
 236                 .withError(ErrorType.RPC, ErrorTag.DATA_MISSING, "No prior RPC was registered")
 237                 .buildFuture();
 238         }
 239
 240         try {
 241             getSingletonConstantRegistration.close();
 242             getSingletonConstantRegistration = null;
 243
 244             return RpcResultBuilder.success(new UnregisterSingletonConstantOutputBuilder().build()).buildFuture();
 245         } catch (Exception e) {
 246             String msg = "Error closing the singleton constant service";
 247             LOG.error(msg, e);
 248             return RpcResultBuilder.<UnregisterSingletonConstantOutput>failed().withError(
 249                     ErrorType.APPLICATION, msg, e).buildFuture();
 250         }
 251     }
 252
 253     private ListenableFuture<RpcResult<StartPublishNotificationsOutput>> startPublishNotifications(
 254             final StartPublishNotificationsInput input) {
 255         LOG.info("In startPublishNotifications - input: {}", input);
 256
 257         final PublishNotificationsTask task = new PublishNotificationsTask(notificationPublishService, input.getId(),
 258                 input.getSeconds().toJava(), input.getNotificationsPerSecond().toJava());
 259
 260         publishNotificationsTasks.put(input.getId(), task);
 261
 262         task.start();
 263
 264         return RpcResultBuilder.success(new StartPublishNotificationsOutputBuilder().build()).buildFuture();
 265     }
 266
 267     private ListenableFuture<RpcResult<SubscribeDtclOutput>> subscribeDtcl(final SubscribeDtclInput input) {
 268         LOG.info("In subscribeDtcl - input: {}", input);
 269
 270         if (dtclReg != null) {
 271             return RpcResultBuilder.<SubscribeDtclOutput>failed().withError(ErrorType.RPC, ErrorTag.DATA_EXISTS,
 272                 "There is already a DataTreeChangeListener registered for id-ints")
 273                 .buildFuture();
 274         }
 275
 276         idIntsListener = new IdIntsListener();
 277
 278         dtclReg = dataTreeChangeExtension.registerTreeChangeListener(
 279             DOMDataTreeIdentifier.of(LogicalDatastoreType.CONFIGURATION, WriteTransactionsHandler.ID_INT_YID),
 280             idIntsListener);
 281
 282         return RpcResultBuilder.success(new SubscribeDtclOutputBuilder().build()).buildFuture();
 283     }
 284
 285     private ListenableFuture<RpcResult<WriteTransactionsOutput>> writeTransactions(final WriteTransactionsInput input) {
 286         return WriteTransactionsHandler.start(domDataBroker, input);
 287     }
 288
 289     private ListenableFuture<RpcResult<IsClientAbortedOutput>> isClientAborted(final IsClientAbortedInput input) {
 290         return null;
 291     }
 292
 293     private ListenableFuture<RpcResult<RemoveShardReplicaOutput>> removeShardReplica(
 294             final RemoveShardReplicaInput input) {
 295         return null;
 296     }
 297
 298     private ListenableFuture<RpcResult<SubscribeYnlOutput>> subscribeYnl(final SubscribeYnlInput input) {
 299         LOG.info("In subscribeYnl - input: {}", input);
 300
 301         if (ynlRegistrations.containsKey(input.getId())) {
 302             return RpcResultBuilder.<SubscribeYnlOutput>failed()
 303                 .withError(ErrorType.RPC, ErrorTag.DATA_EXISTS,
 304                     "There is already a listener registered for id: " + input.getId())
 305                 .buildFuture();
 306         }
 307
 308         final var id = input.getId();
 309         final var listener = new YnlListener(id);
 310         final var reg = notificationService.registerListener(IdSequence.class, listener);
 311         ynlRegistrations.put(id, new AbstractObjectRegistration<>(listener) {
 312             @Override
 313             protected void removeRegistration() {
 314                 reg.close();
 315             }
 316         });
 317
 318         return RpcResultBuilder.success(new SubscribeYnlOutputBuilder().build()).buildFuture();
 319     }
 320
 321
 322     private ListenableFuture<RpcResult<UnregisterBoundConstantOutput>> unregisterBoundConstant(
 323             final UnregisterBoundConstantInput input) {
 324         LOG.info("In unregisterBoundConstant - {}", input);
 325
 326         final var rpcRegistration = routedRegistrations.remove(input.getContext());
 327         if (rpcRegistration == null) {
 328             return RpcResultBuilder.<UnregisterBoundConstantOutput>failed()
 329                 .withError(ErrorType.RPC, ErrorTag.DATA_MISSING,
 330                     "No prior RPC was registered for " + input.getContext())
 331                 .buildFuture();
 332         }
 333
 334         rpcRegistration.close();
 335         return RpcResultBuilder.success(new UnregisterBoundConstantOutputBuilder().build()).buildFuture();
 336     }
 337
 338     private ListenableFuture<RpcResult<RegisterSingletonConstantOutput>> registerSingletonConstant(
 339             final RegisterSingletonConstantInput input) {
 340         LOG.info("In registerSingletonConstant - input: {}", input);
 341
 342         if (input.getConstant() == null) {
 343             return RpcResultBuilder.<RegisterSingletonConstantOutput>failed()
 344                 .withError(ErrorType.RPC, ErrorTag.INVALID_VALUE, "Constant value is null")
 345                 .buildFuture();
 346         }
 347
 348         getSingletonConstantRegistration =
 349                 SingletonGetConstantService.registerNew(singletonService, domRpcService, input.getConstant());
 350
 351         return RpcResultBuilder.success(new RegisterSingletonConstantOutputBuilder().build()).buildFuture();
 352     }
 353
 354     private ListenableFuture<RpcResult<RegisterDefaultConstantOutput>> registerDefaultConstant(
 355             final RegisterDefaultConstantInput input) {
 356         return null;
 357     }
 358
 359     private ListenableFuture<RpcResult<UnregisterConstantOutput>> unregisterConstant(
 360             final UnregisterConstantInput input) {
 361         LOG.info("In unregisterConstant");
 362
 363         if (globalGetConstantRegistration == null) {
 364             return RpcResultBuilder.<UnregisterConstantOutput>failed()
 365                 .withError(ErrorType.RPC, ErrorTag.DATA_MISSING, "No prior RPC was registered")
 366                 .buildFuture();
 367         }
 368
 369         globalGetConstantRegistration.close();
 370         globalGetConstantRegistration = null;
 371
 372         return RpcResultBuilder.success(new UnregisterConstantOutputBuilder().build()).buildFuture();
 373     }
 374
 375     private ListenableFuture<RpcResult<UnregisterFlappingSingletonOutput>> unregisterFlappingSingleton(
 376             final UnregisterFlappingSingletonInput input) {
 377         LOG.info("In unregisterFlappingSingleton");
 378
 379         if (flappingSingletonService == null) {
 380             return RpcResultBuilder.<UnregisterFlappingSingletonOutput>failed()
 381                 .withError(ErrorType.RPC, ErrorTag.DATA_MISSING, "No prior RPC was registered")
 382                 .buildFuture();
 383         }
 384
 385         final long flapCount = flappingSingletonService.setInactive();
 386         flappingSingletonService = null;
 387
 388         return RpcResultBuilder.success(new UnregisterFlappingSingletonOutputBuilder().setFlapCount(flapCount).build())
 389                 .buildFuture();
 390     }
 391
 392     private ListenableFuture<RpcResult<AddShardReplicaOutput>> addShardReplica(final AddShardReplicaInput input) {
 393         throw new UnsupportedOperationException();
 394     }
 395
 396     private ListenableFuture<RpcResult<SubscribeDdtlOutput>> subscribeDdtl(final SubscribeDdtlInput input) {
 397         throw new UnsupportedOperationException();
 398     }
 399
 400     private ListenableFuture<RpcResult<RegisterBoundConstantOutput>> registerBoundConstant(
 401             final RegisterBoundConstantInput input) {
 402         LOG.info("In registerBoundConstant - input: {}", input);
 403
 404         if (input.getContext() == null) {
 405             return RpcResultBuilder.<RegisterBoundConstantOutput>failed().withError(
 406                     ErrorType.RPC, ErrorTag.INVALID_VALUE, "Context value is null").buildFuture();
 407         }
 408
 409         if (input.getConstant() == null) {
 410             return RpcResultBuilder.<RegisterBoundConstantOutput>failed().withError(
 411                     ErrorType.RPC, ErrorTag.INVALID_VALUE, "Constant value is null").buildFuture();
 412         }
 413
 414         if (routedRegistrations.containsKey(input.getContext())) {
 415             return RpcResultBuilder.<RegisterBoundConstantOutput>failed().withError(ErrorType.RPC,
 416                 ErrorTag.DATA_EXISTS, "There is already an rpc registered for context: " + input.getContext())
 417                 .buildFuture();
 418         }
 419
 420         final var rpcRegistration = RoutedGetConstantService.registerNew(bindingNormalizedNodeSerializer, domRpcService,
 421             input.getConstant(), input.getContext());
 422
 423         routedRegistrations.put(input.getContext(), rpcRegistration);
 424         return RpcResultBuilder.success(new RegisterBoundConstantOutputBuilder().build()).buildFuture();
 425     }
 426
 427     private ListenableFuture<RpcResult<RegisterFlappingSingletonOutput>> registerFlappingSingleton(
 428             final RegisterFlappingSingletonInput input) {
 429         LOG.info("In registerFlappingSingleton");
 430
 431         if (flappingSingletonService != null) {
 432             return RpcResultBuilder.<RegisterFlappingSingletonOutput>failed()
 433                 .withError(ErrorType.RPC, ErrorTag.DATA_EXISTS, "There is already an rpc registered")
 434                 .buildFuture();
 435         }
 436
 437         flappingSingletonService = new FlappingSingletonService(singletonService);
 438
 439         return RpcResultBuilder.success(new RegisterFlappingSingletonOutputBuilder().build()).buildFuture();
 440     }
 441
 442     private ListenableFuture<RpcResult<UnsubscribeDtclOutput>> unsubscribeDtcl(final UnsubscribeDtclInput input) {
 443         LOG.info("In unsubscribeDtcl");
 444
 445         if (idIntsListener == null || dtclReg == null) {
 446             return RpcResultBuilder.<UnsubscribeDtclOutput>failed()
 447                 .withError(ErrorType.RPC, ErrorTag.DATA_MISSING, "No prior listener was registered")
 448                 .buildFuture();
 449         }
 450
 451         long timeout = 120L;
 452         try {
 453             idIntsListener.tryFinishProcessing().get(timeout, TimeUnit.SECONDS);
 454         } catch (InterruptedException | ExecutionException | TimeoutException e) {
 455             LOG.error("Unable to finish notification processing", e);
 456             return RpcResultBuilder.<UnsubscribeDtclOutput>failed().withError(ErrorType.APPLICATION,
 457                     "Unable to finish notification processing in " + timeout + " seconds", e).buildFuture();
 458         }
 459
 460         dtclReg.close();
 461         dtclReg = null;
 462
 463         if (!idIntsListener.hasTriggered()) {
 464             return RpcResultBuilder.<UnsubscribeDtclOutput>failed()
 465                 .withError(ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED,
 466                     "id-ints listener has not received any notifications.")
 467                 .buildFuture();
 468         }
 469
 470         try (DOMDataTreeReadTransaction rTx = domDataBroker.newReadOnlyTransaction()) {
 471             final Optional<NormalizedNode> readResult = rTx.read(LogicalDatastoreType.CONFIGURATION,
 472                 WriteTransactionsHandler.ID_INT_YID).get();
 473
 474             if (!readResult.isPresent()) {
 475                 return RpcResultBuilder.<UnsubscribeDtclOutput>failed()
 476                     .withError(ErrorType.APPLICATION, ErrorTag.DATA_MISSING, "No data read from id-ints list")
 477                     .buildFuture();
 478             }
 479
 480             final boolean nodesEqual = idIntsListener.checkEqual(readResult.orElseThrow());
 481             if (!nodesEqual) {
 482                 LOG.error("Final read of id-int does not match IdIntsListener's copy. {}",
 483                         idIntsListener.diffWithLocalCopy(readResult.orElseThrow()));
 484             }
 485
 486             return RpcResultBuilder.success(new UnsubscribeDtclOutputBuilder().setCopyMatches(nodesEqual).build())
 487                     .buildFuture();
 488
 489         } catch (final InterruptedException | ExecutionException e) {
 490             LOG.error("Final read of id-ints failed", e);
 491             return RpcResultBuilder.<UnsubscribeDtclOutput>failed().withError(ErrorType.APPLICATION,
 492                     "Final read of id-ints failed", e).buildFuture();
 493         }
 494     }
 495
 496     private ListenableFuture<RpcResult<UnsubscribeYnlOutput>> unsubscribeYnl(final UnsubscribeYnlInput input) {
 497         LOG.info("In unsubscribeYnl - input: {}", input);
 498
 499         if (!ynlRegistrations.containsKey(input.getId())) {
 500             return RpcResultBuilder.<UnsubscribeYnlOutput>failed()
 501                 .withError(ErrorType.RPC, ErrorTag.DATA_MISSING,
 502                     "No prior listener was registered for " + input.getId())
 503                 .buildFuture();
 504         }
 505
 506         try (var reg = ynlRegistrations.remove(input.getId())) {
 507             return RpcResultBuilder.<UnsubscribeYnlOutput>success()
 508                 .withResult(reg.getInstance().getOutput())
 509                 .buildFuture();
 510         }
 511     }
 512
 513     private ListenableFuture<RpcResult<CheckPublishNotificationsOutput>> checkPublishNotifications(
 514             final CheckPublishNotificationsInput input) {
 515         LOG.info("In checkPublishNotifications - input: {}", input);
 516
 517         final PublishNotificationsTask task = publishNotificationsTasks.get(input.getId());
 518
 519         if (task == null) {
 520             return RpcResultBuilder.success(new CheckPublishNotificationsOutputBuilder().setActive(false).build())
 521                 .buildFuture();
 522         }
 523
 524         final CheckPublishNotificationsOutputBuilder checkPublishNotificationsOutputBuilder =
 525                 new CheckPublishNotificationsOutputBuilder().setActive(!task.isFinished());
 526
 527         if (task.getLastError() != null) {
 528             LOG.error("Last error for {}", task, task.getLastError());
 529             checkPublishNotificationsOutputBuilder.setLastError(task.getLastError().toString());
 530         }
 531
 532         final CheckPublishNotificationsOutput output =
 533                 checkPublishNotificationsOutputBuilder.setPublishCount(task.getCurrentNotif()).build();
 534
 535         return RpcResultBuilder.success(output).buildFuture();
 536     }
 537
 538     private ListenableFuture<RpcResult<ShutdownShardReplicaOutput>> shutdownShardReplica(
 539             final ShutdownShardReplicaInput input) {
 540         LOG.info("In shutdownShardReplica - input: {}", input);
 541
 542         final String shardName = input.getShardName();
 543         if (Strings.isNullOrEmpty(shardName)) {
 544             return RpcResultBuilder.<ShutdownShardReplicaOutput>failed()
 545                 .withError(ErrorType.RPC, ErrorTag.BAD_ELEMENT, shardName + "is not a valid shard name")
 546                 .buildFuture();
 547         }
 548
 549         return shutdownShardGracefully(shardName, new ShutdownShardReplicaOutputBuilder().build());
 550     }
 551
 552     private <T> SettableFuture<RpcResult<T>> shutdownShardGracefully(final String shardName, final T success) {
 553         final SettableFuture<RpcResult<T>> rpcResult = SettableFuture.create();
 554         final ActorUtils context = configDataStore.getActorUtils();
 555
 556         long timeoutInMS = Math.max(context.getDatastoreContext().getShardRaftConfig()
 557                 .getElectionTimeOutInterval().$times(3).toMillis(), 10000);
 558         final FiniteDuration duration = FiniteDuration.apply(timeoutInMS, TimeUnit.MILLISECONDS);
 559         final scala.concurrent.Promise<Boolean> shutdownShardAsk = Futures.promise();
 560
 561         context.findLocalShardAsync(shardName).onComplete(new OnComplete<ActorRef>() {
 562             @Override
 563             public void onComplete(final Throwable throwable, final ActorRef actorRef) {
 564                 if (throwable != null) {
 565                     shutdownShardAsk.failure(throwable);
 566                 } else {
 567                     shutdownShardAsk.completeWith(Patterns.gracefulStop(actorRef, duration, Shutdown.INSTANCE));
 568                 }
 569             }
 570         }, context.getClientDispatcher());
 571
 572         shutdownShardAsk.future().onComplete(new OnComplete<Boolean>() {
 573             @Override
 574             public void onComplete(final Throwable throwable, final Boolean gracefulStopResult) {
 575                 if (throwable != null) {
 576                     final RpcResult<T> failedResult = RpcResultBuilder.<T>failed()
 577                             .withError(ErrorType.APPLICATION, "Failed to gracefully shutdown shard", throwable).build();
 578                     rpcResult.set(failedResult);
 579                 } else {
 580                     // according to Patterns.gracefulStop API, we don't have to
 581                     // check value of gracefulStopResult
 582                     rpcResult.set(RpcResultBuilder.success(success).build());
 583                 }
 584             }
 585         }, context.getClientDispatcher());
 586         return rpcResult;
 587     }
 588
 589     private ListenableFuture<RpcResult<RegisterConstantOutput>> registerConstant(final RegisterConstantInput input) {
 590         LOG.info("In registerConstant - input: {}", input);
 591
 592         if (input.getConstant() == null) {
 593             return RpcResultBuilder.<RegisterConstantOutput>failed()
 594                 .withError(ErrorType.RPC, ErrorTag.INVALID_VALUE, "Constant value is null")
 595                 .buildFuture();
 596         }
 597
 598         if (globalGetConstantRegistration != null) {
 599             return RpcResultBuilder.<RegisterConstantOutput>failed()
 600                 .withError(ErrorType.RPC, ErrorTag.DATA_EXISTS, "There is already an rpc registered")
 601                 .buildFuture();
 602         }
 603
 604         globalGetConstantRegistration = GetConstantService.registerNew(domRpcService, input.getConstant());
 605         return RpcResultBuilder.success(new RegisterConstantOutputBuilder().build()).buildFuture();
 606     }
 607
 608     private ListenableFuture<RpcResult<UnregisterDefaultConstantOutput>> unregisterDefaultConstant(
 609             final UnregisterDefaultConstantInput input) {
 610         throw new UnsupportedOperationException();
 611     }
 612
 613     @SuppressWarnings("checkstyle:IllegalCatch")
 614     private ListenableFuture<RpcResult<UnsubscribeDdtlOutput>> unsubscribeDdtl(final UnsubscribeDdtlInput input) {
 615         throw new UnsupportedOperationException();
 616     }
 617 }