/* * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.mdsal.binding.api; import com.google.common.annotations.Beta; import com.google.common.util.concurrent.FluentFuture; import edu.umd.cs.findbugs.annotations.CheckReturnValue; import java.util.Collection; import org.eclipse.jdt.annotation.NonNull; import org.opendaylight.mdsal.common.api.DataValidationFailedException; import org.opendaylight.mdsal.common.api.PostCanCommitStep; import org.opendaylight.yangtools.yang.binding.DataObject; /** * Commit cohort participating in commit of data modification, which can validate data tree * modifications, with option to reject supplied modification, and with callbacks describing state * of commit. * *
* Implementations of this interface are discouraged, unless you really need ability to veto data * tree changes, or to provide external state change in sync with visibility of commited data. * *
* Use of any other external mutable state is discouraged, implementation MUST NOT use any * transaction related APIs on same data broker / data store instance during invocation of * callbacks, except ones provided as argument. Note that this MAY BE enforced by some * implementations of {@link DataBroker} or Commit coordinator * *
* Note that this may be enforced by some implementations of {@link DataTreeCommitCohortRegistry} * and such calls may fail. * *
* Validator is implementation, which only validates {@link DataTreeModification} and does not * retain any state derived from edited data - does not care if {@link DataTreeModification} was * rejected afterwards or transaction was cancelled. * *
* Implementation may opt-out from receiving {@code preCommit()}, {@code commit()}, {@code abort()} * callbacks by returning {@link PostCanCommitStep#NOOP}. * *
* TODO: Provide example and describe more usage patterns
*
* @author Tony Tkacik <ttkacik@cisco.com>
*/
@Beta
public interface DataTreeCommitCohort
* If {@link DataValidationFailedException} is thrown by implementation, the commit of the supplied data
* will be prevented, with the DataBroker transaction providing the thrown exception as the cause of failure.
*
*
* Note the implementations are expected to do validation and processing asynchronous. Implementations SHOULD do
* processing fast, and are discouraged from blocking on any external resources. Implementation MUST NOT access
* any data transaction related APIs during invocation of the callback. Note that this may be enforced by some
* implementations of {@link DataTreeCommitCohortRegistry} and such calls may fail.
*
*
* Implementation MAY opt-out from implementing other steps by returning
* {@link PostCanCommitStep#NOOP}. Otherwise implementation MUST return instance of
* {@link PostCanCommitStep}, which will be used to invoke
* {@link org.opendaylight.mdsal.common.api.PostPreCommitStep#commit()} or
* {@link PostCanCommitStep#abort()} based on accepting data by data broker and or other commit cohorts.
*
* @param txId Transaction identifier. SHOULD be used only for reporting and correlation.
* Implementation MUST NOT use {@code txId} for validation.
* @param modifications the {@link DataTreeModification}s to be validated and committed.
* @return a FluentFuture which will successfully complete with the user-supplied implementation of
* {@link PostCanCommitStep} if all candidates are valid, or a failed future with a
* {@link DataValidationFailedException} if and only if a provided
* {@link DataTreeModification} instance did not pass validation. Users are encouraged to use
* more specific subclasses of this exception to provide additional information about
* validation failure reason.
*/
@CheckReturnValue
@NonNull FluentFuture