/*
* 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.Collections;
import java.util.Set;
import org.apache.logging.log4j.Logger;
import org.apache.geode.cache.CacheException;
import org.apache.geode.distributed.internal.DM;
import org.apache.geode.distributed.internal.DistributionManager;
import org.apache.geode.distributed.internal.DistributionStats;
import org.apache.geode.distributed.internal.ReplyMessage;
import org.apache.geode.distributed.internal.ReplyProcessor21;
import org.apache.geode.distributed.internal.ReplySender;
import org.apache.geode.distributed.internal.membership.InternalDistributedMember;
import org.apache.geode.internal.Assert;
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 be a replicate region to perform region-level ops like clear() and
* invalidateRegion(). It is used when the target region has concurrency control enabled so that
* region-version-vectors must be used to execute these operations.
*
* @since GemFire 7.0
*/
public final class RemoteRegionOperation extends RemoteOperationMessageWithDirectReply {
private static final Logger logger = LogService.getLogger();
private enum Operation {
CLEAR,
// INVALIDATE
}
transient private DistributedRegion region;
private Operation op;
public RemoteRegionOperation() {}
public static RemoteRegionOperation clear(InternalDistributedMember recipient,
DistributedRegion region) {
return new RemoteRegionOperation(recipient, region, Operation.CLEAR);
}
// public static RemoteRegionOperation invalidate(InternalDistributedMember recipient,
// DistributedRegion region) {
// return new RemoteRegionOperation(recipient, region, Operation.INVALIDATE);
// }
private RemoteRegionOperation(InternalDistributedMember recipient, DistributedRegion region,
Operation op) {
super(recipient, region.getFullPath(),
new RemoteOperationResponse(region.getSystem(), Collections.singleton(recipient)));
this.op = op;
this.region = region;
}
/**
*/
public void distribute() throws RemoteOperationException {
RemoteOperationResponse p = (RemoteOperationResponse) this.processor;
Set failures = region.getDistributionManager().putOutgoing(this);
if (failures != null && failures.size() > 0) {
throw new RemoteOperationException(LocalizedStrings.FAILED_SENDING_0.toLocalizedString(this));
}
p.waitForCacheException();
}
@Override
protected boolean operateOnRegion(DistributionManager dm, LocalRegion r, long startTime)
throws CacheException, RemoteOperationException {
if (logger.isTraceEnabled(LogMarker.DM)) {
logger.trace(LogMarker.DM, "DistributedRemoteRegionOperation operateOnRegion: {}",
r.getFullPath());
}
if (!(r instanceof PartitionedRegion)) {
r.waitOnInitialization(); // bug #43371 - accessing a region before it's initialized
}
if (op.equals(Operation.CLEAR)) {
r.clear();
// } else {
// r.invalidateRegion();
}
// r.getPrStats().endPartitionMessagesProcessing(startTime);
RemoteRegionOperationReplyMessage.send(getSender(), getProcessorId(), getReplySender(dm));
// Unless there was an exception thrown, this message handles sending the
// response
return false;
}
@Override
protected void appendFields(StringBuffer buff) {
super.appendFields(buff);
buff.append("; operation=").append(this.op);
}
public int getDSFID() {
return R_REGION_OP;
}
@Override
public void fromData(DataInput in) throws IOException, ClassNotFoundException {
super.fromData(in);
this.op = Operation.values()[in.readByte()];
}
@Override
public void toData(DataOutput out) throws IOException {
super.toData(out);
out.writeByte(this.op.ordinal());
}
public static final class RemoteRegionOperationReplyMessage extends ReplyMessage {
/**
* Empty constructor to conform to DataSerializable interface
*/
public RemoteRegionOperationReplyMessage() {}
private RemoteRegionOperationReplyMessage(int processorId) {
this.processorId = processorId;
}
/** Send an ack */
public static void send(InternalDistributedMember recipient, int processorId,
ReplySender replySender) {
Assert.assertTrue(recipient != null, "RemoteRegionOperationReplyMessage NULL reply message");
RemoteRegionOperationReplyMessage m = new RemoteRegionOperationReplyMessage(processorId);
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();
if (processor == null) {
if (logger.isTraceEnabled(LogMarker.DM)) {
logger.trace(LogMarker.DM, "RemoteRegionOperationReplyMessage processor not found");
}
return;
}
processor.process(this);
dm.getStats().incReplyMessageTime(DistributionStats.getStatTime() - startTime);
}
@Override
public int getDSFID() {
return R_REGION_OP_REPLY;
}
@Override
public void fromData(DataInput in) throws IOException, ClassNotFoundException {
super.fromData(in);
}
@Override
public void toData(DataOutput out) throws IOException {
super.toData(out);
}
@Override
public String toString() {
StringBuffer sb = new StringBuffer();
sb.append("RemoteRegionOperationReplyMessage ").append("processorid=")
.append(this.processorId).append(" reply to sender ").append(this.getSender());
return sb.toString();
}
}
}