/*
* 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.modules.util;
import org.apache.geode.cache.Cache;
import org.apache.geode.cache.CacheFactory;
import org.apache.geode.cache.Declarable;
import org.apache.geode.cache.Region;
import org.apache.geode.cache.execute.Function;
import org.apache.geode.cache.execute.FunctionContext;
import java.util.Properties;
import java.util.Set;
/**
* Touches the keys contained in the set of keys by performing a get on the replicated region. This
* is a non-data-aware function invoked using onMembers or onServers.
*
*/
public class TouchReplicatedRegionEntriesFunction implements Function, Declarable {
private static final long serialVersionUID = -7424895036162243564L;
private final Cache cache;
public static final String ID = "touch-replicated-region-entries";
public TouchReplicatedRegionEntriesFunction() {
this(CacheFactory.getAnyInstance());
}
public TouchReplicatedRegionEntriesFunction(Cache cache) {
this.cache = cache;
}
public void execute(FunctionContext context) {
Object[] arguments = (Object[]) context.getArguments();
String regionName = (String) arguments[0];
Set<String> keys = (Set<String>) arguments[1];
if (this.cache.getLogger().fineEnabled()) {
StringBuilder builder = new StringBuilder();
builder.append("Function ").append(ID).append(" received request to touch ")
.append(regionName).append("->").append(keys);
this.cache.getLogger().fine(builder.toString());
}
// Retrieve the appropriate Region and value to update the lastAccessedTime
Region region = this.cache.getRegion(regionName);
if (region != null) {
region.getAll(keys);
}
// Return result to get around NPE in LocalResultCollectorImpl
context.getResultSender().lastResult(true);
}
public String getId() {
return ID;
}
public boolean optimizeForWrite() {
return false;
}
public boolean isHA() {
return false;
}
public boolean hasResult() {
// Setting this to false caused the onServers method to only execute the
// function on one server.
return true;
}
public void init(Properties properties) {}
}