/*
* 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.controller.cluster.datastore;
import static com.google.common.base.Preconditions.checkState;
import static java.util.Objects.requireNonNull;
import akka.actor.ActorRef;
import akka.actor.Status;
import akka.actor.Status.Failure;
import akka.dispatch.ExecutionContexts;
import akka.dispatch.Futures;
import akka.dispatch.OnComplete;
import akka.dispatch.Recover;
import akka.pattern.Patterns;
import akka.util.Timeout;
import com.google.common.collect.Lists;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.util.AbstractMap.SimpleImmutableEntry;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Map.Entry;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.Executor;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
import org.opendaylight.controller.cluster.datastore.DataTreeCohortActor.CanCommit;
import org.opendaylight.controller.cluster.datastore.DataTreeCohortActor.Success;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import scala.compat.java8.FutureConverters;
import scala.concurrent.Future;
/**
* Composite cohort, which coordinates multiple user-provided cohorts as if it was only one cohort.
*
* It tracks current operation and list of cohorts which successfuly finished previous phase in
* case, if abort is necessary to invoke it only on cohort steps which are still active.
*
*/
class CompositeDataTreeCohort {
private static final Logger LOG = LoggerFactory.getLogger(CompositeDataTreeCohort.class);
private enum State {
/**
* Cohorts are idle, no messages were sent.
*/
IDLE,
/**
* CanCommit message was sent to all participating cohorts.
*/
CAN_COMMIT_SENT,
/**
* Successful canCommit responses were received from every participating cohort.
*/
CAN_COMMIT_SUCCESSFUL,
/**
* PreCommit message was sent to all participating cohorts.
*/
PRE_COMMIT_SENT,
/**
* Successful preCommit responses were received from every participating cohort.
*/
PRE_COMMIT_SUCCESSFUL,
/**
* Commit message was send to all participating cohorts.
*/
COMMIT_SENT,
/**
* Successful commit responses were received from all participating cohorts.
*/
COMMITED,
/**
* Some of cohorts responded back with unsuccessful message.
*/
FAILED,
/**
* Abort message was send to all cohorts which responded with success previously.
*/
ABORTED
}
static final Recover