opendaylight/md-sal/samples/clustering-test-app/provider/src/main/java/org/opendaylight/controller/clustering/it/provider/CarEntryDataTreeCommitCohort.java

   1 /*
   2  * Copyright (c) 2017 Brocade Communications 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 com.google.common.base.Verify;
  11 import com.google.common.util.concurrent.FluentFuture;
  12 import java.util.Collection;
  13 import java.util.Optional;
  14 import org.opendaylight.mdsal.common.api.DataValidationFailedException;
  15 import org.opendaylight.mdsal.common.api.PostCanCommitStep;
  16 import org.opendaylight.mdsal.dom.api.DOMDataTreeCandidate;
  17 import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohort;
  18 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.config.sal.clustering.it.car.rev140818.Cars;
  20 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  23 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  24 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  25 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  26 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateNode;
  27 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  28 import org.slf4j.Logger;
  29 import org.slf4j.LoggerFactory;
  30
  31 /**
  32  * Example implementation of a DOMDataTreeCommitCohort that validates car entry data.
  33  *
  34  * @author Thomas Pantelis
  35  */
  36 public final class CarEntryDataTreeCommitCohort implements DOMDataTreeCommitCohort {
  37     private static final Logger LOG = LoggerFactory.getLogger(CarEntryDataTreeCommitCohort.class);
  38
  39     private static final QName YEAR_QNAME = QName.create(Cars.QNAME, "year").intern();
  40     private static final NodeIdentifier YEAR_NODE_ID = new NodeIdentifier(YEAR_QNAME);
  41
  42     @Override
  43     public FluentFuture<PostCanCommitStep> canCommit(final Object txId, final EffectiveModelContext ctx,
  44             final Collection<DOMDataTreeCandidate> candidates) {
  45
  46         for (DOMDataTreeCandidate candidate : candidates) {
  47             // Simple data validation - verify the year, if present, is >= 1990
  48
  49             final DataTreeCandidateNode rootNode = candidate.getRootNode();
  50             final NormalizedNode dataAfter = rootNode.dataAfter();
  51
  52             LOG.info("In canCommit: modificationType: {}, dataBefore: {}, dataAfter: {}",
  53                     rootNode.modificationType(), rootNode.dataBefore(), dataAfter);
  54
  55             // Note: we don't want to process DELETE modifications but we don't need to explicitly check the
  56             // ModificationType because dataAfter will not be present. Also dataAfter *should* always contain a
  57             // MapEntryNode but we verify anyway.
  58             if (dataAfter != null) {
  59                 Verify.verify(dataAfter instanceof DataContainerNode,
  60                         "Expected type DataContainerNode, actual was %s", dataAfter.getClass());
  61                 DataContainerNode entryNode = (DataContainerNode) dataAfter;
  62                 final Optional<DataContainerChild> possibleYear = entryNode.findChildByArg(YEAR_NODE_ID);
  63                 if (possibleYear.isPresent()) {
  64                     final Number year = (Number) possibleYear.orElseThrow().body();
  65
  66                     LOG.info("year is {}", year);
  67
  68                     if (year.longValue() < 1990) {
  69                         return FluentFutures.immediateFailedFluentFuture(new DataValidationFailedException(
  70                                 DOMDataTreeIdentifier.class, candidate.getRootPath(),
  71                                 String.format("Invalid year %d - year must be >= 1990", year)));
  72                     }
  73                 }
  74             }
  75         }
  76
  77         // Return the noop PostCanCommitStep as we're only validating input data and not participating in the
  78         // remaining 3PC stages (pre-commit and commit).
  79         return PostCanCommitStep.NOOP_SUCCESSFUL_FUTURE;
  80     }
  81 }