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.Optional;
  11 import com.google.common.base.Verify;
  12 import com.google.common.util.concurrent.CheckedFuture;
  13 import com.google.common.util.concurrent.Futures;
  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.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  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.api.schema.tree.DataTreeCandidateNode;
  27 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  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 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     @SuppressWarnings("unchecked")
  43     @Override
  44     public CheckedFuture<PostCanCommitStep, DataValidationFailedException> canCommit(Object txId,
  45             DOMDataTreeCandidate candidate, SchemaContext ctx) {
  46
  47         // Simple data validation - verify the year, if present, is >= 1990
  48
  49         final DataTreeCandidateNode rootNode = candidate.getRootNode();
  50         final Optional<NormalizedNode<?, ?>> dataAfter = rootNode.getDataAfter();
  51
  52         LOG.info("In canCommit: modificationType: {}, dataBefore: {}, dataAfter: {}", rootNode.getModificationType(),
  53                 rootNode.getDataBefore(), 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.isPresent()) {
  59             final NormalizedNode<?, ?> normalizedNode = dataAfter.get();
  60             Verify.verify(normalizedNode instanceof DataContainerNode, "Expected type DataContainerNode, actual was %s",
  61                     normalizedNode.getClass());
  62             DataContainerNode<?> entryNode = (DataContainerNode<?>) normalizedNode;
  63             final Optional<DataContainerChild<? extends PathArgument, ?>> possibleYear =
  64                     entryNode.getChild(YEAR_NODE_ID);
  65             if (possibleYear.isPresent()) {
  66                 final Number year = (Number) possibleYear.get().getValue();
  67
  68                 LOG.info("year is {}", year);
  69
  70                 if (!(year.longValue() >= 1990)) {
  71                     return Futures.immediateFailedCheckedFuture(new DataValidationFailedException(
  72                             DOMDataTreeIdentifier.class, candidate.getRootPath(),
  73                                 String.format("Invalid year %d - year must be >= 1990", year)));
  74                 }
  75             }
  76         }
  77
  78         // Return the noop PostCanCommitStep as we're only validating input data and not participating in the
  79         // remaining 3PC stages (pre-commit and commit).
  80         return (CheckedFuture<PostCanCommitStep, DataValidationFailedException>) PostCanCommitStep.NOOP_SUCCESS_FUTURE;
  81     }
  82 }