package org.infinispan.interceptors.impl;
import static org.infinispan.commons.util.Util.toStr;
import java.util.Collection;
import java.util.Collections;
import javax.transaction.Status;
import javax.transaction.SystemException;
import javax.transaction.Transaction;
import org.infinispan.InvalidCacheUsageException;
import org.infinispan.commands.FlagAffectedCommand;
import org.infinispan.commands.VisitableCommand;
import org.infinispan.commands.control.LockControlCommand;
import org.infinispan.commands.tx.TransactionBoundaryCommand;
import org.infinispan.commands.write.WriteCommand;
import org.infinispan.commons.CacheException;
import org.infinispan.context.InvocationContext;
import org.infinispan.context.impl.FlagBitSets;
import org.infinispan.context.impl.TxInvocationContext;
import org.infinispan.factories.ComponentRegistry;
import org.infinispan.factories.annotations.Inject;
import org.infinispan.factories.annotations.Start;
import org.infinispan.factories.annotations.Stop;
import org.infinispan.interceptors.BaseAsyncInterceptor;
import org.infinispan.interceptors.InvocationExceptionFunction;
import org.infinispan.interceptors.totalorder.RetryPrepareException;
import org.infinispan.lifecycle.ComponentStatus;
import org.infinispan.manager.CacheContainer;
import org.infinispan.statetransfer.OutdatedTopologyException;
import org.infinispan.transaction.WriteSkewException;
import org.infinispan.transaction.impl.AbstractCacheTransaction;
import org.infinispan.transaction.impl.TransactionTable;
import org.infinispan.util.logging.Log;
import org.infinispan.util.logging.LogFactory;
/**
* @author Mircea.Markus@jboss.com
* @author Galder Zamarreño
* @since 9.0
*/
public class InvocationContextInterceptor extends BaseAsyncInterceptor {
private ComponentRegistry componentRegistry;
private TransactionTable txTable;
private static final Log log = LogFactory.getLog(InvocationContextInterceptor.class);
private static final boolean trace = log.isTraceEnabled();
private volatile boolean shuttingDown = false;
private final InvocationExceptionFunction suppressExceptionsHandler = new InvocationExceptionFunction() {
@Override
public Object apply(InvocationContext rCtx, VisitableCommand rCommand, Throwable throwable) throws Throwable {
if (throwable instanceof InvalidCacheUsageException || throwable instanceof InterruptedException) {
throw throwable;
} else {
rethrowException(rCtx, rCommand, throwable);
}
// Ignore the exception
return rCommand instanceof LockControlCommand ? Boolean.FALSE : null;
}
};
@Start(priority = 1)
private void setStartStatus() {
shuttingDown = false;
}
@Stop(priority = 1)
private void setStopStatus() {
shuttingDown = true;
}
@Inject
public void init(ComponentRegistry componentRegistry, TransactionTable txTable) {
this.componentRegistry = componentRegistry;
this.txTable = txTable;
}
@Override
public Object visitCommand(InvocationContext ctx, VisitableCommand command) throws Throwable {
if (trace)
log.tracef("Invoked with command %s and InvocationContext [%s]", command, ctx);
if (ctx == null)
throw new IllegalStateException("Null context not allowed!!");
ComponentStatus status = componentRegistry.getStatus();
if (!status.allowInvocations()) {
ignoreCommand(ctx, command, status);
}
return invokeNextAndExceptionally(ctx, command, suppressExceptionsHandler);
}
private void ignoreCommand(InvocationContext ctx, VisitableCommand command, ComponentStatus status)
throws Exception {
switch (status) {
case FAILED:
case TERMINATED:
throw log.cacheIsTerminated(getCacheNamePrefix(), status.toString());
case STOPPING:
if (stoppingAndNotAllowed(status, ctx)) {
throw log.cacheIsStopping(getCacheNamePrefix());
}
default:
// Allow the command to run
}
}
private void rethrowException(InvocationContext ctx, VisitableCommand command, Throwable th) throws Throwable {
// Only check for fail silently if there's a failure :)
boolean suppressExceptions = (command instanceof FlagAffectedCommand)
&& ((FlagAffectedCommand) command).hasAnyFlag(FlagBitSets.FAIL_SILENTLY);
// If we are shutting down there is every possibility that the invocation fails.
suppressExceptions = suppressExceptions || shuttingDown;
if (suppressExceptions) {
if (shuttingDown)
log.trace("Exception while executing code, but we're shutting down so failing silently.", th);
else
log.trace("Exception while executing code, failing silently...", th);
} else {
if (th instanceof WriteSkewException) {
// We log this as DEBUG rather than ERROR - see ISPN-2076
log.debug("Exception executing call", th);
} else if (th instanceof OutdatedTopologyException) {
log.tracef("Topology changed, notifying the originator: %s", th);
} else if (th instanceof RetryPrepareException) {
log.debugf("Retrying total order prepare command for transaction %s, affected keys %s",
ctx.getLockOwner(), toStr(extractWrittenKeys(ctx, command)));
} else {
Collection<?> affectedKeys = extractWrittenKeys(ctx, command);
log.executionError(command.getClass().getSimpleName(), toStr(affectedKeys), th);
}
if (ctx.isInTxScope() && ctx.isOriginLocal()) {
if (trace) log.trace("Transaction marked for rollback as exception was received.");
markTxForRollback(ctx);
}
if (ctx.isOriginLocal() && !(th instanceof CacheException)) {
th = new CacheException(th);
}
throw th;
}
}
private Collection<?> extractWrittenKeys(InvocationContext ctx, VisitableCommand command) {
if (command instanceof WriteCommand) {
return ((WriteCommand) command).getAffectedKeys();
} else if (command instanceof LockControlCommand) {
return Collections.emptyList();
} else if (command instanceof TransactionBoundaryCommand) {
return ((TxInvocationContext<AbstractCacheTransaction>) ctx).getAffectedKeys();
}
return Collections.emptyList();
}
private String getCacheNamePrefix() {
String cacheName = componentRegistry.getCacheName();
String prefix = "Cache '" + cacheName + "'";
if (cacheName.equals(CacheContainer.DEFAULT_CACHE_NAME))
prefix = "Default cache";
return prefix;
}
/**
* If the cache is STOPPING, non-transaction invocations, or transactional invocations for transaction others than
* the ongoing ones, are no allowed. This method returns true if under this circumstances meet. Otherwise, it returns
* false.
*/
private boolean stoppingAndNotAllowed(ComponentStatus status, InvocationContext ctx) throws Exception {
return status.isStopping() && (!ctx.isInTxScope() || !isOngoingTransaction(ctx));
}
private void markTxForRollback(InvocationContext ctx) throws Throwable {
if (ctx.isOriginLocal() && ctx.isInTxScope()) {
Transaction transaction = ((TxInvocationContext) ctx).getTransaction();
if (transaction != null && isValidRunningTx(transaction)) {
transaction.setRollbackOnly();
}
}
}
private boolean isValidRunningTx(Transaction tx) throws Exception {
int status;
try {
status = tx.getStatus();
} catch (SystemException e) {
throw new CacheException("Unexpected!", e);
}
return status == Status.STATUS_ACTIVE;
}
private boolean isOngoingTransaction(InvocationContext ctx) throws SystemException {
if (!ctx.isInTxScope())
return false;
if (ctx.isOriginLocal())
return txTable.containsLocalTx(((TxInvocationContext) ctx).getGlobalTransaction());
else
return txTable.containRemoteTx(((TxInvocationContext) ctx).getGlobalTransaction());
}
}