/*
* 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;
import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.util.Set;
import org.apache.logging.log4j.Logger;
import org.apache.geode.DataSerializer;
import org.apache.geode.cache.CacheException;
import org.apache.geode.cache.EntryNotFoundException;
import org.apache.geode.distributed.internal.DM;
import org.apache.geode.distributed.internal.DistributionManager;
import org.apache.geode.distributed.internal.DistributionMessage;
import org.apache.geode.distributed.internal.InternalDistributedSystem;
import org.apache.geode.distributed.internal.ReplyException;
import org.apache.geode.distributed.internal.ReplyMessage;
import org.apache.geode.distributed.internal.ReplyProcessor21;
import org.apache.geode.distributed.internal.membership.InternalDistributedMember;
import org.apache.geode.internal.NanoTimer;
import org.apache.geode.internal.cache.versions.VersionTag;
import org.apache.geode.internal.i18n.LocalizedStrings;
import org.apache.geode.internal.logging.LogService;
import org.apache.geode.internal.logging.log4j.LogMarker;
/**
* This message is used to request a VersionTag from a remote member.
*
* DistributedRegions with DataPolicy EMPTY, NORMAL, PRELOADED, can use this message to fetch
* VersionTag for a key.
*
* @since GemFire 7.0
*/
public final class RemoteFetchVersionMessage extends RemoteOperationMessage {
private static final Logger logger = LogService.getLogger();
private Object key;
/** for deserialization */
public RemoteFetchVersionMessage() {}
/**
* Send RemoteFetchVersionMessage to the recipient for the given key
*
* @param recipient
* @param r
* @param key
* @return the processor used to fetch the VersionTag for the key
* @throws RemoteOperationException if the member is no longer available
*/
public static FetchVersionResponse send(InternalDistributedMember recipient, LocalRegion r,
Object key) throws RemoteOperationException {
FetchVersionResponse response = new FetchVersionResponse(r.getSystem(), recipient);
RemoteFetchVersionMessage msg =
new RemoteFetchVersionMessage(recipient, r.getFullPath(), response, key);
Set<?> failures = r.getDistributionManager().putOutgoing(msg);
if (failures != null && failures.size() > 0) {
throw new RemoteOperationException(
LocalizedStrings.GetMessage_FAILED_SENDING_0.toLocalizedString(msg));
}
return response;
}
private RemoteFetchVersionMessage(InternalDistributedMember recipient, String regionPath,
ReplyProcessor21 processor, Object key) {
super(recipient, regionPath, processor);
this.key = key;
}
@Override
public int getDSFID() {
return R_FETCH_VERSION_MESSAGE;
}
@Override
public boolean isSevereAlertCompatible() {
// allow forced-disconnect processing for all cache op messages
return true;
}
@Override
public int getProcessorType() {
return DistributionManager.SERIAL_EXECUTOR;
}
@Override
public void fromData(DataInput in) throws IOException, ClassNotFoundException {
super.fromData(in);
this.key = DataSerializer.readObject(in);
}
@Override
public void toData(DataOutput out) throws IOException {
super.toData(out);
DataSerializer.writeObject(this.key, out);
}
@Override
protected boolean operateOnRegion(DistributionManager dm, LocalRegion r, long startTime)
throws RemoteOperationException {
if (!(r instanceof PartitionedRegion)) {
r.waitOnInitialization();
}
VersionTag tag;
try {
RegionEntry re = r.getRegionEntry(key);
if (re == null) {
if (logger.isTraceEnabled(LogMarker.DM)) {
logger.trace(LogMarker.DM, "RemoteFetchVersionMessage did not find entry for key:{}",
key);
}
r.checkEntryNotFound(key);
}
tag = re.getVersionStamp().asVersionTag();
if (logger.isTraceEnabled(LogMarker.DM)) {
logger.debug("RemoteFetchVersionMessage for key:{} returning tag:{}", key, tag);
}
FetchVersionReplyMessage.send(getSender(), processorId, tag, dm);
} catch (EntryNotFoundException e) {
sendReply(getSender(), getProcessorId(), dm, new ReplyException(e), r, startTime);
}
return false;
}
/**
* This message is used to send a reply for RemoteFetchVersionMessage.
*
*/
public static final class FetchVersionReplyMessage extends ReplyMessage {
private VersionTag tag;
/** for deserialization */
public FetchVersionReplyMessage() {}
private FetchVersionReplyMessage(int processorId, VersionTag tag) {
setProcessorId(processorId);
this.tag = tag;
}
public static void send(InternalDistributedMember recipient, int processorId, VersionTag tag,
DM dm) {
FetchVersionReplyMessage reply = new FetchVersionReplyMessage(processorId, tag);
reply.setRecipient(recipient);
dm.putOutgoing(reply);
}
@Override
public void process(DM dm, ReplyProcessor21 processor) {
final long startTime = getTimestamp();
final boolean isDebugEnabled = logger.isTraceEnabled(LogMarker.DM);
if (isDebugEnabled) {
logger.trace(LogMarker.DM,
"FetchVersionReplyMessage process invoking reply processor with processorId:{}",
this.processorId);
}
if (processor == null) {
if (isDebugEnabled) {
logger.debug("FetchVersionReplyMessage processor not found");
}
return;
}
processor.process(this);
if (isDebugEnabled) {
logger.trace(LogMarker.DM, "{} Processed {}", processor, this);
}
dm.getStats().incReplyMessageTime(NanoTimer.getTime() - startTime);
}
@Override
public int getDSFID() {
return R_FETCH_VERSION_REPLY;
}
@Override
public void toData(DataOutput out) throws IOException {
super.toData(out);
DataSerializer.writeObject(this.tag, out);
}
@Override
public void fromData(DataInput in) throws IOException, ClassNotFoundException {
super.fromData(in);
this.tag = DataSerializer.readObject(in);
}
}
/**
* A processor to capture the VersionTag returned by RemoteFetchVersion message.
*
*/
public static class FetchVersionResponse extends RemoteOperationResponse {
private volatile VersionTag tag;
public FetchVersionResponse(InternalDistributedSystem dm, InternalDistributedMember member) {
super(dm, member, true);
}
@Override
public void process(DistributionMessage msg) {
try {
if (msg instanceof FetchVersionReplyMessage) {
FetchVersionReplyMessage reply = (FetchVersionReplyMessage) msg;
this.tag = reply.tag;
if (logger.isTraceEnabled(LogMarker.DM)) {
logger.trace(LogMarker.DM, "FetchVersionResponse return tag is {}", this.tag);
}
}
} finally {
super.process(msg);
}
}
public VersionTag waitForResponse() throws RemoteOperationException {
try {
waitForCacheException();
} catch (RemoteOperationException e) {
logger.debug("RemoteFetchVersionMessage threw", e);
throw e;
} catch (EntryNotFoundException e) {
logger.debug("RemoteFetchVersionMessage threw", e);
throw e;
} catch (CacheException e) {
logger.debug("RemoteFetchVersionMessage threw", e);
throw new RemoteOperationException("RemoteFetchVersionMessage threw exception", e);
}
return tag;
}
}
}