org.springframework.data.gemfire.function.execution

Class GemfireOnServersFunctionTemplate

java.lang.Object

org.springframework.data.gemfire.function.execution.GemfireOnServersFunctionTemplate

All Implemented Interfaces:

InitializingBean, GemfireFunctionOperations

public class GemfireOnServersFunctionTemplate
extends Object

Creates an OnServers Function Execution initialized with either a cache or a Pool.

Author:

David Turanski, John Blum

See Also:

RegionService, ClientCache, Pool, Execution, Function, AbstractFunctionTemplate

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.geode.cache.execute.ResultCollector<?,?>	resultCollector
protected long	timeout

Constructor Summary

Constructors

Constructor and Description
GemfireOnServersFunctionTemplate(org.apache.geode.cache.client.Pool pool)
GemfireOnServersFunctionTemplate(org.apache.geode.cache.RegionService cache)
GemfireOnServersFunctionTemplate(String poolName)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected <T> Iterable<T>	execute(org.springframework.data.gemfire.function.execution.AbstractFunctionExecution execution)
protected <T> Iterable<T>	execute(org.springframework.data.gemfire.function.execution.AbstractFunctionExecution execution, boolean returnResult)
<T> Iterable<T>	execute(org.apache.geode.cache.execute.Function function, Object... args) Execute an unregistered GemFire Function with the given arguments.
<T> T	execute(GemfireFunctionCallback<T> callback) Execute a GemFire Function using a native GemFire Execution instance.
<T> Iterable<T>	execute(String functionId, Object... args) Execute a GemFire Function registered with the given ID.
protected <T> T	executeAndExtract(org.springframework.data.gemfire.function.execution.AbstractFunctionExecution execution)
<T> T	executeAndExtract(org.apache.geode.cache.execute.Function function, Object... args) Execute an unregistered GemFire Function with the expected singleton result.
<T> T	executeAndExtract(String functionId, Object... args) Execute a GemFire Function registered with an ID and with an expected singleton result
void	executeWithNoResult(String functionId, Object... args) Execute a GemFire Function registered with the given ID having no return value.
protected org.springframework.data.gemfire.function.execution.AbstractFunctionExecution	getFunctionExecution()
org.apache.geode.cache.execute.ResultCollector<?,?>	getResultCollector()
protected org.apache.geode.cache.client.ClientCache	resolveClientCache()
protected org.apache.geode.cache.client.Pool	resolveDefaultPool()
protected org.apache.geode.cache.client.Pool	resolveNamedPool()
protected org.apache.geode.cache.client.Pool	resolvePool()
protected Object	resolveRequiredGemFireObject()
void	setPool(org.apache.geode.cache.client.Pool pool)
void	setPoolName(String poolName)
void	setResultCollector(org.apache.geode.cache.execute.ResultCollector<?,?> resultCollector)
void	setTimeout(long timeout)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

timeout

protected long timeout

resultCollector

protected volatile org.apache.geode.cache.execute.ResultCollector<?,?> resultCollector

Constructor Detail

GemfireOnServersFunctionTemplate

public GemfireOnServersFunctionTemplate(org.apache.geode.cache.RegionService cache)

GemfireOnServersFunctionTemplate

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

GemfireOnServersFunctionTemplate

public GemfireOnServersFunctionTemplate(String poolName)

Method Detail

setPool

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

setPoolName

public void setPoolName(String poolName)

getFunctionExecution

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

resolveRequiredGemFireObject

protected Object resolveRequiredGemFireObject()

resolveClientCache

protected org.apache.geode.cache.client.ClientCache resolveClientCache()

resolveDefaultPool

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

resolveNamedPool

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

resolvePool

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

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface 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:

GemfireFunctionCallback

execute

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

execute

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

executeAndExtract

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

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)