geode-core/src/main/java/org/apache/geode/internal/cache/execute/InternalExecution.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.internal.cache.execute;

import java.util.Set;

import org.apache.geode.cache.DataPolicy;
import org.apache.geode.cache.execute.Execution;
import org.apache.geode.cache.execute.FunctionService;
import org.apache.geode.cache.execute.ResultCollector;

/**
 * Internal interface that adds some internal methods to the Execution interface.
 *
 * @since GemFire 5.8LA
 *
 */
public interface InternalExecution extends Execution {

  InternalExecution withMemberMappedArgument(MemberMappedArgument argument);

  /**
   * Specifies a filter of bucketIDs for selecting the GemFire members to execute the function on.
   * <p>
   * Applicable only for regions with {@link DataPolicy#PARTITION} DataPolicy.
   *
   *
   * @param bucketIDs Set of bucketIDs defining the buckets to be used for executing the function
   * @return an Execution with the filter
   * @throws UnsupportedOperationException if not called after
   *         {@link FunctionService#onRegion(org.apache.geode.cache.Region)}
   * @since Geode 1.0
   */
  InternalExecution withBucketFilter(Set<Integer> bucketIDs);

  /**
   * If true, function execution waits for all exceptions from target nodes <br>
   * If false, function execution returns when first exception is occurred.
   *
   */
  void setWaitOnExceptionFlag(boolean setWaitOnException);

  /**
   * Sets the exception delivery flag. If set, all exceptions will be forwarded directly to the
   * {@link ResultCollector}. The user will not need to invoke {@link ResultCollector#getResult()}
   * to receive errors. Setting this flag may interface will proper handling of HA-enabled
   * functions.
   *
   * @param forward true if all exceptions should be forwarded to the <code>ResultCollector</code>
   */
  void setForwardExceptions(boolean forward);

  /**
   * If true, allows results of function execution on groups to be collected in presence of member
   * failures. For the failed member, resultCollector will have an Exception in place of a result,
   * so that information about the failed member can be obtained.
   *
   * see bug #45765
   *
   * @param ignore true to collect results
   */
  void setIgnoreDepartedMembers(boolean ignore);
}