geode-experimental-driver/src/main/java/org/apache/geode/experimental/driver/Function.java

/*
 * 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.experimental.driver;

import java.io.IOException;
import java.util.List;

/**
 * This interface represents from the client-side the execution of a function on the server-side.
 *
 * @param <T> Type of result returned from the function. May differ from the key and value types
 *        of any involved regions.
 */
public interface Function<T> {
  /**
   * Executes this function with the specified arguments on the specified region.
   * Keys may be optionally filtered.
   *
   * @param arguments Object encapsulating all the arguments to this execution of the function.
   * @param regionName Name of the region.
   * @param keyFilters Optional list of keys.
   * @return Possibly empty list of results from the function.
   * @throws IOException If an error occurred communicating with the distributed system.
   */
  List<T> executeOnRegion(Object arguments, String regionName, Object... keyFilters)
      throws IOException;

  /**
   * Executes this function with the specified arguments on the specified members.
   *
   * @param arguments Object encapsulating all the arguments to this execution of the function.
   * @param members Optional list of member names.
   * @return Possibly empty list of results from the function.
   * @throws IOException If an error occurred communicating with the distributed system.
   */
  List<T> executeOnMember(Object arguments, String... members) throws IOException;

  /**
   * Executes this function with the specified arguments on the specified groups.
   *
   * @param arguments Object encapsulating all the arguments to this execution of the function.
   * @param groups Optional list of group names.
   * @return Possibly empty list of results from the function.
   * @throws IOException If an error occurred communicating with the distributed system.
   */
  List<T> executeOnGroup(Object arguments, String... groups) throws IOException;
}