/*
* Licensed to the Apache Software Foundation (ASF) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional information regarding
* copyright ownership. The ASF licenses this file to You 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.
*/
package org.apache.geode.internal.cache.tier.sockets.command;
import java.io.DataOutput;
import java.io.DataOutputStream;
import java.io.IOException;
import java.nio.ByteBuffer;
import org.apache.geode.InvalidDeltaException;
import org.apache.geode.cache.DynamicRegionFactory;
import org.apache.geode.cache.Operation;
import org.apache.geode.cache.RegionDestroyedException;
import org.apache.geode.cache.ResourceException;
import org.apache.geode.cache.operations.PutOperationContext;
import org.apache.geode.distributed.internal.DistributionStats;
import org.apache.geode.internal.HeapDataOutputStream;
import org.apache.geode.internal.InternalDataSerializer;
import org.apache.geode.internal.Version;
import org.apache.geode.internal.cache.CachedDeserializable;
import org.apache.geode.internal.cache.EventID;
import org.apache.geode.internal.cache.EventIDHolder;
import org.apache.geode.internal.cache.LocalRegion;
import org.apache.geode.internal.cache.PartitionedRegion;
import org.apache.geode.internal.cache.TXManagerImpl;
import org.apache.geode.internal.cache.Token;
import org.apache.geode.internal.cache.tier.CachedRegionHelper;
import org.apache.geode.internal.cache.tier.Command;
import org.apache.geode.internal.cache.tier.MessageType;
import org.apache.geode.internal.cache.tier.sockets.BaseCommand;
import org.apache.geode.internal.cache.tier.sockets.CacheServerStats;
import org.apache.geode.internal.cache.tier.sockets.Message;
import org.apache.geode.internal.cache.tier.sockets.Part;
import org.apache.geode.internal.cache.tier.sockets.ServerConnection;
import org.apache.geode.internal.cache.versions.VersionTag;
import org.apache.geode.internal.i18n.LocalizedStrings;
import org.apache.geode.internal.logging.log4j.LocalizedMessage;
import org.apache.geode.internal.security.AuthorizeRequest;
import org.apache.geode.internal.util.Breadcrumbs;
import org.apache.geode.security.GemFireSecurityException;
/**
* @since GemFire 6.5
*/
public class Put65 extends BaseCommand {
private final static Put65 singleton = new Put65();
public static Command getCommand() {
return singleton;
}
@Override
public void cmdExecute(Message msg, ServerConnection servConn, long p_start)
throws IOException, InterruptedException {
long start = p_start;
Part regionNamePart = null, keyPart = null, valuePart = null, callbackArgPart = null;
String regionName = null;
Object callbackArg = null, key = null;
Part eventPart = null;
StringBuffer errMessage = new StringBuffer();
boolean isDelta = false;
CachedRegionHelper crHelper = servConn.getCachedRegionHelper();
CacheServerStats stats = servConn.getCacheServerStats();
// requiresResponse = true;
servConn.setAsTrue(REQUIRES_RESPONSE);
{
long oldStart = start;
start = DistributionStats.getStatTime();
stats.incReadPutRequestTime(start - oldStart);
}
// Retrieve the data from the message parts
int idx = 0;
regionNamePart = msg.getPart(idx++);
Operation operation;
try {
operation = (Operation) msg.getPart(idx++).getObject();
if (operation == null) { // native clients send a null since the op is java-serialized
operation = Operation.UPDATE;
}
} catch (ClassNotFoundException e) {
writeException(msg, e, false, servConn);
servConn.setAsTrue(RESPONDED);
return;
}
int flags = msg.getPart(idx++).getInt();
boolean requireOldValue = ((flags & 0x01) == 0x01);
boolean haveExpectedOldValue = ((flags & 0x02) == 0x02);
Object expectedOldValue = null;
if (haveExpectedOldValue) {
try {
expectedOldValue = msg.getPart(idx++).getObject();
} catch (ClassNotFoundException e) {
writeException(msg, e, false, servConn);
servConn.setAsTrue(RESPONDED);
return;
}
}
keyPart = msg.getPart(idx++);
try {
isDelta = ((Boolean) msg.getPart(idx).getObject()).booleanValue();
idx += 1;
} catch (Exception e) {
writeException(msg, MessageType.PUT_DELTA_ERROR, e, false, servConn);
servConn.setAsTrue(RESPONDED);
// CachePerfStats not available here.
return;
}
valuePart = msg.getPart(idx++);
eventPart = msg.getPart(idx++);
if (msg.getNumberOfParts() > idx) {
callbackArgPart = msg.getPart(idx++);
try {
callbackArg = callbackArgPart.getObject();
} catch (Exception e) {
writeException(msg, e, false, servConn);
servConn.setAsTrue(RESPONDED);
return;
}
}
regionName = regionNamePart.getString();
try {
key = keyPart.getStringOrObject();
} catch (Exception e) {
writeException(msg, e, false, servConn);
servConn.setAsTrue(RESPONDED);
return;
}
final boolean isDebugEnabled = logger.isDebugEnabled();
if (isDebugEnabled) {
logger.debug(
"{}: Received {}put request ({} bytes) from {} for region {} key {} txId {} posdup: {}",
servConn.getName(), (isDelta ? " delta " : " "), msg.getPayloadLength(),
servConn.getSocketString(), regionName, key, msg.getTransactionId(), msg.isRetry());
}
// Process the put request
if (key == null || regionName == null) {
if (key == null) {
String putMsg = " The input key for the put request is null";
if (isDebugEnabled) {
logger.debug("{}:{}", servConn.getName(), putMsg);
}
errMessage.append(putMsg);
}
if (regionName == null) {
String putMsg = " The input region name for the put request is null";
if (isDebugEnabled) {
logger.debug("{}:{}", servConn.getName(), putMsg);
}
errMessage.append(putMsg);
}
writeErrorResponse(msg, MessageType.PUT_DATA_ERROR, errMessage.toString(), servConn);
servConn.setAsTrue(RESPONDED);
return;
}
LocalRegion region = (LocalRegion) servConn.getCache().getRegion(regionName);
if (region == null) {
String reason = " was not found during put request";
writeRegionDestroyedEx(msg, regionName, reason, servConn);
servConn.setAsTrue(RESPONDED);
return;
}
if (valuePart.isNull() && operation != Operation.PUT_IF_ABSENT && region.containsKey(key)) {
// Invalid to 'put' a null value in an existing key
String putMsg = " Attempted to put a null value for existing key " + key;
if (isDebugEnabled) {
logger.debug("{}:{}", servConn.getName(), putMsg);
}
errMessage.append(putMsg);
writeErrorResponse(msg, MessageType.PUT_DATA_ERROR, errMessage.toString(), servConn);
servConn.setAsTrue(RESPONDED);
return;
}
ByteBuffer eventIdPartsBuffer = ByteBuffer.wrap(eventPart.getSerializedForm());
long threadId = EventID.readEventIdPartsFromOptmizedByteArray(eventIdPartsBuffer);
long sequenceId = EventID.readEventIdPartsFromOptmizedByteArray(eventIdPartsBuffer);
EventIDHolder clientEvent =
new EventIDHolder(new EventID(servConn.getEventMemberIDByteArray(), threadId, sequenceId));
Breadcrumbs.setEventId(clientEvent.getEventId());
// msg.isRetry might be set by v7.0 and later clients
if (msg.isRetry()) {
// if (logger.isDebugEnabled()) {
// logger.debug("DEBUG: encountered isRetry in Put65");
// }
clientEvent.setPossibleDuplicate(true);
if (region.getAttributes().getConcurrencyChecksEnabled()) {
// recover the version tag from other servers
clientEvent.setRegion(region);
if (!recoverVersionTagForRetriedOperation(clientEvent)) {
clientEvent.setPossibleDuplicate(false); // no-one has seen this event
}
}
}
boolean result = false;
boolean sendOldValue = false;
boolean oldValueIsObject = true;
Object oldValue = null;
try {
Object value = null;
if (!isDelta) {
value = valuePart.getSerializedForm();
}
boolean isObject = valuePart.isObject();
boolean isMetaRegion = region.isUsedForMetaRegion();
msg.setMetaRegion(isMetaRegion);
this.securityService.authorizeRegionWrite(regionName, key.toString());
AuthorizeRequest authzRequest = null;
if (!isMetaRegion) {
authzRequest = servConn.getAuthzRequest();
}
if (authzRequest != null) {
if (DynamicRegionFactory.regionIsDynamicRegionList(regionName)) {
authzRequest.createRegionAuthorize((String) key);
}
// Allow PUT operations on meta regions (bug #38961)
else {
PutOperationContext putContext =
authzRequest.putAuthorize(regionName, key, value, isObject, callbackArg);
value = putContext.getValue();
isObject = putContext.isObject();
callbackArg = putContext.getCallbackArg();
}
}
if (isDebugEnabled) {
logger.debug("processing put65 with operation={}", operation);
}
// If the value is 1 byte and the byte represents null,
// attempt to create the entry. This test needs to be
// moved to DataSerializer or DataSerializer.NULL needs
// to be publicly accessible.
if (operation == Operation.PUT_IF_ABSENT) {
// try {
if (msg.isRetry() && clientEvent.getVersionTag() != null) {
// bug #46590 the operation was successful the last time since it
// was applied to the cache, so return success and the recovered
// version tag
if (isDebugEnabled) {
logger.debug("putIfAbsent operation was successful last time with version {}",
clientEvent.getVersionTag());
}
// invoke basicBridgePutIfAbsent anyway to ensure that the event is distributed to all
// servers - bug #51664
region.basicBridgePutIfAbsent(key, value, isObject, callbackArg, servConn.getProxyID(),
true, clientEvent);
oldValue = null;
} else {
oldValue = region.basicBridgePutIfAbsent(key, value, isObject, callbackArg,
servConn.getProxyID(), true, clientEvent);
}
sendOldValue = true;
oldValueIsObject = true;
Version clientVersion = servConn.getClientVersion();
if (oldValue instanceof CachedDeserializable) {
oldValue = ((CachedDeserializable) oldValue).getSerializedValue();
} else if (oldValue instanceof byte[]) {
oldValueIsObject = false;
} else if ((oldValue instanceof Token) && clientVersion.compareTo(Version.GFE_651) <= 0) {
// older clients don't know that Token is now a DSFID class, so we
// put the token in a serialized form they can consume
HeapDataOutputStream str = new HeapDataOutputStream(Version.CURRENT);
DataOutput dstr = new DataOutputStream(str);
InternalDataSerializer.writeSerializableObject(oldValue, dstr);
oldValue = str.toByteArray();
}
result = true;
// } catch (Exception e) {
// writeException(msg, e, false, servConn);
// servConn.setAsTrue(RESPONDED);
// return;
// }
} else if (operation == Operation.REPLACE) {
// try {
if (requireOldValue) { // <V> replace(<K>, <V>)
if (msg.isRetry() && clientEvent.isConcurrencyConflict()
&& clientEvent.getVersionTag() != null) {
if (isDebugEnabled) {
logger.debug("replace(k,v) operation was successful last time with version {}",
clientEvent.getVersionTag());
}
}
oldValue = region.basicBridgeReplace(key, value, isObject, callbackArg,
servConn.getProxyID(), true, clientEvent);
sendOldValue = !clientEvent.isConcurrencyConflict();
oldValueIsObject = true;
Version clientVersion = servConn.getClientVersion();
if (oldValue instanceof CachedDeserializable) {
oldValue = ((CachedDeserializable) oldValue).getSerializedValue();
} else if (oldValue instanceof byte[]) {
oldValueIsObject = false;
} else if ((oldValue instanceof Token) && clientVersion.compareTo(Version.GFE_651) <= 0) {
// older clients don't know that Token is now a DSFID class, so we
// put the token in a serialized form they can consume
HeapDataOutputStream str = new HeapDataOutputStream(Version.CURRENT);
DataOutput dstr = new DataOutputStream(str);
InternalDataSerializer.writeSerializableObject(oldValue, dstr);
oldValue = str.toByteArray();
}
if (isDebugEnabled) {
logger.debug("returning {} from replace(K,V)", oldValue);
}
result = true;
} else { // boolean replace(<K>, <V>, <V>) {
boolean didPut;
didPut = region.basicBridgeReplace(key, expectedOldValue, value, isObject, callbackArg,
servConn.getProxyID(), true, clientEvent);
if (msg.isRetry() && clientEvent.getVersionTag() != null) {
if (isDebugEnabled) {
logger.debug("replace(k,v,v) operation was successful last time with version {}",
clientEvent.getVersionTag());
}
didPut = true;
}
sendOldValue = true;
oldValueIsObject = true;
oldValue = didPut ? Boolean.TRUE : Boolean.FALSE;
if (isDebugEnabled) {
logger.debug("returning {} from replace(K,V,V)", oldValue);
}
result = true;
}
// } catch (Exception e) {
// writeException(msg, e, false, servConn);
// servConn.setAsTrue(RESPONDED);
// return;
// }
} else if (value == null && !isDelta) {
// Create the null entry. Since the value is null, the value of the
// isObject
// the true after null doesn't matter and is not used.
result = region.basicBridgeCreate(key, null, true, callbackArg, servConn.getProxyID(), true,
clientEvent, false);
if (msg.isRetry() && clientEvent.isConcurrencyConflict()
&& clientEvent.getVersionTag() != null) {
result = true;
if (isDebugEnabled) {
logger.debug("create(k,null) operation was successful last time with version {}",
clientEvent.getVersionTag());
}
}
} else {
// Put the entry
byte[] delta = null;
if (isDelta) {
delta = valuePart.getSerializedForm();
}
TXManagerImpl txMgr = (TXManagerImpl) servConn.getCache().getCacheTransactionManager();
// bug 43068 - use create() if in a transaction and op is CREATE
if (txMgr.getTXState() != null && operation.isCreate()) {
result = region.basicBridgeCreate(key, (byte[]) value, isObject, callbackArg,
servConn.getProxyID(), true, clientEvent, true);
} else {
result = region.basicBridgePut(key, value, delta, isObject, callbackArg,
servConn.getProxyID(), true, clientEvent);
}
if (msg.isRetry() && clientEvent.isConcurrencyConflict()
&& clientEvent.getVersionTag() != null) {
if (isDebugEnabled) {
logger.debug("put(k,v) operation was successful last time with version {}",
clientEvent.getVersionTag());
}
result = true;
}
}
if (result) {
servConn.setModificationInfo(true, regionName, key);
} else {
String message = servConn.getName() + ": Failed to put entry for region " + regionName
+ " key " + key + " value " + valuePart;
if (isDebugEnabled) {
logger.debug(message);
}
throw new Exception(message);
}
} catch (RegionDestroyedException rde) {
writeException(msg, rde, false, servConn);
servConn.setAsTrue(RESPONDED);
return;
} catch (ResourceException re) {
writeException(msg, re, false, servConn);
servConn.setAsTrue(RESPONDED);
return;
} catch (InvalidDeltaException ide) {
logger.info(LocalizedMessage.create(
LocalizedStrings.UpdateOperation_ERROR_APPLYING_DELTA_FOR_KEY_0_OF_REGION_1,
new Object[] {key, regionName}));
writeException(msg, MessageType.PUT_DELTA_ERROR, ide, false, servConn);
servConn.setAsTrue(RESPONDED);
region.getCachePerfStats().incDeltaFullValuesRequested();
return;
} catch (Exception ce) {
// If an interrupted exception is thrown , rethrow it
checkForInterrupt(servConn, ce);
// If an exception occurs during the put, preserve the connection
writeException(msg, ce, false, servConn);
servConn.setAsTrue(RESPONDED);
if (ce instanceof GemFireSecurityException) {
// Fine logging for security exceptions since these are already
// logged by the security logger
if (isDebugEnabled) {
logger.debug("{}: Unexpected Security exception", servConn.getName(), ce);
}
} else if (isDebugEnabled) {
logger.debug("{}: Unexpected Exception", servConn.getName(), ce);
}
return;
} finally {
long oldStart = start;
start = DistributionStats.getStatTime();
stats.incProcessPutTime(start - oldStart);
}
// Increment statistics and write the reply
if (region instanceof PartitionedRegion) {
PartitionedRegion pr = (PartitionedRegion) region;
if (pr.getNetworkHopType() != PartitionedRegion.NETWORK_HOP_NONE) {
writeReplyWithRefreshMetadata(msg, servConn, pr, sendOldValue, oldValueIsObject, oldValue,
pr.getNetworkHopType(), clientEvent.getVersionTag());
pr.clearNetworkHopData();
} else {
writeReply(msg, servConn, sendOldValue, oldValueIsObject, oldValue,
clientEvent.getVersionTag());
}
} else {
writeReply(msg, servConn, sendOldValue, oldValueIsObject, oldValue,
clientEvent.getVersionTag());
}
servConn.setAsTrue(RESPONDED);
if (isDebugEnabled) {
logger.debug("{}: Sent put response back to {} for region {} key {} value {}",
servConn.getName(), servConn.getSocketString(), regionName, key, valuePart);
}
stats.incWritePutResponseTime(DistributionStats.getStatTime() - start);
}
protected void writeReply(Message origMsg, ServerConnection servConn, boolean sendOldValue,
boolean oldValueIsObject, Object oldValue, VersionTag tag) throws IOException {
Message replyMsg = servConn.getReplyMessage();
servConn.getCache().getCancelCriterion().checkCancelInProgress(null);
replyMsg.setMessageType(MessageType.REPLY);
replyMsg.setNumberOfParts(sendOldValue ? 3 : 1);
replyMsg.setTransactionId(origMsg.getTransactionId());
replyMsg.addBytesPart(OK_BYTES);
if (sendOldValue) {
replyMsg.addIntPart(oldValueIsObject ? 1 : 0);
replyMsg.addObjPart(oldValue);
}
replyMsg.send(servConn);
if (logger.isTraceEnabled()) {
logger.trace("{}: rpl tx: {} parts={}", servConn.getName(), origMsg.getTransactionId(),
replyMsg.getNumberOfParts());
}
}
protected void writeReplyWithRefreshMetadata(Message origMsg, ServerConnection servConn,
PartitionedRegion pr, boolean sendOldValue, boolean oldValueIsObject, Object oldValue,
byte nwHopType, VersionTag tag) throws IOException {
Message replyMsg = servConn.getReplyMessage();
servConn.getCache().getCancelCriterion().checkCancelInProgress(null);
replyMsg.setMessageType(MessageType.REPLY);
replyMsg.setNumberOfParts(sendOldValue ? 3 : 1);
replyMsg.setTransactionId(origMsg.getTransactionId());
replyMsg.addBytesPart(new byte[] {pr.getMetadataVersion(), nwHopType});
if (sendOldValue) {
replyMsg.addIntPart(oldValueIsObject ? 1 : 0);
replyMsg.addObjPart(oldValue);
}
replyMsg.send(servConn);
pr.getPrStats().incPRMetaDataSentCount();
if (logger.isTraceEnabled()) {
logger.trace("{}: rpl with REFRESH_METADAT tx: {} parts={}", servConn.getName(),
origMsg.getTransactionId(), replyMsg.getNumberOfParts());
}
}
}