opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/broker/impl/PingPongTransaction.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 package org.opendaylight.controller.md.sal.dom.broker.impl;
   9
  10 import com.google.common.base.MoreObjects;
  11 import com.google.common.base.MoreObjects.ToStringHelper;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.ListenableFuture;
  15 import com.google.common.util.concurrent.SettableFuture;
  16 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  17 import org.opendaylight.mdsal.common.api.CommitInfo;
  18
  19 /**
  20  * Transaction context. Tracks the relationship with the backend transaction.
  21  * We never leak this class to the user and have it implement the {@link FutureCallback}
  22  * interface so we have a simple way of propagating the result.
  23  */
  24 @Deprecated
  25 final class PingPongTransaction implements FutureCallback<CommitInfo> {
  26     private final DOMDataReadWriteTransaction delegate;
  27     private final SettableFuture<CommitInfo> future;
  28     private DOMDataReadWriteTransaction frontendTransaction;
  29
  30     PingPongTransaction(final DOMDataReadWriteTransaction delegate) {
  31         this.delegate = Preconditions.checkNotNull(delegate);
  32         future = SettableFuture.create();
  33     }
  34
  35     DOMDataReadWriteTransaction getTransaction() {
  36         return delegate;
  37     }
  38
  39     DOMDataReadWriteTransaction getFrontendTransaction() {
  40         return frontendTransaction;
  41     }
  42
  43     ListenableFuture<CommitInfo> getCommitFuture() {
  44         return future;
  45     }
  46
  47     @Override
  48     public void onSuccess(final CommitInfo result) {
  49         future.set(result);
  50     }
  51
  52     @Override
  53     public void onFailure(final Throwable throwable) {
  54         future.setException(throwable);
  55     }
  56
  57     void recordFrontendTransaction(final DOMDataReadWriteTransaction tx) {
  58         if (frontendTransaction != null) {
  59             frontendTransaction = tx;
  60         }
  61     }
  62
  63     @Override
  64     public String toString() {
  65         return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
  66     }
  67
  68     protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
  69         return toStringHelper.add("delegate", delegate);
  70     }
  71 }