2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.md.sal.common.impl.service;
10 import com.google.common.base.Preconditions;
11 import com.google.common.util.concurrent.AsyncFunction;
12 import com.google.common.util.concurrent.CheckedFuture;
13 import com.google.common.util.concurrent.Futures;
14 import com.google.common.util.concurrent.ListenableFuture;
15 import java.util.concurrent.Future;
16 import java.util.concurrent.TimeUnit;
17 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
18 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
19 import org.opendaylight.controller.md.sal.common.impl.AbstractDataModification;
20 import org.opendaylight.yangtools.concepts.Path;
21 import org.opendaylight.yangtools.yang.common.RpcResult;
22 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
23 import org.slf4j.Logger;
24 import org.slf4j.LoggerFactory;
27 public abstract class AbstractDataTransaction<P extends Path<P>, D extends Object> extends
28 AbstractDataModification<P, D> {
29 private static final Logger LOG = LoggerFactory.getLogger(AbstractDataTransaction.class);
30 private static final ListenableFuture<RpcResult<TransactionStatus>> SUCCESS_FUTURE =
31 Futures.immediateFuture(RpcResultBuilder.success(TransactionStatus.COMMITED).build());
33 private final Object identifier;
34 private final long allocationTime;
35 private long readyTime = 0;
36 private long completeTime = 0;
38 private TransactionStatus status = TransactionStatus.NEW;
40 private final AbstractDataBroker<P, D, ? extends Object> broker;
42 protected AbstractDataTransaction(final Object identifier,
43 final AbstractDataBroker<P, D, ? extends Object> dataBroker) {
45 this.identifier = Preconditions.checkNotNull(identifier);
46 this.broker = Preconditions.checkNotNull(dataBroker);
47 this.allocationTime = System.nanoTime();
48 LOG.debug("Transaction {} Allocated.", identifier);
52 public Object getIdentifier() {
53 return this.identifier;
57 public Future<RpcResult<TransactionStatus>> commit() {
58 readyTime = System.nanoTime();
59 if (LOG.isDebugEnabled()) {
60 LOG.debug("Transaction {} Ready after {}ms.", identifier, TimeUnit.NANOSECONDS.toMillis(readyTime - allocationTime));
62 changeStatus(TransactionStatus.SUBMITED);
63 return this.broker.commit(this);
67 public D readConfigurationData(final P path) {
68 final D local = getUpdatedConfigurationData().get(path);
72 return this.broker.readConfigurationData(path);
76 public D readOperationalData(final P path) {
77 final D local = this.getUpdatedOperationalData().get(path);
81 return this.broker.readOperationalData(path);
85 public int hashCode() {
88 result = prime * result + ((identifier == null) ? 0 : identifier.hashCode());
93 public boolean equals(final Object obj) {
100 if (getClass() != obj.getClass()) {
103 AbstractDataTransaction<?, ?> other = (AbstractDataTransaction<?, ?>) obj;
104 if (identifier == null) {
105 if (other.identifier != null) {
108 } else if (!identifier.equals(other.identifier)) {
115 public TransactionStatus getStatus() {
119 protected abstract void onStatusChange(final TransactionStatus status);
121 public void succeeded() {
122 this.completeTime = System.nanoTime();
123 if (LOG.isDebugEnabled()) {
124 LOG.debug("Transaction {} Committed after {}ms.", identifier, TimeUnit.NANOSECONDS.toMillis(completeTime - readyTime));
126 changeStatus(TransactionStatus.COMMITED);
129 public void failed() {
130 this.completeTime = System.nanoTime();
132 if (LOG.isDebugEnabled()) {
133 LOG.debug("Transaction {} Failed after {}ms.", identifier, TimeUnit.NANOSECONDS.toMillis(completeTime - readyTime));
135 changeStatus(TransactionStatus.FAILED);
138 private void changeStatus(final TransactionStatus status) {
139 LOG.debug("Transaction {} transitioned from {} to {}", getIdentifier(), this.status, status);
140 this.status = status;
141 this.onStatusChange(status);
144 public static ListenableFuture<RpcResult<TransactionStatus>> convertToLegacyCommitFuture(final CheckedFuture<Void,TransactionCommitFailedException> from) {
145 return Futures.transform(from, new AsyncFunction<Void, RpcResult<TransactionStatus>>() {
147 public ListenableFuture<RpcResult<TransactionStatus>> apply(final Void input) {
148 return SUCCESS_FUTURE;