- * @author Tony Tkacik
+ * Use of any other external mutable state is discouraged, implementation MUST NOT use any transaction related APIs on
+ * the 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 DOMDataBroker} or {@link CommitCohortExtension},
+ * potentially enforced through the extension and such calls may fail.
+ *
+ *
canCommit(@Nonnull Object txId,
- @Nonnull DOMDataTreeCandidate candidate, @Nonnull SchemaContext ctx) {
- LoggerFactory.getLogger(getClass()).error(
- "The default implementation of DOMDataTreeCommitCohort#canCommit(Object, DOMDataTreeCandidate, "
- + "SchemaContext) was invoked on {}", getClass());
- return PostCanCommitStep.NOOP_SUCCESS_FUTURE;
- }
-
- /**
- * Validates supplied data tree candidates and associates cohort-specific steps with data broker
+ * Validates the supplied data tree modifications and associates the cohort-specific steps with data broker
* transaction.
- * If {@link DataValidationFailedException} is thrown by implementation, commit of 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 SHOULD NOT block on any
- * external resources.
- * Implementation MUST NOT access any data transaction related APIs during invocation of
- * callback. Note that this may be enforced by some implementations of
- * {@link DOMDataTreeCommitCohortRegistry} and such calls may fail.
+ *
+ *
+ * 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 CommitCohortExtension} 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.
+ * {@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 Checked future which will successfully complete with the user-supplied implementation of
- * {@link PostCanCommitStep} if all candidates are valid, or a failed checked future with a
+ * @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
- default CheckedFuture canCommit(@Nonnull Object txId,
- @Nonnull Collection candidates, @Nonnull SchemaContext ctx) {
- LoggerFactory.getLogger(getClass()).warn("DOMDataTreeCommitCohort implementation {} should override "
- + "canCommit(Object, Collection, SchemaContext)", getClass());
-
- // For backwards compatibility, the default implementation is to invoke the deprecated
- // canCommit(Object, DOMDataTreeCandidate, SchemaContext) method for each DOMDataTreeCandidate and return the
- // last PostCanCommitStep.
- List> futures = new ArrayList<>();
- for (DOMDataTreeCandidate candidate : candidates) {
- futures.add(canCommit(txId, candidate, ctx));
- }
-
- final ListenableFuture resultFuture = Futures.transform(Futures.allAsList(futures),
- (AsyncFunction, PostCanCommitStep>)input ->
- Futures.immediateFuture(input.get(input.size() - 1)));
- return MappingCheckedFuture.create(resultFuture, new DataValidationFailedExceptionMapper("canCommit",
- Iterables.getLast(candidates).getRootPath()));
- }
+ @NonNull FluentFuture canCommit(@NonNull Object txId,
+ @NonNull EffectiveModelContext ctx, @NonNull Collection candidates);
/**
* An ExceptionMapper that translates an Exception to a DataValidationFailedException.
*/
class DataValidationFailedExceptionMapper extends ExceptionMapper {
- private final DOMDataTreeIdentifier failedTreeId;
+ private final @NonNull DOMDataTreeIdentifier failedTreeId;
- public DataValidationFailedExceptionMapper(String opName, DOMDataTreeIdentifier failedTreeId) {
+ public DataValidationFailedExceptionMapper(final String opName, final DOMDataTreeIdentifier failedTreeId) {
super(opName, DataValidationFailedException.class);
- this.failedTreeId = failedTreeId;
+ this.failedTreeId = requireNonNull(failedTreeId);
}
@Override
- protected DataValidationFailedException newWithCause(String message, Throwable cause) {
+ protected DataValidationFailedException newWithCause(final String message, final Throwable cause) {
return new DataValidationFailedException(DOMDataTreeIdentifier.class, failedTreeId, message, cause);
}
}