2 * Copyright (c) 2015 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.datastore;
10 import akka.actor.ActorSelection;
11 import akka.dispatch.OnComplete;
12 import com.google.common.base.Optional;
13 import com.google.common.base.Preconditions;
14 import java.util.Collection;
15 import java.util.concurrent.ConcurrentHashMap;
16 import java.util.concurrent.ConcurrentMap;
17 import java.util.concurrent.atomic.AtomicLong;
18 import javax.annotation.Nonnull;
19 import org.opendaylight.controller.cluster.datastore.identifiers.TransactionIdentifier;
20 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
21 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
22 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
23 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
24 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
25 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
26 import org.slf4j.Logger;
27 import org.slf4j.LoggerFactory;
28 import scala.concurrent.Future;
29 import scala.util.Try;
32 * Factory for creating local and remote TransactionContext instances. Maintains a cache of known local
33 * transaction factories.
35 abstract class AbstractTransactionContextFactory<F extends LocalTransactionFactory> implements AutoCloseable {
36 private static final Logger LOG = LoggerFactory.getLogger(AbstractTransactionContextFactory.class);
38 protected static final AtomicLong TX_COUNTER = new AtomicLong();
40 private final ConcurrentMap<String, F> knownLocal = new ConcurrentHashMap<>();
41 private final ActorContext actorContext;
43 protected AbstractTransactionContextFactory(final ActorContext actorContext) {
44 this.actorContext = Preconditions.checkNotNull(actorContext);
47 final ActorContext getActorContext() {
51 private TransactionContext maybeCreateLocalTransactionContext(final TransactionProxy parent, final String shardName) {
52 final LocalTransactionFactory local = knownLocal.get(shardName);
54 if(LOG.isDebugEnabled()) {
55 LOG.debug("Tx {} - Creating local component for shard {} using factory {}",
56 parent.getIdentifier(), shardName, local);
60 return createLocalTransactionContext(local, parent);
61 } catch(Exception e) {
62 return new NoOpTransactionContext(e, parent.getIdentifier());
69 private void onFindPrimaryShardSuccess(PrimaryShardInfo primaryShardInfo, TransactionProxy parent,
70 String shardName, TransactionContextWrapper transactionContextWrapper) {
71 if(LOG.isDebugEnabled()) {
72 LOG.debug("Tx {}: Found primary {} for shard {}", parent.getIdentifier(),
73 primaryShardInfo.getPrimaryShardActor(), shardName);
76 updateShardInfo(shardName, primaryShardInfo);
79 TransactionContext localContext = maybeCreateLocalTransactionContext(parent, shardName);
80 if(localContext != null) {
81 transactionContextWrapper.executePriorTransactionOperations(localContext);
83 RemoteTransactionContextSupport remote = new RemoteTransactionContextSupport(transactionContextWrapper,
85 remote.setPrimaryShard(primaryShardInfo);
88 onTransactionContextCreated(parent.getIdentifier());
92 private void onFindPrimaryShardFailure(Throwable failure, TransactionProxy parent,
93 String shardName, TransactionContextWrapper transactionContextWrapper) {
94 LOG.debug("Tx {}: Find primary for shard {} failed", parent.getIdentifier(), shardName, failure);
97 transactionContextWrapper.executePriorTransactionOperations(new NoOpTransactionContext(failure,
98 parent.getIdentifier()));
100 onTransactionContextCreated(parent.getIdentifier());
104 final TransactionContextWrapper newTransactionContextWrapper(final TransactionProxy parent, final String shardName) {
105 final TransactionContextWrapper transactionContextWrapper =
106 new TransactionContextWrapper(parent.getIdentifier(), actorContext);
108 Future<PrimaryShardInfo> findPrimaryFuture = findPrimaryShard(shardName, parent.getIdentifier());
109 if(findPrimaryFuture.isCompleted()) {
110 Try<PrimaryShardInfo> maybe = findPrimaryFuture.value().get();
111 if(maybe.isSuccess()) {
112 onFindPrimaryShardSuccess(maybe.get(), parent, shardName, transactionContextWrapper);
114 onFindPrimaryShardFailure(maybe.failed().get(), parent, shardName, transactionContextWrapper);
117 findPrimaryFuture.onComplete(new OnComplete<PrimaryShardInfo>() {
119 public void onComplete(final Throwable failure, final PrimaryShardInfo primaryShardInfo) {
120 if (failure == null) {
121 onFindPrimaryShardSuccess(primaryShardInfo, parent, shardName, transactionContextWrapper);
123 onFindPrimaryShardFailure(failure, parent, shardName, transactionContextWrapper);
126 }, actorContext.getClientDispatcher());
129 return transactionContextWrapper;
132 private void updateShardInfo(final String shardName, final PrimaryShardInfo primaryShardInfo) {
133 final Optional<DataTree> maybeDataTree = primaryShardInfo.getLocalShardDataTree();
134 if (maybeDataTree.isPresent()) {
135 if(!knownLocal.containsKey(shardName)) {
136 LOG.debug("Shard {} resolved to local data tree - adding local factory", shardName);
138 F factory = factoryForShard(shardName, primaryShardInfo.getPrimaryShardActor(), maybeDataTree.get());
139 knownLocal.putIfAbsent(shardName, factory);
141 } else if(knownLocal.containsKey(shardName)) {
142 LOG.debug("Shard {} invalidating local data tree", shardName);
144 knownLocal.remove(shardName);
148 protected String getMemberName() {
149 String memberName = getActorContext().getCurrentMemberName();
150 if (memberName == null) {
151 memberName = "UNKNOWN-MEMBER";
158 * Create an identifier for the next TransactionProxy attached to this component
160 * @return Transaction identifier, may not be null.
162 protected abstract TransactionIdentifier nextIdentifier();
165 * Find the primary shard actor.
167 * @param shardName Shard name
168 * @return Future containing shard information.
170 protected abstract Future<PrimaryShardInfo> findPrimaryShard(@Nonnull String shardName,
171 @Nonnull TransactionIdentifier txId);
174 * Create local transaction factory for specified shard, backed by specified shard leader
175 * and data tree instance.
179 * @param dataTree Backing data tree instance. The data tree may only be accessed in
181 * @return Transaction factory for local use.
183 protected abstract F factoryForShard(String shardName, ActorSelection shardLeader, DataTree dataTree);
186 * Callback invoked from child transactions to push any futures, which need to
187 * be waited for before the next transaction is allocated.
188 * @param cohortFutures Collection of futures
190 protected abstract <T> void onTransactionReady(@Nonnull TransactionIdentifier transaction, @Nonnull Collection<Future<T>> cohortFutures);
193 * Callback invoked when the internal TransactionContext has been created for a transaction.
195 * @param transactionId the ID of the transaction.
197 protected abstract void onTransactionContextCreated(@Nonnull TransactionIdentifier transactionId);
199 private static TransactionContext createLocalTransactionContext(final LocalTransactionFactory factory,
200 final TransactionProxy parent) {
202 switch(parent.getType()) {
204 final DOMStoreReadTransaction readOnly = factory.newReadOnlyTransaction(parent.getIdentifier());
205 return new LocalTransactionContext(readOnly, parent.getIdentifier(), factory) {
207 protected DOMStoreWriteTransaction getWriteDelegate() {
208 throw new UnsupportedOperationException();
212 protected DOMStoreReadTransaction getReadDelegate() {
217 final DOMStoreReadWriteTransaction readWrite = factory.newReadWriteTransaction(parent.getIdentifier());
218 return new LocalTransactionContext(readWrite, parent.getIdentifier(), factory) {
220 protected DOMStoreWriteTransaction getWriteDelegate() {
225 protected DOMStoreReadTransaction getReadDelegate() {
230 final DOMStoreWriteTransaction writeOnly = factory.newWriteOnlyTransaction(parent.getIdentifier());
231 return new LocalTransactionContext(writeOnly, parent.getIdentifier(), factory) {
233 protected DOMStoreWriteTransaction getWriteDelegate() {
238 protected DOMStoreReadTransaction getReadDelegate() {
239 throw new UnsupportedOperationException();
243 throw new IllegalArgumentException("Invalid transaction type: " + parent.getType());