opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/SerializedDOMDataBroker.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.controller.md.sal.dom.broker.impl;
  10
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.base.Supplier;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import com.google.common.util.concurrent.ListeningExecutorService;
  16 import java.util.Collection;
  17 import java.util.Map;
  18 import java.util.concurrent.RejectedExecutionException;
  19 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  20 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  21 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  22 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
  23 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
  24 import org.opendaylight.yangtools.util.DurationStatisticsTracker;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 /**
  29  * Implementation of blocking three phase commit coordinator, which which
  30  * supports coordination on multiple {@link DOMStoreThreePhaseCommitCohort}.
  31  *
  32  * <p>
  33  * This implementation does not support cancellation of commit,
  34  *
  35  * <p>
  36  * In order to advance to next phase of three phase commit all subtasks of
  37  * previous step must be finish.
  38  *
  39  * <p>
  40  * This executor does not have an upper bound on subtask timeout.
  41  */
  42 public class SerializedDOMDataBroker extends AbstractDOMDataBroker {
  43     private static final Logger LOG = LoggerFactory.getLogger(SerializedDOMDataBroker.class);
  44     private final DurationStatisticsTracker commitStatsTracker = DurationStatisticsTracker.createConcurrent();
  45     private final ListeningExecutorService executor;
  46
  47     /**
  48      * Construct DOMDataCommitCoordinator which uses supplied executor to
  49      * process commit coordinations.
  50      *
  51      * @param datastores data stores
  52      * @param executor executor service
  53      */
  54     public SerializedDOMDataBroker(final Map<LogicalDatastoreType, DOMStore> datastores,
  55                                    final ListeningExecutorService executor) {
  56         super(datastores);
  57         this.executor = Preconditions.checkNotNull(executor, "executor must not be null.");
  58     }
  59
  60     public DurationStatisticsTracker getCommitStatsTracker() {
  61         return commitStatsTracker;
  62     }
  63
  64     @Override
  65     protected <T> ListenableFuture<T> commit(final DOMDataWriteTransaction transaction,
  66             final Collection<DOMStoreThreePhaseCommitCohort> cohorts, final Supplier<T> futureValueSupplier) {
  67         Preconditions.checkArgument(transaction != null, "Transaction must not be null.");
  68         Preconditions.checkArgument(cohorts != null, "Cohorts must not be null.");
  69         LOG.debug("Tx: {} is submitted for execution.", transaction.getIdentifier());
  70
  71         ListenableFuture<T> commitFuture;
  72         try {
  73             commitFuture = executor.submit(new CommitCoordinationTask<>(transaction, cohorts, commitStatsTracker,
  74                     futureValueSupplier));
  75         } catch (RejectedExecutionException e) {
  76             LOG.error("The commit executor {} queue is full - submit task was rejected. \n", executor, e);
  77             commitFuture = Futures.immediateFailedFuture(new TransactionCommitFailedException(
  78                     "Could not submit the commit task - the commit queue capacity has been exceeded.", e));
  79         }
  80
  81         return commitFuture;
  82     }
  83 }