opendaylight/md-sal/samples/clustering-test-app/provider/src/main/java/org/opendaylight/controller/clustering/it/provider/impl/SingletonGetConstantService.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.impl;
   9
  10 import com.google.common.util.concurrent.Futures;
  11 import com.google.common.util.concurrent.ListenableFuture;
  12 import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
  13 import org.opendaylight.mdsal.dom.api.DOMRpcImplementation;
  14 import org.opendaylight.mdsal.dom.api.DOMRpcProviderService;
  15 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  16 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  17 import org.opendaylight.mdsal.singleton.api.ClusterSingletonService;
  18 import org.opendaylight.mdsal.singleton.api.ClusterSingletonServiceProvider;
  19 import org.opendaylight.mdsal.singleton.api.ServiceGroupIdentifier;
  20 import org.opendaylight.yangtools.concepts.Registration;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.common.QNameModule;
  23 import org.opendaylight.yangtools.yang.common.Revision;
  24 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  25 import org.opendaylight.yangtools.yang.common.YangConstants;
  26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  27 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  28 import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 public final class SingletonGetConstantService implements DOMRpcImplementation, ClusterSingletonService {
  33     private static final Logger LOG = LoggerFactory.getLogger(SingletonGetConstantService.class);
  34
  35     private static final QNameModule MODULE = QNameModule.create(
  36         XMLNamespace.of("tag:opendaylight.org,2017:controller:yang:lowlevel:target"), Revision.of("2017-02-15"))
  37         .intern();
  38     private static final QName OUTPUT = YangConstants.operationOutputQName(MODULE).intern();
  39     private static final QName CONSTANT = QName.create(MODULE, "constant").intern();
  40     private static final QName CONTEXT = QName.create(MODULE, "context").intern();
  41     private static final QName GET_SINGLETON_CONSTANT = QName.create(MODULE, "get-singleton-constant").intern();
  42
  43     private static final ServiceGroupIdentifier SERVICE_GROUP_IDENTIFIER =
  44         new ServiceGroupIdentifier("get-singleton-constant-service");
  45
  46     private final DOMRpcProviderService rpcProviderService;
  47     private final String constant;
  48
  49     private Registration rpcRegistration = null;
  50
  51     private SingletonGetConstantService(final DOMRpcProviderService rpcProviderService, final String constant) {
  52         this.rpcProviderService = rpcProviderService;
  53         this.constant = constant;
  54     }
  55
  56     public static Registration registerNew(final ClusterSingletonServiceProvider singletonService,
  57             final DOMRpcProviderService rpcProviderService, final String constant) {
  58         LOG.debug("Registering get-singleton-constant into ClusterSingletonService, value {}", constant);
  59
  60         return singletonService.registerClusterSingletonService(
  61             new SingletonGetConstantService(rpcProviderService, constant));
  62     }
  63
  64     @Override
  65     public ListenableFuture<DOMRpcResult> invokeRpc(final DOMRpcIdentifier rpc, final ContainerNode input) {
  66         LOG.debug("get-singleton-constant invoked, current value: {}", constant);
  67
  68         return Futures.immediateFuture(new DefaultDOMRpcResult(ImmutableNodes.newContainerBuilder()
  69             .withNodeIdentifier(new NodeIdentifier(OUTPUT))
  70             .withChild(ImmutableNodes.leafNode(CONSTANT, constant))
  71             .build()));
  72     }
  73
  74     @Override
  75     public void instantiateServiceInstance() {
  76         LOG.debug("Gained ownership of get-singleton-constant, registering service into rpcService");
  77         final DOMRpcIdentifier id = DOMRpcIdentifier.create(GET_SINGLETON_CONSTANT);
  78
  79         rpcRegistration = rpcProviderService.registerRpcImplementation(this, id);
  80     }
  81
  82     @Override
  83     public ListenableFuture<Void> closeServiceInstance() {
  84         LOG.debug("Closing get-singleton-constant instance");
  85         rpcRegistration.close();
  86         return Futures.immediateFuture(null);
  87     }
  88
  89     @Override
  90     public ServiceGroupIdentifier getIdentifier() {
  91         return SERVICE_GROUP_IDENTIFIER;
  92     }
  93 }