com.gemstone.gemfire.internal.cache.execute.InternalExecution Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation

SnappyData store based off Pivotal GemFireXD

The newest version!

/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * Licensed 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. See accompanying
 * LICENSE file.
 */

package com.gemstone.gemfire.internal.cache.execute;

import java.util.Set;

import com.gemstone.gemfire.cache.execute.Execution;
import com.gemstone.gemfire.cache.execute.FunctionService;
import com.gemstone.gemfire.cache.execute.ResultCollector;

/**
 * Internal interface for GemFireXD. It has internal methods specific for GemFireXD
 * 
 * @author Yogesh Mahajan
 * @since 5.8LA
 * 
 */
public interface InternalExecution extends Execution {

  public InternalExecution withMemberMappedArgument(
      MemberMappedArgument argument); 

  /**
   * Specifies a data filter of routing objects for selecting the GemFire
   * members to execute the function that are not GemFire keys rather routing
   * objects as determined by resolver. Currently used by GemFireXD for passing
   * routing objects obtained from the custom resolvers.
   * 
   * If the set is empty the function is executed on all members that have the
   * {@linkplain FunctionService#onRegion(com.gemstone.gemfire.cache.Region)
   * region defined}.
   * 
   * 
   * @param routingObjects
   *          Set defining the routing objects to be used for executing the
   *          function.
   * 
   * @return an Execution with the routing objects
   * 
   * @throws IllegalArgumentException
   *           if the set of routing objects passed is null.
   * @throws UnsupportedOperationException
   *           if not called after
   *           {@link FunctionService#onRegion(com.gemstone.gemfire.cache.Region)}
   */
  public InternalExecution withRoutingObjects(Set