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