com.gemstone.gemfire.internal.cache.partitioned.ContainsKeyValueMessage Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation
Show all versions of gemfire-core Show documentation
TIBCO ComputeDB store based off Pivotal GemFireXD
/*
* Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
*
* 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. See accompanying
* LICENSE file.
*/
package com.gemstone.gemfire.internal.cache.partitioned;
import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.util.Collections;
import java.util.Set;
import com.gemstone.gemfire.DataSerializer;
import com.gemstone.gemfire.cache.CacheException;
import com.gemstone.gemfire.distributed.internal.DM;
import com.gemstone.gemfire.distributed.internal.DirectReplyProcessor;
import com.gemstone.gemfire.distributed.internal.DistributionManager;
import com.gemstone.gemfire.distributed.internal.DistributionMessage;
import com.gemstone.gemfire.distributed.internal.DistributionStats;
import com.gemstone.gemfire.distributed.internal.InternalDistributedSystem;
import com.gemstone.gemfire.distributed.internal.ReplyMessage;
import com.gemstone.gemfire.distributed.internal.ReplyProcessor21;
import com.gemstone.gemfire.distributed.internal.ReplySender;
import com.gemstone.gemfire.distributed.internal.membership.InternalDistributedMember;
import com.gemstone.gemfire.i18n.LogWriterI18n;
import com.gemstone.gemfire.internal.Assert;
import com.gemstone.gemfire.internal.cache.ForceReattemptException;
import com.gemstone.gemfire.internal.cache.KeyWithRegionContext;
import com.gemstone.gemfire.internal.cache.PartitionedRegion;
import com.gemstone.gemfire.internal.cache.PartitionedRegionDataStore;
import com.gemstone.gemfire.internal.cache.PrimaryBucketException;
import com.gemstone.gemfire.internal.cache.TXStateInterface;
import com.gemstone.gemfire.internal.i18n.LocalizedStrings;
public final class ContainsKeyValueMessage extends PartitionMessageWithDirectReply
{
private boolean valueCheck;
private Object key;
private Integer bucketId;
public ContainsKeyValueMessage() {
super();
}
private ContainsKeyValueMessage(InternalDistributedMember recipient,
int regionId, DirectReplyProcessor processor, TXStateInterface tx,
Object key, Integer bucketId, boolean valueCheck) {
super(recipient, regionId, processor, tx);
this.valueCheck = valueCheck;
this.key = key;
this.bucketId = bucketId;
}
/**
* Sends a PartitionedRegion message for either
* {@link com.gemstone.gemfire.cache.Region#containsKey(Object)}or
* {@link com.gemstone.gemfire.cache.Region#containsValueForKey(Object)}
* depending on the valueCheck argument
*
* @param recipient
* the member that the contains keys/value message is sent to
* @param r
* the PartitionedRegion that contains the bucket
* @param tx
* the current TX state
* @param key
* the key to be queried
* @param bucketId
* the identity of the bucket to be queried
* @param valueCheck
* true if
* {@link com.gemstone.gemfire.cache.Region#containsValueForKey(Object)}
* is desired, false if
* {@link com.gemstone.gemfire.cache.Region#containsKey(Object)}is
* desired
* @return the processor used to read the returned keys
* @throws ForceReattemptException if the peer is no longer available
*/
public static ContainsKeyValueResponse send(
InternalDistributedMember recipient, PartitionedRegion r,
TXStateInterface tx, Object key, Integer bucketId, boolean valueCheck)
throws ForceReattemptException {
Assert.assertTrue(recipient != null,
"PRDistribuedContainsKeyValueMessage NULL reply message");
ContainsKeyValueResponse p = new ContainsKeyValueResponse(r.getSystem(),
Collections.singleton(recipient), key, tx);
ContainsKeyValueMessage m = new ContainsKeyValueMessage(recipient, r
.getPRId(), p, tx, key, bucketId, valueCheck);
Set failures = r.getDistributionManager().putOutgoing(m);
if (failures != null && failures.size() > 0) {
throw new ForceReattemptException(LocalizedStrings.ContainsKeyValueMessage_FAILED_SENDING_0.toLocalizedString(m));
}
return p;
}
@Override
public final int getMessageProcessorType() {
// don't use SERIAL_EXECUTOR if we may have to wait for a pending TX
// else if may deadlock as the p2p msg reader thread will be blocked
// don't use SERIAL_EXECUTOR for RepeatableRead isolation level else
// it can block P2P reader thread thus blocking any possible commits
// which could have released the SH lock this thread is waiting on
if (this.pendingTXId == null && !canStartRemoteTransaction()) {
// Make this serial so that it will be processed in the p2p msg reader
// which gives it better performance.
return DistributionManager.SERIAL_EXECUTOR;
}
else {
return DistributionManager.PARTITIONED_REGION_EXECUTOR;
}
}
@Override
public boolean isSevereAlertCompatible() {
// allow forced-disconnect processing for all cache op messages
return true;
}
@Override
protected boolean operateOnPartitionedRegion(DistributionManager dm,
PartitionedRegion r, long startTime) throws CacheException,
ForceReattemptException
{
LogWriterI18n l = r.getCache().getLoggerI18n();
PartitionedRegionDataStore ds = r.getDataStore();
final boolean replyVal;
if (ds != null) {
try {
r.operationStart();
if (r.keyRequiresRegionContext()) {
((KeyWithRegionContext)this.key).setRegionContext(r);
}
if (this.valueCheck) {
replyVal = ds.containsValueForKeyLocally(this.bucketId, this.key);
} else {
replyVal = ds.containsKeyLocally(this.bucketId, this.key);
}
} catch (PRLocallyDestroyedException pde) {
throw new ForceReattemptException(LocalizedStrings.ContainsKeyValueMessage_ENOUNTERED_PRLOCALLYDESTROYEDEXCEPTION.toLocalizedString(), pde);
} finally {
r.operationCompleted();
}
r.getPrStats().endPartitionMessagesProcessing(startTime);
ContainsKeyValueReplyMessage.send(getSender(), getProcessorId(), getReplySender(dm),
replyVal, this);
}
else {
l.severe(
LocalizedStrings.ContainsKeyValueMess_PARTITIONED_REGION_0_IS_NOT_CONFIGURED_TO_STORE_DATA,
r.getFullPath());
ForceReattemptException fre = new ForceReattemptException(LocalizedStrings.ContainsKeyValueMessage_PARTITIONED_REGION_0_ON_1_IS_NOT_CONFIGURED_TO_STORE_DATA.toLocalizedString(new Object[] {r.getFullPath(), dm.getId()}));
fre.setHash(key.hashCode());
throw fre;
}
// Unless there was an exception thrown, this message handles sending the
// response
return false;
}
@Override
public final boolean canStartRemoteTransaction() {
return getLockingPolicy().readCanStartTX();
}
@Override
protected void appendFields(StringBuilder buff) {
super.appendFields(buff);
buff.append("; valueCheck=").append(this.valueCheck).append("; key=")
.append(this.key).append("; bucketId=").append(this.bucketId);
}
public int getDSFID() {
return PR_CONTAINS_KEY_VALUE_MESSAGE;
}
@Override
public void fromData(DataInput in)
throws IOException, ClassNotFoundException {
super.fromData(in);
this.key = DataSerializer.readObject(in);
this.valueCheck = in.readBoolean();
this.bucketId = Integer.valueOf(in.readInt());
}
@Override
public void toData(DataOutput out)
throws IOException {
super.toData(out);
DataSerializer.writeObject(this.key, out);
out.writeBoolean(this.valueCheck);
out.writeInt(this.bucketId.intValue());
}
public static final class ContainsKeyValueReplyMessage extends
ReplyMessage
{
/** Propagated exception from remote node to operation initiator */
private boolean containsKeyValue;
/**
* Empty constructor to conform to DataSerializable interface
*/
public ContainsKeyValueReplyMessage() {
}
private ContainsKeyValueReplyMessage(int processorId,
boolean containsKeyValue, ContainsKeyValueMessage sourceMessage) {
super(sourceMessage, true, true);
this.processorId = processorId;
this.containsKeyValue = containsKeyValue;
}
/** Send an ack */
public static void send(InternalDistributedMember recipient, int processorId,
ReplySender replySender, boolean containsKeyValue,
ContainsKeyValueMessage sourceMessage)
{
Assert.assertTrue(recipient != null,
"ContainsKeyValueReplyMessage NULL reply message");
ContainsKeyValueReplyMessage m = new ContainsKeyValueReplyMessage(
processorId, containsKeyValue, sourceMessage);
m.setRecipient(recipient);
replySender.putOutgoing(m);
}
/**
* Processes this message. This method is invoked by the receiver of the
* message.
*
* @param dm
* the distribution manager that is processing the message.
*/
@Override
public void process(final DM dm, ReplyProcessor21 processor)
{
final long startTime = getTimestamp();
LogWriterI18n l = dm.getLoggerI18n();
//if (DistributionManager.VERBOSE) {
// l.fine("ContainsKeyValueReplyMessage process invoking reply processor with processorId:"
// + this.processorId);
//}
if (processor == null) {
if (DistributionManager.VERBOSE) {
l.fine("ContainsKeyValueReplyMessage processor not found");
}
return;
}
processor.process(this);
if (DistributionManager.VERBOSE) {
LogWriterI18n logger = dm.getLoggerI18n();
logger.info(LocalizedStrings.ContainsKeyValueMessage_0__PROCESSED__1, new Object[] {processor, this});
}
dm.getStats().incReplyMessageTime(DistributionStats.getStatTime() - startTime);
}
@Override
public int getDSFID() {
return PR_CONTAINS_KEY_VALUE_REPLY_MESSAGE;
}
@Override
public void fromData(DataInput in) throws IOException,
ClassNotFoundException
{
super.fromData(in);
this.containsKeyValue = in.readBoolean();
}
@Override
public void toData(DataOutput out) throws IOException
{
super.toData(out);
out.writeBoolean(this.containsKeyValue);
}
@Override
public String toString()
{
StringBuffer sb = new StringBuffer();
sb.append("ContainsKeyValueReplyMessage ").append(
"processorid=").append(this.processorId).append(" returning ")
.append(doesItContainKeyValue());
return sb.toString();
}
public boolean doesItContainKeyValue()
{
return this.containsKeyValue;
}
}
/**
* A processor to capture the value returned by {@link
* com.gemstone.gemfire.internal.cache.partitioned.ContainsKeyValueMessage.ContainsKeyValueReplyMessage}
*
* @author Mitch Thomas
* @since 5.0
*/
public static class ContainsKeyValueResponse extends PartitionResponse
{
private volatile boolean returnValue;
private volatile boolean returnValueReceived;
final Object key;
public ContainsKeyValueResponse(InternalDistributedSystem ds,
Set recipients, Object key, final TXStateInterface tx) {
super(ds, recipients, false, tx);
this.key = key;
}
@Override
public void process(DistributionMessage msg)
{
try {
if (msg instanceof ContainsKeyValueReplyMessage) {
ContainsKeyValueReplyMessage reply = (ContainsKeyValueReplyMessage)msg;
this.returnValue = reply.doesItContainKeyValue();
this.returnValueReceived = true;
if (DistributionManager.VERBOSE) {
getDistributionManager().getLoggerI18n().fine(
"ContainsKeyValueResponse return value is " + this.returnValue);
}
}
}
finally {
super.process(msg);
}
}
/**
* @return Set the keys associated with the bucketid of the
* {@link ContainsKeyValueMessage}
* @throws ForceReattemptException if the peer is no longer available
* @throws PrimaryBucketException if the instance of the bucket that received this operation was not primary
*/
public boolean waitForContainsResult() throws PrimaryBucketException,
ForceReattemptException {
try {
waitForCacheException();
}
catch (ForceReattemptException rce) {
rce.checkKey(key);
// final String msg = "ContainsKeyValueResponse got ForceReattemptException; rethrowing";
// getDistributionManager().getLogger().fine(msg, rce);
throw rce;
}
catch (PrimaryBucketException pbe) {
// Is this necessary?
throw pbe;
}
catch (CacheException ce) {
getDistributionManager().getLoggerI18n().fine("ContainsKeyValueResponse got remote CacheException; forcing reattempt.", ce);
throw new ForceReattemptException(LocalizedStrings.ContainsKeyValueMessage_CONTAINSKEYVALUERESPONSE_GOT_REMOTE_CACHEEXCEPTION_FORCING_REATTEMPT.toLocalizedString(), ce);
}
if (!this.returnValueReceived) {
throw new ForceReattemptException(LocalizedStrings.ContainsKeyValueMessage_NO_RETURN_VALUE_RECEIVED.toLocalizedString());
}
return this.returnValue;
}
}
}