2 * Copyright (c) 2018 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.netconf.mdsal.connector;
10 import com.google.common.annotations.Beta;
11 import com.google.common.util.concurrent.CheckedFuture;
12 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
13 import org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension;
14 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
15 import org.opendaylight.mdsal.dom.api.DOMServiceExtension;
16 import org.opendaylight.yangtools.yang.common.OperationFailedException;
17 import org.opendaylight.yangtools.yang.common.RpcError;
18 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
21 * A {@link DOMServiceExtension} which allows users to provide Validate capability for {@link DOMDataBroker}.
23 * <p> See <a href="https://tools.ietf.org/html/rfc4741#section-8.6">RFC4741 section 8.6</a> for details.
26 public interface DOMDataTransactionValidator extends DOMDataBrokerExtension {
28 * Validates state of the data tree associated with the provided {@link DOMDataTreeWriteTransaction}.
30 * <p>The operation should not have any side-effects on the transaction state.
32 * <p>It can be executed many times, providing the same results if the state of the transaction has not been
36 * transaction to be validated
38 * a CheckedFuture containing the result of the validate operation. The future blocks until the validation
39 * operation is complete. A successful validate returns nothing. On failure, the Future will fail
40 * with a {@link ValidationFailedException} or an exception derived from ValidationFailedException.
42 CheckedFuture<Void, ValidationFailedException> validate(DOMDataTreeWriteTransaction transaction);
45 * Failed validation of asynchronous transaction. This exception is raised and returned when transaction validation
48 class ValidationFailedException extends OperationFailedException {
49 private static final long serialVersionUID = 1L;
51 public ValidationFailedException(final String message, final Throwable cause) {
52 super(message, cause, RpcResultBuilder.newError(RpcError.ErrorType.APPLICATION, "invalid-value", message,
56 public ValidationFailedException(final String message) {