/*
* JBoss, Home of Professional Open Source
* Copyright 2009 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 is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY 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 along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.infinispan.commands.tx;
import org.infinispan.commands.ReplicableCommand;
import org.infinispan.commands.Visitor;
import org.infinispan.commands.write.PutKeyValueCommand;
import org.infinispan.commands.write.RemoveCommand;
import org.infinispan.commands.write.ReplaceCommand;
import org.infinispan.commands.write.WriteCommand;
import org.infinispan.context.InvocationContext;
import org.infinispan.context.impl.RemoteTxInvocationContext;
import org.infinispan.context.impl.TxInvocationContext;
import org.infinispan.notifications.cachelistener.CacheNotifier;
import org.infinispan.transaction.RemoteTransaction;
import org.infinispan.transaction.xa.GlobalTransaction;
import org.infinispan.transaction.xa.recovery.RecoveryManager;
import org.infinispan.util.logging.Log;
import org.infinispan.util.logging.LogFactory;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
/**
* Command corresponding to the 1st phase of 2PC.
*
* @author Manik Surtani (<a href="mailto:manik@jboss.org">manik@jboss.org</a>)
* @author Mircea.Markus@jboss.com
* @author Pedro Ruivo
* @since 4.0
*/
public class PrepareCommand extends AbstractTransactionBoundaryCommand {
private static final Log log = LogFactory.getLog(PrepareCommand.class);
private boolean trace = log.isTraceEnabled();
public static final byte COMMAND_ID = 12;
protected WriteCommand[] modifications;
protected boolean onePhaseCommit;
protected CacheNotifier notifier;
protected RecoveryManager recoveryManager;
private transient boolean replayEntryWrapping = false;
private static final WriteCommand[] EMPTY_WRITE_COMMAND_ARRAY = new WriteCommand[0];
private transient boolean wasInvoked;
public void initialize(CacheNotifier notifier, RecoveryManager recoveryManager) {
this.notifier = notifier;
this.recoveryManager = recoveryManager;
}
private PrepareCommand() {
super(null); // For command id uniqueness test
}
public PrepareCommand(String cacheName, GlobalTransaction gtx, boolean onePhaseCommit, WriteCommand... modifications) {
super(cacheName);
this.globalTx = gtx;
this.modifications = modifications;
this.onePhaseCommit = onePhaseCommit;
}
public PrepareCommand(String cacheName, GlobalTransaction gtx, List<WriteCommand> commands, boolean onePhaseCommit) {
super(cacheName);
this.globalTx = gtx;
this.modifications = commands == null || commands.isEmpty() ? null : commands.toArray(new WriteCommand[commands.size()]);
this.onePhaseCommit = onePhaseCommit;
}
public PrepareCommand(String cacheName) {
super(cacheName);
}
@Override
public Object perform(InvocationContext ignored) throws Throwable {
if (ignored != null)
throw new IllegalStateException("Expected null context!");
if (recoveryManager != null && recoveryManager.isTransactionPrepared(globalTx)) {
log.tracef("The transaction %s is already prepared. Skipping prepare call.", globalTx);
return null;
}
// 1. first create a remote transaction
RemoteTransaction remoteTransaction = txTable.getOrCreateIfAbsentRemoteTransaction(globalTx);
//Note: the remote transaction is always different from null!
/*
* remote tx was already created by Cache#lock() API call
* set the proper modifications since lock has none
*
* @see LockControlCommand.java
* https://jira.jboss.org/jira/browse/ISPN-48
*/
remoteTransaction.setModifications(getModifications());
reconfigurableReplicationManager.notifyRemoteTransaction(getGlobalTransaction(), modifications);
// 2. then set it on the invocation context
RemoteTxInvocationContext ctx = icc.createRemoteTxInvocationContext(remoteTransaction, getOrigin());
if (trace)
log.tracef("Invoking remotely originated prepare: %s with invocation context: %s", this, ctx);
notifier.notifyTransactionRegistered(ctx.getGlobalTransaction(), ctx);
return invoker.invoke(ctx, this);
}
@Override
public Object acceptVisitor(InvocationContext ctx, Visitor visitor) throws Throwable {
return visitor.visitPrepareCommand((TxInvocationContext) ctx, this);
}
public WriteCommand[] getModifications() {
return modifications == null ? EMPTY_WRITE_COMMAND_ARRAY : modifications;
}
public boolean isOnePhaseCommit() {
return onePhaseCommit;
}
public boolean existModifications() {
return modifications != null && modifications.length > 0;
}
public int getModificationsCount() {
return modifications != null ? modifications.length : 0;
}
@Override
public byte getCommandId() {
return COMMAND_ID;
}
@Override
public Object[] getParameters() {
int numMods = modifications == null ? 0 : modifications.length;
int i = 0;
final int params = 3;
Object[] retval = new Object[numMods + params];
retval[i++] = globalTx;
retval[i++] = onePhaseCommit;
retval[i++] = numMods;
if (numMods > 0) System.arraycopy(modifications, 0, retval, params, numMods);
return retval;
}
@Override
@SuppressWarnings("unchecked")
public void setParameters(int commandId, Object[] args) {
int i = 0;
globalTx = (GlobalTransaction) args[i++];
onePhaseCommit = (Boolean) args[i++];
int numMods = (Integer) args[i++];
if (numMods > 0) {
modifications = new WriteCommand[numMods];
System.arraycopy(args, i, modifications, 0, numMods);
}
}
public PrepareCommand copy() {
PrepareCommand copy = new PrepareCommand(cacheName);
copy.globalTx = globalTx;
copy.modifications = modifications == null ? null : modifications.clone();
copy.onePhaseCommit = onePhaseCommit;
return copy;
}
@Override
public String toString() {
return "PrepareCommand {" +
"modifications=" + getAffectedKeys() +
", onePhaseCommit=" + onePhaseCommit +
", " + super.toString();
}
public boolean containsModificationType(Class<? extends ReplicableCommand> replicableCommandClass) {
for (WriteCommand mod : getModifications()) {
if (mod.getClass().equals(replicableCommandClass)) {
return true;
}
}
return false;
}
public boolean hasModifications() {
return modifications != null && modifications.length > 0;
}
public Set<Object> getAffectedKeys() {
if (modifications == null || modifications.length == 0) return Collections.emptySet();
if (modifications.length == 1) return modifications[0].getAffectedKeys();
Set<Object> keys = new HashSet<Object>(modifications.length);
for (WriteCommand wc: modifications) keys.addAll(wc.getAffectedKeys());
return keys;
}
/**
* If set to true, then the keys touched by this transaction are to be wrapped again and original ones discarded.
*/
public boolean isReplayEntryWrapping() {
return replayEntryWrapping;
}
/**
* @see #isReplayEntryWrapping()
*/
public void setReplayEntryWrapping(boolean replayEntryWrapping) {
this.replayEntryWrapping = replayEntryWrapping;
}
public boolean writesToASingleKey() {
if (modifications == null || modifications.length != 1)
return false;
WriteCommand wc = modifications[0];
return wc instanceof PutKeyValueCommand || wc instanceof RemoveCommand || wc instanceof ReplaceCommand;
}
@Override
public boolean isReturnValueExpected() {
return false;
}
/**
* set the prepare command as one phase commit (when the commit or rollback commands
* are received before the prepare command in total order protocol)
*
* @param onePhaseCommit true for one phase commit, false otherwise
*/
public void setOnePhaseCommit(boolean onePhaseCommit) {
this.onePhaseCommit = onePhaseCommit;
}
public boolean wasInvoked() {
return wasInvoked;
}
public void setWasInvoked(boolean wasInvoked) {
this.wasInvoked = wasInvoked;
}
}