Fixup Augmentable and Identifiable methods changing
[controller.git] / opendaylight / md-sal / samples / clustering-test-app / provider / src / main / java / org / opendaylight / controller / clustering / it / provider / CarProvider.java
index 87aa45c8082cafb0dd8ed75823f0725eae7a38d1..13349d95e325b3b1908951043d0c1912700af59a 100644 (file)
 package org.opendaylight.controller.clustering.it.provider;
 
 import com.google.common.base.Stopwatch;
+import com.google.common.collect.Sets;
+import com.google.common.util.concurrent.FutureCallback;
 import com.google.common.util.concurrent.Futures;
-import java.util.concurrent.Future;
+import com.google.common.util.concurrent.ListenableFuture;
+import com.google.common.util.concurrent.MoreExecutors;
+import java.util.Collection;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
+import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicLong;
+import java.util.concurrent.atomic.AtomicReference;
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
+import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
-import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
-import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
-import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidate;
-import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipService;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
+import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
+import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeCommitCohortRegistry;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistration;
+import org.opendaylight.mdsal.eos.binding.api.Entity;
+import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipChange;
+import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipListener;
+import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipService;
+import org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.CarId;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.CarService;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.Cars;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.CarsBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.RegisterCommitCohortInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.RegisterCommitCohortOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.RegisterCommitCohortOutputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.RegisterLoggingDtclInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.RegisterLoggingDtclOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.RegisterLoggingDtclOutputBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.RegisterOwnershipInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.RegisterOwnershipOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.RegisterOwnershipOutputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.StopStressTestInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.StopStressTestOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.StopStressTestOutputBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.StressTestInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.StressTestOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.StressTestOutputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.UnregisterCommitCohortInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.UnregisterCommitCohortOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.UnregisterCommitCohortOutputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.UnregisterLoggingDtclsInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.UnregisterLoggingDtclsOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.UnregisterLoggingDtclsOutputBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.UnregisterOwnershipInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.UnregisterOwnershipOutput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.UnregisterOwnershipOutputBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.cars.CarEntry;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.cars.CarEntryBuilder;
+import org.opendaylight.yangtools.concepts.ListenerRegistration;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
 import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
