netconf/mdsal-netconf-connector/src/main/java/org/opendaylight/netconf/mdsal/connector/DOMDataTransactionValidator.java

   1 /*
   2  * Copyright (c) 2018 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
   9 package org.opendaylight.netconf.mdsal.connector;
  10
  11 import com.google.common.annotations.Beta;
  12 import com.google.common.util.concurrent.CheckedFuture;
  13 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  14 import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension;
  15 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  16 import org.opendaylight.controller.md.sal.dom.api.DOMServiceExtension;
  17 import org.opendaylight.yangtools.yang.common.OperationFailedException;
  18 import org.opendaylight.yangtools.yang.common.RpcError;
  19 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  20
  21 /**
  22  * A {@link DOMServiceExtension} which allows users to provide Validate capability for {@link DOMDataBroker}.
  23  *
  24  * <p> See <a href="https://tools.ietf.org/html/rfc4741#section-8.6">RFC4741 section 8.6</a> for details.
  25  */
  26 @Beta
  27 public interface DOMDataTransactionValidator extends DOMDataBrokerExtension {
  28     /**
  29      * Validates state of the data tree associated with the provided {@link DOMDataWriteTransaction}.
  30      *
  31      * <p>The operation should not have any side-effects on the transaction state.
  32      *
  33      * <p>It can be executed many times, providing the same results if the state of the transaction has not been
  34      * changed.
  35      *
  36      * @param transaction
  37      *     transaction to be validated
  38      * @return
  39      *     a CheckedFuture containing the result of the validate operation. The future blocks until the validation
  40      *     operation is complete. A successful validate returns nothing. On failure, the Future will fail
  41      *     with a {@link ValidationFailedException} or an exception derived from ValidationFailedException.
  42      */
  43     CheckedFuture<Void, ValidationFailedException> validate(DOMDataWriteTransaction transaction);
  44
  45     /**
  46      * Failed validation of asynchronous transaction. This exception is raised and returned when transaction validation
  47      * failed.
  48      */
  49     class ValidationFailedException extends OperationFailedException {
  50         private static final long serialVersionUID = 1L;
  51
  52         public ValidationFailedException(final String message, final Throwable cause) {
  53             super(message, cause, RpcResultBuilder.newError(RpcError.ErrorType.APPLICATION, "invalid-value", message,
  54                 null, null, cause));
  55         }
  56
  57         public ValidationFailedException(final String message) {
  58             this(message, null);
  59         }
  60     }
  61 }
  62