/*
* JBoss, Home of Professional Open Source
* Copyright 2013 Red Hat Inc. and/or its affiliates and other contributors
* as indicated by the @author tags. All rights reserved.
* See the copyright.txt in the distribution for a
* full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
* This program is distributed in the hope that it will be useful, but WITHOUT A
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*/
package org.infinispan.interceptors.totalorder;
import org.infinispan.CacheException;
import org.infinispan.commands.FlagAffectedCommand;
import org.infinispan.commands.tx.CommitCommand;
import org.infinispan.commands.tx.PrepareCommand;
import org.infinispan.commands.tx.RollbackCommand;
import org.infinispan.commands.tx.VersionedPrepareCommand;
import org.infinispan.commands.write.ClearCommand;
import org.infinispan.configuration.cache.Configurations;
import org.infinispan.container.entries.InternalCacheEntry;
import org.infinispan.context.InvocationContext;
import org.infinispan.context.impl.TxInvocationContext;
import org.infinispan.interceptors.distribution.VersionedDistributionInterceptor;
import org.infinispan.remoting.responses.KeysValidateFilter;
import org.infinispan.remoting.transport.Address;
import org.infinispan.util.logging.Log;
import org.infinispan.util.logging.LogFactory;
import java.util.Collection;
import static org.infinispan.transaction.WriteSkewHelper.setVersionsSeenOnPrepareCommand;
/**
* This interceptor is used in total order in distributed mode when the write skew check is enabled. After sending the
* prepare through TOA (Total Order Anycast), it blocks the execution thread until the transaction outcome is known
* (i.e., the write skew check passes in all keys owners)
*
* @author Pedro Ruivo
* @since 5.3
*/
public class TotalOrderVersionedDistributionInterceptor extends VersionedDistributionInterceptor {
private static final Log log = LogFactory.getLog(TotalOrderVersionedDistributionInterceptor.class);
@Override
public Object visitPrepareCommand(TxInvocationContext ctx, PrepareCommand command) throws Throwable {
//this map is only populated after locks are acquired. However, no locks are acquired when total order is enabled
//so we need to populate it here
ctx.addAllAffectedKeys(command.getAffectedKeys());
return super.visitPrepareCommand(ctx, command);
}
@Override
public Object visitRollbackCommand(TxInvocationContext ctx, RollbackCommand command) throws Throwable {
if (Configurations.isOnePhaseTotalOrderCommit(cacheConfiguration) || !ctx.hasModifications() ||
!shouldTotalOrderRollbackBeInvokedRemotely(ctx)) {
return invokeNextInterceptor(ctx, command);
}
totalOrderTxRollback(ctx);
return super.visitRollbackCommand(ctx, command);
}
@Override
public Object visitCommitCommand(TxInvocationContext ctx, CommitCommand command) throws Throwable {
if (Configurations.isOnePhaseTotalOrderCommit(cacheConfiguration) || !ctx.hasModifications()) {
return invokeNextInterceptor(ctx, command);
}
totalOrderTxCommit(ctx);
return super.visitCommitCommand(ctx, command);
}
@Override
protected void prepareOnAffectedNodes(TxInvocationContext ctx, PrepareCommand command, Collection<Address> recipients, boolean sync) {
if (log.isTraceEnabled()) {
log.tracef("Total Order Anycast transaction %s with Total Order", command.getGlobalTransaction().globalId());
}
if (!ctx.hasModifications()) {
return;
}
if (!ctx.isOriginLocal()) {
throw new IllegalStateException("Expected a local context while TO-Anycast prepare command");
}
if (!(command instanceof VersionedPrepareCommand)) {
throw new IllegalStateException("Expected a Versioned Prepare Command in version aware component");
}
try {
KeysValidateFilter responseFilter = ctx.getCacheTransaction().hasModification(ClearCommand.class) || isSyncCommitPhase() ?
null : new KeysValidateFilter(rpcManager.getAddress(), ctx.getAffectedKeys());
setVersionsSeenOnPrepareCommand((VersionedPrepareCommand) command, ctx);
totalOrderAnycastPrepare(recipients, command, responseFilter);
if (responseFilter != null && !responseFilter.isAllKeysValidated()) {
throw new CacheException("Not all keys were validated. Possible member has left the cluster");
}
} finally {
transactionRemotelyPrepared(ctx);
}
}
@Override
protected void lockAndWrap(InvocationContext ctx, Object key, InternalCacheEntry ice, FlagAffectedCommand command) throws InterruptedException {
entryFactory.wrapEntryForPut(ctx, key, ice, false, command);
}
}