+ * Implementation of CarService.
+ *
  * @author Thomas Pantelis
  */
 public class CarProvider implements CarService {
-    private static final Logger log = LoggerFactory.getLogger(PurchaseCarProvider.class);
+    private static final Logger LOG_PURCHASE_CAR = LoggerFactory.getLogger(PurchaseCarProvider.class);
 
-    private final DataBroker dataProvider;
-    private final EntityOwnershipService ownershipService;
-    private static final Logger LOG = LoggerFactory.getLogger(CarProvider.class);
+    private static final Logger LOG_CAR_PROVIDER = LoggerFactory.getLogger(CarProvider.class);
 
     private static final String ENTITY_TYPE = "cars";
+    private static final InstanceIdentifier<Cars> CARS_IID = InstanceIdentifier.builder(Cars.class).build();
+    private static final DataTreeIdentifier<Cars> CARS_DTID = new DataTreeIdentifier<>(
+            LogicalDatastoreType.CONFIGURATION, CARS_IID);
 
+    private final DataBroker dataProvider;
+    private final DOMDataBroker domDataBroker;
+    private final EntityOwnershipService ownershipService;
+    private final AtomicLong succcessCounter = new AtomicLong();
+    private final AtomicLong failureCounter = new AtomicLong();
 
-    private final CarEntityOwnershipCandidate ownershipCandidate = new CarEntityOwnershipCandidate();
+    private final CarEntityOwnershipListener ownershipListener = new CarEntityOwnershipListener();
+    private final AtomicBoolean registeredListener = new AtomicBoolean();
 
+    private final Collection<ListenerRegistration<?>> carsDclRegistrations =
+            Sets.newConcurrentHashSet();
+    private final Collection<ListenerRegistration<CarDataTreeChangeListener>> carsDtclRegistrations =
+            Sets.newConcurrentHashSet();
 
     private volatile Thread testThread;
     private volatile boolean stopThread;
+    private final AtomicReference<DOMDataTreeCommitCohortRegistration<CarEntryDataTreeCommitCohort>> commitCohortReg =
+            new AtomicReference<>();
 
-    public CarProvider(DataBroker dataProvider, EntityOwnershipService ownershipService) {
+    public CarProvider(final DataBroker dataProvider, final EntityOwnershipService ownershipService,
+            final DOMDataBroker domDataBroker) {
         this.dataProvider = dataProvider;
         this.ownershipService = ownershipService;
+        this.domDataBroker = domDataBroker;
+    }
+
+    public void close() {
+        stopThread();
+        closeCommitCohortRegistration();
     }
 
     private void stopThread() {
-        if(testThread != null) {
+        if (testThread != null) {
             stopThread = true;
             testThread.interrupt();
             try {
                 testThread.join();
-            } catch (InterruptedException e) {}
+            } catch (InterruptedException e) {
+                // don't care
+            }
             testThread = null;
         }
     }
 
     @Override
-    public Future<RpcResult<Void>> stressTest(StressTestInput input) {
-        final int inputRate, inputCount;
+    public ListenableFuture<RpcResult<StressTestOutput>> stressTest(final StressTestInput input) {
+        final int inputRate;
+        final long inputCount;
 
         // If rate is not provided, or given as zero, then just return.
-        if ((input.getRate() == null) || (input.getRate() == 0)) {
-            log.info("Exiting stress test as no rate is given.");
-            return Futures.immediateFuture(RpcResultBuilder.<Void>failed()
-                                           .withError(ErrorType.PROTOCOL, "invalid rate")
-                                           .build());
-        } else {
-            inputRate = input.getRate();
+        if (input.getRate() == null || input.getRate() == 0) {
+            LOG_PURCHASE_CAR.info("Exiting stress test as no rate is given.");
+            return Futures.immediateFuture(RpcResultBuilder.<StressTestOutput>failed()
+                    .withError(ErrorType.PROTOCOL, "invalid rate")
+                    .build());
         }
 
+        inputRate = input.getRate();
         if (input.getCount() != null) {
             inputCount = input.getCount();
         } else {
             inputCount = 0;
         }
 
-        log.info("Stress test starting : rate: {} count: {}", inputRate, inputCount);
+        LOG_PURCHASE_CAR.info("Stress test starting : rate: {} count: {}", inputRate, inputCount);
 
         stopThread();
+        // clear counters
+        succcessCounter.set(0);
+        failureCounter.set(0);
 
         WriteTransaction tx = dataProvider.newWriteOnlyTransaction();
-        InstanceIdentifier<Cars> carsId = InstanceIdentifier.<Cars>builder(Cars.class).build();
+        InstanceIdentifier<Cars> carsId = InstanceIdentifier.create(Cars.class);
         tx.merge(LogicalDatastoreType.CONFIGURATION, carsId, new CarsBuilder().build());
         try {
             tx.submit().checkedGet(5, TimeUnit.SECONDS);
         } catch (TransactionCommitFailedException | TimeoutException e) {
-            log.error("Put Cars failed",e);
-            return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
+            LOG_PURCHASE_CAR.error("Put Cars failed",e);
+            return Futures.immediateFuture(RpcResultBuilder.success(new StressTestOutputBuilder().build()).build());
         }
 
         stopThread = false;
         final long sleep = TimeUnit.NANOSECONDS.convert(1000,TimeUnit.MILLISECONDS) / inputRate;
         final Stopwatch sw = Stopwatch.createUnstarted();
-        testThread = new Thread() {
-            @Override
-            public void run() {
-                sw.start();
-                AtomicLong count = new AtomicLong();
-                while(!stopThread) {
-                    long id = count.incrementAndGet();
-                    WriteTransaction tx = dataProvider.newWriteOnlyTransaction();
-                    CarEntry car = new CarEntryBuilder().setId(new CarId("car"+id)).build();
-                    tx.put(LogicalDatastoreType.CONFIGURATION,
-                            InstanceIdentifier.<Cars>builder(Cars.class).child(CarEntry.class, car.getKey()).build(),
-                            car);
-                    tx.submit();
-                    try {
-                        TimeUnit.NANOSECONDS.sleep(sleep);
-                    } catch (InterruptedException e) {
-                        break;
-                    }
+        testThread = new Thread(() -> {
+            sw.start();
+            AtomicLong count = new AtomicLong();
+            while (!stopThread) {
+                long id = count.incrementAndGet();
+                WriteTransaction tx1 = dataProvider.newWriteOnlyTransaction();
+                CarEntry car = new CarEntryBuilder().setId(new CarId("car" + id)).build();
+                tx1.put(LogicalDatastoreType.CONFIGURATION,
+                        InstanceIdentifier.<Cars>builder(Cars.class).child(CarEntry.class, car.key()).build(), car);
+                Futures.addCallback(tx1.submit(), new FutureCallback<Void>() {
 
-                    if((count.get() % 1000) == 0) {
-                        log.info("Cars created {}, time: {}",count.get(),sw.elapsed(TimeUnit.SECONDS));
+                    @Override
+                    public void onSuccess(final Void result) {
+                        // Transaction succeeded
+                        succcessCounter.getAndIncrement();
                     }
 
-                    // Check if a count is specified in input and we have created that many cars.
-                    if ((inputCount != 0) && (count.get() >= inputCount)) {
-                        stopThread = true;
+                    @Override
+                    public void onFailure(final Throwable ex) {
+                        // Transaction failed
+                        failureCounter.getAndIncrement();
+                        LOG_CAR_PROVIDER.error("Put Cars failed", ex);
                     }
+                }, MoreExecutors.directExecutor());
+                try {
+                    TimeUnit.NANOSECONDS.sleep(sleep);
+                } catch (InterruptedException e) {
+                    break;
                 }
 
-                log.info("Stress test thread stopping after creating {} cars.", count.get());
+                if (count.get() % 1000 == 0) {
+                    LOG_PURCHASE_CAR.info("Cars created {}, time: {}", count.get(), sw.elapsed(TimeUnit.SECONDS));
+                }
+
+                // Check if a count is specified in input and we have created that many cars.
+                if (inputCount != 0 && count.get() >= inputCount) {
+                    stopThread = true;
+                }
             }
-        };
+
+            LOG_PURCHASE_CAR.info("Stress test thread stopping after creating {} cars.", count.get());
+        });
         testThread.start();
 
-        return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
+        return Futures.immediateFuture(RpcResultBuilder.success(new StressTestOutputBuilder().build()).build());
     }
 
     @Override
-    public Future<RpcResult<Void>> stopStressTest() {
+    public ListenableFuture<RpcResult<StopStressTestOutput>> stopStressTest(final StopStressTestInput input) {
         stopThread();
-        return Futures.immediateFuture(RpcResultBuilder.<Void>success().build());
+        StopStressTestOutputBuilder stopStressTestOutput;
+        stopStressTestOutput = new StopStressTestOutputBuilder()
+                .setSuccessCount(succcessCounter.longValue())
+                .setFailureCount(failureCounter.longValue());
+
+        final StopStressTestOutput result = stopStressTestOutput.build();
+        LOG_PURCHASE_CAR.info("Executed Stop Stress test; No. of cars created {}; "
+                + "No. of cars failed {}; ", succcessCounter, failureCounter);
+        // clear counters
+        succcessCounter.set(0);
+        failureCounter.set(0);
+        return Futures.immediateFuture(RpcResultBuilder.<StopStressTestOutput>success(result).build());
     }
 
 
     @Override
-    public Future<RpcResult<Void>> registerOwnership(RegisterOwnershipInput input) {
+    public ListenableFuture<RpcResult<RegisterOwnershipOutput>> registerOwnership(final RegisterOwnershipInput input) {
+        if (registeredListener.compareAndSet(false, true)) {
+            ownershipService.registerListener(ENTITY_TYPE, ownershipListener);
+        }
+
         Entity entity = new Entity(ENTITY_TYPE, input.getCarId());
         try {
-            ownershipService.registerCandidate(entity, ownershipCandidate);
+            ownershipService.registerCandidate(entity);
         } catch (CandidateAlreadyRegisteredException e) {
-            return RpcResultBuilder.<Void>failed().withError(ErrorType.APPLICATION,
+            return RpcResultBuilder.<RegisterOwnershipOutput>failed().withError(ErrorType.APPLICATION,
                     "Could not register for car " + input.getCarId(), e).buildFuture();
         }
 
-        return RpcResultBuilder.<Void>success().buildFuture();
+        return RpcResultBuilder.success(new RegisterOwnershipOutputBuilder().build()).buildFuture();
     }
 
     @Override
-    public Future<RpcResult<Void>> unregisterOwnership(UnregisterOwnershipInput input) {
-        return RpcResultBuilder.<Void>success().buildFuture();
+    public ListenableFuture<RpcResult<UnregisterOwnershipOutput>> unregisterOwnership(
+            final UnregisterOwnershipInput input) {
+        return RpcResultBuilder.success(new UnregisterOwnershipOutputBuilder().build()).buildFuture();
     }
 
-    private static class CarEntityOwnershipCandidate implements EntityOwnershipCandidate {
+    private static class CarEntityOwnershipListener implements EntityOwnershipListener {
         @Override
-        public void ownershipChanged(Entity entity, boolean wasOwner, boolean isOwner) {
-            LOG.info("ownershipChanged: entity: {}, wasOwner: {}, isOwner: ()", entity, wasOwner, isOwner);
+        public void ownershipChanged(final EntityOwnershipChange ownershipChange) {
+            LOG_CAR_PROVIDER.info("ownershipChanged: {}", ownershipChange);
+        }
+    }
+
+    @Override
+    public ListenableFuture<RpcResult<RegisterLoggingDtclOutput>> registerLoggingDtcl(
+            final RegisterLoggingDtclInput input) {
+        LOG_CAR_PROVIDER.info("Registering a new CarDataTreeChangeListener");
+        final ListenerRegistration<CarDataTreeChangeListener> carsDtclRegistration =
+                dataProvider.registerDataTreeChangeListener(CARS_DTID, new CarDataTreeChangeListener());
+
+        carsDtclRegistrations.add(carsDtclRegistration);
+        return RpcResultBuilder.success(new RegisterLoggingDtclOutputBuilder().build()).buildFuture();
+    }
+
+    @Override
+    public ListenableFuture<RpcResult<UnregisterLoggingDtclsOutput>> unregisterLoggingDtcls(
+            final UnregisterLoggingDtclsInput input) {
+        LOG_CAR_PROVIDER.info("Unregistering the CarDataTreeChangeListener(s)");
+        synchronized (carsDtclRegistrations) {
+            int numListeners = 0;
+            for (ListenerRegistration<CarDataTreeChangeListener> carsDtclRegistration : carsDtclRegistrations) {
+                carsDtclRegistration.close();
+                numListeners++;
+            }
+            carsDtclRegistrations.clear();
+            LOG_CAR_PROVIDER.info("Unregistered {} CaraDataTreeChangeListener(s)", numListeners);
+        }
+        return RpcResultBuilder.success(new UnregisterLoggingDtclsOutputBuilder().build()).buildFuture();
+    }
+
+    @Override
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    public ListenableFuture<RpcResult<UnregisterCommitCohortOutput>> unregisterCommitCohort(
+            final UnregisterCommitCohortInput input) {
+        closeCommitCohortRegistration();
+
+        return RpcResultBuilder.success(new UnregisterCommitCohortOutputBuilder().build()).buildFuture();
+    }
+
+    private void closeCommitCohortRegistration() {
+        final DOMDataTreeCommitCohortRegistration<CarEntryDataTreeCommitCohort> reg = commitCohortReg.getAndSet(null);
+        if (reg != null) {
+            reg.close();
+            LOG_CAR_PROVIDER.info("Unregistered commit cohort");
+        }
+    }
+
+    @Override
+    public synchronized ListenableFuture<RpcResult<RegisterCommitCohortOutput>> registerCommitCohort(
+            final RegisterCommitCohortInput input) {
+        if (commitCohortReg.get() != null) {
+            return RpcResultBuilder.success(new RegisterCommitCohortOutputBuilder().build()).buildFuture();
         }
+
+        final DOMDataTreeCommitCohortRegistry commitCohortRegistry = (DOMDataTreeCommitCohortRegistry)
+                domDataBroker.getSupportedExtensions().get(DOMDataTreeCommitCohortRegistry.class);
+
+        if (commitCohortRegistry == null) {
+            // Shouldn't happen
+            return RpcResultBuilder.<RegisterCommitCohortOutput>failed().withError(ErrorType.APPLICATION,
+                    "DOMDataTreeCommitCohortRegistry not found").buildFuture();
+        }
+
+        // Note: it may look strange that we specify the CarEntry.QNAME twice in the path below. This must be done in
+        // order to register the commit cohort for CarEntry instances. In the underlying data tree, a yang list is
+        // represented as a MapNode with MapEntryNodes representing the child list entries. Therefore, in order to
+        // address a list entry, you must specify the path argument for the MapNode and the path argument for the
+        // MapEntryNode. In the path below, the first CarEntry.QNAME argument addresses the MapNode and, since we want
+        // to address all list entries, the second path argument is wild-carded by specifying just the CarEntry.QNAME.
+        final YangInstanceIdentifier carEntryPath = YangInstanceIdentifier.builder(
+                YangInstanceIdentifier.of(Cars.QNAME)).node(CarEntry.QNAME).node(CarEntry.QNAME).build();
+        commitCohortReg.set(commitCohortRegistry.registerCommitCohort(
+                new org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier(
+                    org.opendaylight.mdsal.common.api.LogicalDatastoreType.CONFIGURATION,
+                        carEntryPath), new CarEntryDataTreeCommitCohort()));
+
+        LOG_CAR_PROVIDER.info("Registered commit cohort");
+
+        return RpcResultBuilder.success(new RegisterCommitCohortOutputBuilder().build()).buildFuture();
     }
 }