| /* |
| * Copyright 2016-present Open Networking Foundation |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.onosproject.store.primitives.impl; |
| |
| import java.util.Set; |
| import java.util.concurrent.CompletableFuture; |
| import java.util.stream.Collectors; |
| |
| import com.google.common.collect.Sets; |
| import org.onlab.util.Tools; |
| import org.onosproject.store.primitives.TransactionId; |
| import org.onosproject.store.service.CommitStatus; |
| import org.onosproject.store.service.Serializer; |
| import org.onosproject.store.service.TransactionalMap; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| import static com.google.common.base.MoreObjects.toStringHelper; |
| |
| /** |
| * Transaction coordinator. |
| */ |
| public class TransactionCoordinator { |
| private final Logger log = LoggerFactory.getLogger(getClass()); |
| protected final TransactionId transactionId; |
| protected final TransactionManager transactionManager; |
| protected final Set<TransactionParticipant> transactionParticipants = Sets.newConcurrentHashSet(); |
| |
| public TransactionCoordinator(TransactionId transactionId, TransactionManager transactionManager) { |
| this.transactionId = transactionId; |
| this.transactionManager = transactionManager; |
| } |
| |
| /** |
| * Returns a transactional map for this transaction. |
| * |
| * @param name the transactional map name |
| * @param serializer the serializer |
| * @param <K> key type |
| * @param <V> value type |
| * @return a transactional map for this transaction |
| */ |
| public <K, V> TransactionalMap<K, V> getTransactionalMap(String name, Serializer serializer) { |
| PartitionedTransactionalMap<K, V> map = transactionManager.getTransactionalMap(name, serializer, this); |
| transactionParticipants.addAll(map.participants()); |
| return map; |
| } |
| |
| /** |
| * Commits the transaction. |
| * |
| * @return the transaction commit status |
| */ |
| public CompletableFuture<CommitStatus> commit() { |
| long totalParticipants = transactionParticipants.stream() |
| .filter(TransactionParticipant::hasPendingUpdates) |
| .count(); |
| |
| if (totalParticipants == 0) { |
| log.debug("No transaction participants, skipping commit", totalParticipants); |
| return CompletableFuture.completedFuture(CommitStatus.SUCCESS); |
| } else if (totalParticipants == 1) { |
| log.debug("Committing transaction {} via 1 participant", transactionId); |
| return transactionParticipants.stream() |
| .filter(TransactionParticipant::hasPendingUpdates) |
| .findFirst() |
| .get() |
| .prepareAndCommit() |
| .thenApply(v -> v ? CommitStatus.SUCCESS : CommitStatus.FAILURE); |
| } else { |
| log.debug("Committing transaction {} via {} participants", transactionId, totalParticipants); |
| Set<TransactionParticipant> transactionParticipants = this.transactionParticipants.stream() |
| .filter(TransactionParticipant::hasPendingUpdates) |
| .collect(Collectors.toSet()); |
| |
| CompletableFuture<CommitStatus> status = transactionManager.updateState( |
| transactionId, Transaction.State.PREPARING) |
| .thenCompose(v -> prepare(transactionParticipants)) |
| .thenCompose(result -> result |
| ? transactionManager.updateState(transactionId, Transaction.State.COMMITTING) |
| .thenCompose(v -> commit(transactionParticipants)) |
| .thenApply(v -> CommitStatus.SUCCESS) |
| : transactionManager.updateState(transactionId, Transaction.State.ROLLING_BACK) |
| .thenCompose(v -> rollback(transactionParticipants)) |
| .thenApply(v -> CommitStatus.FAILURE)); |
| return status.thenCompose(v -> transactionManager.remove(transactionId).thenApply(u -> v)); |
| } |
| } |
| |
| /** |
| * Performs the prepare phase of the two-phase commit protocol for the given transaction participants. |
| * |
| * @param transactionParticipants the transaction participants for which to prepare the transaction |
| * @return a completable future indicating whether <em>all</em> prepares succeeded |
| */ |
| protected CompletableFuture<Boolean> prepare(Set<TransactionParticipant> transactionParticipants) { |
| log.trace("Preparing transaction {} via {}", transactionId, transactionParticipants); |
| return Tools.allOf(transactionParticipants.stream() |
| .map(TransactionParticipant::prepare) |
| .collect(Collectors.toList())) |
| .thenApply(list -> list.stream().reduce(Boolean::logicalAnd).orElse(true)); |
| } |
| |
| /** |
| * Performs the commit phase of the two-phase commit protocol for the given transaction participants. |
| * |
| * @param transactionParticipants the transaction participants for which to commit the transaction |
| * @return a completable future to be completed once the commits are complete |
| */ |
| protected CompletableFuture<Void> commit(Set<TransactionParticipant> transactionParticipants) { |
| log.trace("Committing transaction {} via {}", transactionId, transactionParticipants); |
| return CompletableFuture.allOf(transactionParticipants.stream() |
| .map(TransactionParticipant::commit) |
| .toArray(CompletableFuture[]::new)); |
| } |
| |
| /** |
| * Rolls back transactions for the given participants. |
| * |
| * @param transactionParticipants the transaction participants for which to roll back the transaction |
| * @return a completable future to be completed once the rollbacks are complete |
| */ |
| protected CompletableFuture<Void> rollback(Set<TransactionParticipant> transactionParticipants) { |
| log.trace("Rolling back transaction {} via {}", transactionId, transactionParticipants); |
| return CompletableFuture.allOf(transactionParticipants.stream() |
| .map(TransactionParticipant::rollback) |
| .toArray(CompletableFuture[]::new)); |
| } |
| |
| @Override |
| public String toString() { |
| return toStringHelper(this) |
| .add("transactionId", transactionId) |
| .add("participants", transactionParticipants) |
| .toString(); |
| } |
| } |