/*
* 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.remoting;
import org.infinispan.CacheException;
import org.infinispan.commands.CancellableCommand;
import org.infinispan.commands.CancellationService;
import org.infinispan.commands.CommandsFactory;
import org.infinispan.commands.remote.CacheRpcCommand;
import org.infinispan.commands.tx.PrepareCommand;
import org.infinispan.commands.tx.totalorder.TotalOrderPrepareCommand;
import org.infinispan.configuration.global.GlobalConfiguration;
import org.infinispan.factories.ComponentRegistry;
import org.infinispan.factories.GlobalComponentRegistry;
import org.infinispan.factories.KnownComponentNames;
import org.infinispan.factories.annotations.ComponentName;
import org.infinispan.factories.annotations.Inject;
import org.infinispan.factories.scopes.Scope;
import org.infinispan.factories.scopes.Scopes;
import org.infinispan.interceptors.totalorder.RetryPrepareException;
import org.infinispan.manager.NamedCacheNotFoundException;
import org.infinispan.statetransfer.StateTransferManager;
import org.infinispan.remoting.responses.ExceptionResponse;
import org.infinispan.remoting.responses.Response;
import org.infinispan.remoting.responses.ResponseGenerator;
import org.infinispan.remoting.transport.Address;
import org.infinispan.remoting.transport.Transport;
import org.infinispan.transaction.TotalOrderRemoteTransactionState;
import org.infinispan.transaction.totalorder.TotalOrderLatch;
import org.infinispan.transaction.totalorder.TotalOrderManager;
import org.infinispan.util.concurrent.BlockingRunnable;
import org.infinispan.util.concurrent.BlockingTaskAwareExecutorService;
import org.infinispan.util.logging.Log;
import org.infinispan.util.logging.LogFactory;
import java.util.concurrent.ExecutorService;
/**
* Sets the cache interceptor chain on an RPCCommand before calling it to perform
*
* @author Manik Surtani
* @since 4.0
*/
@Scope(Scopes.GLOBAL)
public class InboundInvocationHandlerImpl implements InboundInvocationHandler {
private GlobalComponentRegistry gcr;
private static final Log log = LogFactory.getLog(InboundInvocationHandlerImpl.class);
private static final boolean trace = log.isTraceEnabled();
private GlobalConfiguration globalConfiguration;
private Transport transport;
private CancellationService cancelService;
private ExecutorService remoteCommandsExecutor;
private BlockingTaskAwareExecutorService totalOrderExecutorService;
@Inject
public void inject(GlobalComponentRegistry gcr, Transport transport,
@ComponentName(KnownComponentNames.REMOTE_COMMAND_EXECUTOR) ExecutorService remoteCommandsExecutor,
@ComponentName(KnownComponentNames.TOTAL_ORDER_EXECUTOR) BlockingTaskAwareExecutorService totalOrderExecutorService,
GlobalConfiguration globalConfiguration, CancellationService cancelService) {
this.gcr = gcr;
this.transport = transport;
this.globalConfiguration = globalConfiguration;
this.cancelService = cancelService;
this.remoteCommandsExecutor = remoteCommandsExecutor;
this.totalOrderExecutorService = totalOrderExecutorService;
}
@Override
public void handle(final CacheRpcCommand cmd, Address origin, org.jgroups.blocks.Response response, boolean preserveOrder) throws Throwable {
cmd.setOrigin(origin);
String cacheName = cmd.getCacheName();
ComponentRegistry cr = gcr.getNamedComponentRegistry(cacheName);
if (cr == null) {
if (!globalConfiguration.transport().strictPeerToPeer()) {
if (trace) log.tracef("Strict peer to peer off, so silently ignoring that %s cache is not defined", cacheName);
reply(response, null);
return;
}
log.namedCacheDoesNotExist(cacheName);
Response retVal = new ExceptionResponse(new NamedCacheNotFoundException(cacheName, "Cache has not been started on node " + transport.getAddress()));
reply(response, retVal);
return;
}
handleWithWaitForBlocks(cmd, cr, response, preserveOrder);
}
private Response handleInternal(final CacheRpcCommand cmd, final ComponentRegistry cr) throws Throwable {
try {
if (trace) log.tracef("Calling perform() on %s", cmd);
ResponseGenerator respGen = cr.getResponseGenerator();
if(cmd instanceof CancellableCommand){
cancelService.register(Thread.currentThread(), ((CancellableCommand)cmd).getUUID());
}
Object retval = cmd.perform(null);
Response response = respGen.getResponse(cmd, retval);
log.tracef("About to send back response %s for command %s", response, cmd);
return response;
} catch (Exception e) {
log.error("Exception executing command", e);
return new ExceptionResponse(e);
} finally {
if(cmd instanceof CancellableCommand){
cancelService.unregister(((CancellableCommand)cmd).getUUID());
}
}
}
private void handleWithWaitForBlocks(final CacheRpcCommand cmd, final ComponentRegistry cr, final org.jgroups.blocks.Response response, boolean preserveOrder) throws Throwable {
StateTransferManager stm = cr.getStateTransferManager();
// We must have completed the join before handling commands
// (even if we didn't complete the initial state transfer)
if (!stm.isJoinComplete()) {
reply(response, null);
return;
} else if (cmd instanceof TotalOrderPrepareCommand && !stm.ownsData()) {
reply(response, null);
return;
}
CommandsFactory commandsFactory = cr.getCommandsFactory();
// initialize this command with components specific to the intended cache instance
commandsFactory.initializeReplicableCommand(cmd, true);
if (cmd instanceof TotalOrderPrepareCommand) {
final TotalOrderRemoteTransactionState state = ((TotalOrderPrepareCommand) cmd).getOrCreateState();
final TotalOrderManager totalOrderManager = cr.getTotalOrderManager();
totalOrderManager.ensureOrder(state, ((PrepareCommand) cmd).getAffectedKeysToLock(false));
totalOrderExecutorService.execute(new BlockingRunnable() {
@Override
public boolean isReady() {
for (TotalOrderLatch block : state.getConflictingTransactionBlocks()) {
if (block.isBlocked()) {
return false;
}
}
return true;
}
@Override
public void run() {
Response resp;
try {
resp = handleInternal(cmd, cr);
} catch (RetryPrepareException retry) {
log.debugf(retry, "Prepare [%s] conflicted with state transfer", cmd);
resp = new ExceptionResponse(retry);
} catch (Throwable throwable) {
log.exceptionHandlingCommand(cmd, throwable);
resp = new ExceptionResponse(new CacheException("Problems invoking command.", throwable));
}
if (resp instanceof ExceptionResponse) {
totalOrderManager.release(state);
}
//the ResponseGenerated is null in this case because the return value is a Response
reply(response, resp);
}
});
return;
} else if (!preserveOrder && cmd.canBlock()) {
remoteCommandsExecutor.execute(new Runnable() {
@Override
public void run() {
Response resp;
try {
resp = handleInternal(cmd, cr);
} catch (Throwable throwable) {
log.exceptionHandlingCommand(cmd, throwable);
resp = new ExceptionResponse(new CacheException("Problems invoking command.", throwable));
}
reply(response, resp);
}
});
return;
}
Response resp = handleInternal(cmd, cr);
// A null response is valid and OK ...
if (trace && resp != null && !resp.isValid()) {
// invalid response
log.tracef("Unable to execute command, got invalid response %s", resp);
}
reply(response, resp);
}
private void reply(org.jgroups.blocks.Response response, Object retVal) {
if (response != null) {
response.send(retVal, false);
}
}
}