2 * Copyright (c) 2016 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.cluster.databroker;
10 import com.google.common.base.FinalizablePhantomReference;
11 import com.google.common.base.FinalizableReferenceQueue;
12 import com.google.common.base.Preconditions;
14 import java.util.concurrent.ConcurrentHashMap;
15 import javax.annotation.Nonnull;
16 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
17 import org.opendaylight.controller.cluster.databroker.actors.dds.AbstractClientHandle;
18 import org.opendaylight.controller.cluster.databroker.actors.dds.ClientTransaction;
19 import org.opendaylight.controller.sal.core.spi.data.AbstractDOMStoreTransaction;
20 import org.slf4j.Logger;
21 import org.slf4j.LoggerFactory;
24 * An implementation of {@link DOMStoreTransaction} backed by a {@link ClientTransaction}. It guards against user-level
25 * leaks by maintaining a phantom reference on the backing transaction, which will ensure that the transaction will
26 * be aborted, if it is not otherwise closed, just before this object is garbage-collected.
28 * @author Robert Varga
30 abstract class ClientBackedTransaction<T extends AbstractClientHandle<?>> extends
31 AbstractDOMStoreTransaction<TransactionIdentifier> {
32 private static final class Finalizer extends FinalizablePhantomReference<ClientBackedTransaction<?>> {
33 private static final FinalizableReferenceQueue QUEUE = new FinalizableReferenceQueue();
34 private static final Set<Finalizer> FINALIZERS = ConcurrentHashMap.newKeySet();
35 private static final Logger LOG = LoggerFactory.getLogger(Finalizer.class);
37 private final AbstractClientHandle<?> transaction;
39 private Finalizer(final ClientBackedTransaction<?> referent, final AbstractClientHandle<?> transaction) {
40 super(referent, QUEUE);
41 this.transaction = Preconditions.checkNotNull(transaction);
44 static @Nonnull <T extends AbstractClientHandle<?>> T recordTransaction(
45 @Nonnull final ClientBackedTransaction<T> referent, @Nonnull final T transaction) {
46 FINALIZERS.add(new Finalizer(referent, transaction));
51 public void finalizeReferent() {
52 FINALIZERS.remove(this);
53 if (transaction.abort()) {
54 LOG.warn("Aborted orphan transaction {}", transaction.getIdentifier());
59 private final T delegate;
61 ClientBackedTransaction(final T delegate) {
62 super(delegate.getIdentifier());
63 this.delegate = Finalizer.recordTransaction(this, delegate);