Package org.springframework.data.gemfire.function.execution

Class AbstractClientFunctionTemplate

java.lang.Object
org.springframework.data.gemfire.function.execution.AbstractClientFunctionTemplate
All Implemented Interfaces:
org.springframework.beans.factory.InitializingBean, GemfireFunctionOperations
Direct Known Subclasses:
GemfireOnServerFunctionTemplate, GemfireOnServersFunctionTemplate
public abstract class AbstractClientFunctionTemplate extends Object
Abstract base class for Apache Geode client-side Function Execution.
Since:
2.3.0
See Also:
  • RegionService
  • ClientCache
  • Pool
  • Execution
  • Function

  • Field Details

    • DEFAULT_POOL_RESOLVER

      protected static final PoolResolver DEFAULT_POOL_RESOLVER

  • Constructor Details

    • AbstractClientFunctionTemplate

      public AbstractClientFunctionTemplate(org.apache.geode.cache.RegionService regionService)

    • AbstractClientFunctionTemplate

      public AbstractClientFunctionTemplate(org.apache.geode.cache.client.Pool pool)

    • AbstractClientFunctionTemplate

      public AbstractClientFunctionTemplate(String poolName)

  • Method Details

    • setPool

      public void setPool(org.apache.geode.cache.client.Pool pool)

    • setPoolName

      public void setPoolName(String poolName)

    • setPoolResolver

      public void setPoolResolver(PoolResolver poolResolver)

    • getPoolResolver

      protected PoolResolver getPoolResolver()

    • resolveRequiredGemFireObject

      protected Object resolveRequiredGemFireObject()

    • resolveClientCache

      @Deprecated protected org.apache.geode.cache.client.ClientCache resolveClientCache()
      Deprecated.
      as of 2.3.0; Use resolveRegionService().

    • resolvePool

      protected org.apache.geode.cache.client.Pool resolvePool()

    • resolveDefaultPool

      protected org.apache.geode.cache.client.Pool resolveDefaultPool()

    • resolveNamedPool

      protected org.apache.geode.cache.client.Pool resolveNamedPool()

    • resolveRegionService

      protected org.apache.geode.cache.RegionService resolveRegionService()

    • getFunctionExecution

      protected org.springframework.data.gemfire.function.execution.AbstractFunctionExecution getFunctionExecution()

    • newFunctionExecutionUsingPool

      protected abstract org.springframework.data.gemfire.function.execution.AbstractFunctionExecution newFunctionExecutionUsingPool(org.apache.geode.cache.client.Pool pool)

    • newFunctionExecutionUsingRegionService

      protected abstract org.springframework.data.gemfire.function.execution.AbstractFunctionExecution newFunctionExecutionUsingRegionService(org.apache.geode.cache.RegionService regionService)

    • afterPropertiesSet

      public void afterPropertiesSet() throws Exception
      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
      Throws:
      Exception

    • execute

      public <T> Iterable<T> execute(org.apache.geode.cache.execute.Function function, Object... args)
      Description copied from interface: GemfireFunctionOperations
      Execute an unregistered GemFire Function with the given arguments.
      Specified by:
      execute in interface GemfireFunctionOperations
      Type Parameters:
      T - type parameter specifying the result type of the Function execution.
      Parameters:
      function - the GemFire Function object to execute.
      args - an array of Object arguments to the Function call.
      Returns:
      the contents of the ResultsCollector.

    • executeAndExtract

      public <T> T executeAndExtract(org.apache.geode.cache.execute.Function function, Object... args)
      Description copied from interface: GemfireFunctionOperations
      Execute an unregistered GemFire Function with the expected singleton result.
      Specified by:
      executeAndExtract in interface GemfireFunctionOperations
      Type Parameters:
      T - type parameter specifying the result type of the Function execution.
      Parameters:
      function - the GemFire Function object.
      args - an array of Object arguments to the Function call.
      Returns:
      the first item in the ResultsCollector.
      See Also:
      • Function

    • execute

      public <T> Iterable<T> execute(String functionId, Object... args)
      Description copied from interface: GemfireFunctionOperations
      Execute a GemFire Function registered with the given ID.
      Specified by:
      execute in interface GemfireFunctionOperations
      Type Parameters:
      T - type parameter specifying the result type of the Function execution.
      Parameters:
      functionId - the ID under which the GemFire function is registered.
      args - an array of Object arguments to the Function call.
      Returns:
      the results

    • executeAndExtract

      public <T> T executeAndExtract(String functionId, Object... args)
      Description copied from interface: GemfireFunctionOperations
      Execute a GemFire Function registered with an ID and with an expected singleton result
      Specified by:
      executeAndExtract in interface GemfireFunctionOperations
      Type Parameters:
      T - type parameter specifying the result type of the Function execution.
      Parameters:
      functionId - the ID under which the GemFire function is registered.
      args - an array of Object arguments to the Function call.
      Returns:
      the first item in the results collector

    • executeWithNoResult

      public void executeWithNoResult(String functionId, Object... args)
      Description copied from interface: GemfireFunctionOperations
      Execute a GemFire Function registered with the given ID having no return value.
      Specified by:
      executeWithNoResult in interface GemfireFunctionOperations
      Parameters:
      functionId - the ID under which the GemFire function is registered.
      args - an array of Object arguments to the Function call.

    • execute

      public <T> T execute(GemfireFunctionCallback<T> callback)
      Description copied from interface: GemfireFunctionOperations
      Execute a GemFire Function using a native GemFire Execution instance.
      Specified by:
      execute in interface GemfireFunctionOperations
      Type Parameters:
      T - type parameter specifying the result type of the Function execution.
      Parameters:
      callback - a callback providing the execution instance.
      Returns:
      the Function execution result.
      See Also:

    • execute

      protected <T> Iterable<T> execute(org.springframework.data.gemfire.function.execution.AbstractFunctionExecution functionExecution)

    • execute

      protected <T> Iterable<T> execute(org.springframework.data.gemfire.function.execution.AbstractFunctionExecution functionExecution, boolean returnResult)

    • executeAndExtract

      protected <T> T executeAndExtract(org.springframework.data.gemfire.function.execution.AbstractFunctionExecution functionExecution)

    • setResultCollector

      public void setResultCollector(org.apache.geode.cache.execute.ResultCollector<?,?> resultCollector)

    • getResultCollector

      public org.apache.geode.cache.execute.ResultCollector<?,?> getResultCollector()

    • setTimeout

      public void setTimeout(long timeout)

    • getTimeout

      public long getTimeout()