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