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);
58 return createLocalTransactionContext(local, parent);
64 private void onFindPrimaryShardSuccess(PrimaryShardInfo primaryShardInfo, TransactionProxy parent,
65 String shardName, TransactionContextWrapper transactionContextAdapter) {
66 if(LOG.isDebugEnabled()) {
67 LOG.debug("Tx {}: Found primary {} for shard {}", parent.getIdentifier(),
68 primaryShardInfo.getPrimaryShardActor(), shardName);
71 updateShardInfo(shardName, primaryShardInfo);
73 TransactionContext localContext = maybeCreateLocalTransactionContext(parent, shardName);
74 if(localContext != null) {
75 transactionContextAdapter.executePriorTransactionOperations(localContext);
77 RemoteTransactionContextSupport remote = new RemoteTransactionContextSupport(transactionContextAdapter,
79 remote.setPrimaryShard(primaryShardInfo.getPrimaryShardActor());
83 private void onFindPrimaryShardFailure(Throwable failure, TransactionProxy parent,
84 String shardName, TransactionContextWrapper transactionContextAdapter) {
85 LOG.debug("Tx {}: Find primary for shard {} failed", parent.getIdentifier(), shardName, failure);
87 transactionContextAdapter.executePriorTransactionOperations(new NoOpTransactionContext(failure,
88 parent.getIdentifier(), parent.getLimiter()));
91 final TransactionContextWrapper newTransactionAdapter(final TransactionProxy parent, final String shardName) {
92 final TransactionContextWrapper transactionContextAdapter = new TransactionContextWrapper(parent.getIdentifier());
94 Future<PrimaryShardInfo> findPrimaryFuture = findPrimaryShard(shardName);
95 if(findPrimaryFuture.isCompleted()) {
96 Try<PrimaryShardInfo> maybe = findPrimaryFuture.value().get();
97 if(maybe.isSuccess()) {
98 onFindPrimaryShardSuccess(maybe.get(), parent, shardName, transactionContextAdapter);
100 onFindPrimaryShardFailure(maybe.failed().get(), parent, shardName, transactionContextAdapter);
103 findPrimaryFuture.onComplete(new OnComplete<PrimaryShardInfo>() {
105 public void onComplete(final Throwable failure, final PrimaryShardInfo primaryShardInfo) {
106 if (failure == null) {
107 onFindPrimaryShardSuccess(primaryShardInfo, parent, shardName, transactionContextAdapter);
109 onFindPrimaryShardFailure(failure, parent, shardName, transactionContextAdapter);
112 }, actorContext.getClientDispatcher());
115 return transactionContextAdapter;
118 private void updateShardInfo(final String shardName, final PrimaryShardInfo primaryShardInfo) {
119 final Optional<DataTree> maybeDataTree = primaryShardInfo.getLocalShardDataTree();
120 if (maybeDataTree.isPresent()) {
121 if(!knownLocal.containsKey(shardName)) {
122 LOG.debug("Shard {} resolved to local data tree - adding local factory", shardName);
124 F factory = factoryForShard(shardName, primaryShardInfo.getPrimaryShardActor(), maybeDataTree.get());
125 knownLocal.putIfAbsent(shardName, factory);
127 } else if(knownLocal.containsKey(shardName)) {
128 LOG.debug("Shard {} invalidating local data tree", shardName);
130 knownLocal.remove(shardName);
134 protected String getMemberName() {
135 String memberName = getActorContext().getCurrentMemberName();
136 if (memberName == null) {
137 memberName = "UNKNOWN-MEMBER";
144 * Create an identifier for the next TransactionProxy attached to this component
146 * @return Transaction identifier, may not be null.
148 protected abstract TransactionIdentifier nextIdentifier();
151 * Find the primary shard actor.
153 * @param shardName Shard name
154 * @return Future containing shard information.
156 protected abstract Future<PrimaryShardInfo> findPrimaryShard(String shardName);
159 * Create local transaction factory for specified shard, backed by specified shard leader
160 * and data tree instance.
164 * @param dataTree Backing data tree instance. The data tree may only be accessed in
166 * @return Transaction factory for local use.
168 protected abstract F factoryForShard(String shardName, ActorSelection shardLeader, DataTree dataTree);
171 * Callback invoked from child transactions to push any futures, which need to
172 * be waited for before the next transaction is allocated.
173 * @param cohortFutures Collection of futures
175 protected abstract <T> void onTransactionReady(@Nonnull TransactionIdentifier transaction, @Nonnull Collection<Future<T>> cohortFutures);
177 private static TransactionContext createLocalTransactionContext(final LocalTransactionFactory factory, final TransactionProxy parent) {
178 switch(parent.getType()) {
180 final DOMStoreReadTransaction readOnly = factory.newReadOnlyTransaction(parent.getIdentifier());
181 return new LocalTransactionContext(parent.getIdentifier(), readOnly, parent.getCompleter()) {
183 protected DOMStoreWriteTransaction getWriteDelegate() {
184 throw new UnsupportedOperationException();
188 protected DOMStoreReadTransaction getReadDelegate() {
193 final DOMStoreReadWriteTransaction readWrite = factory.newReadWriteTransaction(parent.getIdentifier());
194 return new LocalTransactionContext(parent.getIdentifier(), readWrite, parent.getCompleter()) {
196 protected DOMStoreWriteTransaction getWriteDelegate() {
201 protected DOMStoreReadTransaction getReadDelegate() {
206 final DOMStoreWriteTransaction writeOnly = factory.newWriteOnlyTransaction(parent.getIdentifier());
207 return new LocalTransactionContext(parent.getIdentifier(), writeOnly, parent.getCompleter()) {
209 protected DOMStoreWriteTransaction getWriteDelegate() {
214 protected DOMStoreReadTransaction getReadDelegate() {
215 throw new UnsupportedOperationException();
219 throw new IllegalArgumentException("Invalid transaction type: " + parent.getType());