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