/* * Copyright (c) 2015 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.dom.api; import com.google.common.annotations.Beta; import com.google.common.util.concurrent.FluentFuture; import java.util.Collection; import javax.annotation.Nonnull; import org.opendaylight.mdsal.common.api.DataValidationFailedException; import org.opendaylight.mdsal.common.api.PostCanCommitStep; import org.opendaylight.yangtools.util.concurrent.ExceptionMapper; import org.opendaylight.yangtools.yang.model.api.SchemaContext; /** * 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. * *
* @author Tony Tkacik */ // TODO: Provide example and describe more usage patterns @Beta public interface DOMDataTreeCommitCohort { /** * Validates the supplied data tree modifications and associates the cohort-specific steps with data broker * transaction. * *
* 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 DOMDataTreeCommitCohortRegistry} 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 candidates Data Tree candidates to be validated and committed.
* @param ctx Schema Context to which Data Tree candidate should conform.
* @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 DOMDataTreeCandidate} instance did not pass validation. Users are encouraged to use
* more specific subclasses of this exception to provide additional information about
* validation failure reason.
*/
@Nonnull
FluentFuture