Package dev.getelements.elements.rt.routing

Class AbstractAggregateRoutingStrategy

java.lang.Object

dev.getelements.elements.rt.routing.AbstractAggregateRoutingStrategy

All Implemented Interfaces:

RoutingStrategy

Direct Known Subclasses:

BroadcastRoutingStrategy, ListAggregateRoutingStrategy

public abstract class AbstractAggregateRoutingStrategy
extends Object
implements RoutingStrategy

A compex type of RoutingStrategy where each invocation goes to all known RemoteInvoker instances and then combines the results together into a single result. In the event of a single error, the whole call is canceled rather than trying to partially report some result. It is not recommended that this RoutingStrategy be used for writes if reliability is expected, but only for read operations.

Constructor Summary

Constructors

Constructor	Description
AbstractAggregateRoutingStrategy()

Method Summary

Modifier and Type	Method	Description
protected InvocationResult	combine(InvocationResult ra, InvocationResult rb)	Combines two InvocationResult instances.
protected abstract Object	combine(Object a, Object b)	Combines two raw Object results.
ApplicationId	getApplicationId()
RemoteInvokerRegistry	getRemoteInvokerRegistry()
protected List<RemoteInvoker>	getRemoteInvokers(List<Object> address)	Gets the List<RemoteInvoker> for the supplied address.
AsyncOperation	invokeAsync(List<Object> address, Invocation invocation, List<Consumer<InvocationResult>> asyncInvocationResultConsumerList, InvocationErrorConsumer asyncInvocationErrorConsumer)	Invokes the method returning a AsyncOperation for the value.
Future<Object>	invokeFuture(List<Object> address, Invocation invocation, List<Consumer<InvocationResult>> asyncInvocationResultConsumerList, InvocationErrorConsumer asyncInvocationErrorConsumer)	Invokes the method returning a Future<Object> with the result.
Object	invokeSync(List<Object> address, Invocation invocation, List<Consumer<InvocationResult>> asyncInvocationResultConsumerList, InvocationErrorConsumer asyncInvocationErrorConsumer)	Invokes the method, blocking until it returns on the remote end.
protected InvocationResult	newInitialInvocationResult()	Creates a new InvocationResult which is used as the initial value for combining results.
protected abstract Object	newInitialResult()	Gets the initial result to be fed into the combine(Object, Object) call.
void	setApplicationId(ApplicationId applicationId)
void	setRemoteInvokerRegistry(RemoteInvokerRegistry remoteInvokerRegistry)

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.getelements.elements.rt.remote.RoutingStrategy

invokeAsyncV

Constructor Details

AbstractAggregateRoutingStrategy

public AbstractAggregateRoutingStrategy()

Method Details

invokeFuture

public Future<Object> invokeFuture(List<Object> address,
 Invocation invocation,
 List<Consumer<InvocationResult>> asyncInvocationResultConsumerList,
 InvocationErrorConsumer asyncInvocationErrorConsumer)

Description copied from interface: RoutingStrategy

Invokes the method returning a Future<Object> with the result. Corresponds to RemoteInvoker.invokeFuture(Invocation, List, InvocationErrorConsumer).

Specified by:

invokeFuture in interface RoutingStrategy

Parameters:

address - the address

invocation - the Invocation

asyncInvocationResultConsumerList - the list of Consumer<InvocationResult> instances

asyncInvocationErrorConsumer - the InvocationErrorConsumer to receive the error of the invocation

Returns:

the Future<Object> to handle the return value

invokeAsync

public AsyncOperation invokeAsync(List<Object> address,
 Invocation invocation,
 List<Consumer<InvocationResult>> asyncInvocationResultConsumerList,
 InvocationErrorConsumer asyncInvocationErrorConsumer)

Description copied from interface: RoutingStrategy

Invokes the method returning a AsyncOperation for the value.

Specified by:

invokeAsync in interface RoutingStrategy

Parameters:

address - the address

invocation - the Invocation

asyncInvocationResultConsumerList - the list of Consumer<InvocationResult> instances

asyncInvocationErrorConsumer - the InvocationErrorConsumer to receive the error of the invocation

Returns:

an instance of AsyncOperation

invokeSync

public Object invokeSync(List<Object> address,
 Invocation invocation,
 List<Consumer<InvocationResult>> asyncInvocationResultConsumerList,
 InvocationErrorConsumer asyncInvocationErrorConsumer)
                  throws Exception

Description copied from interface: RoutingStrategy

Invokes the method, blocking until it returns on the remote end. Corresponds to RemoteInvoker.invokeFuture(Invocation, List, InvocationErrorConsumer).

Specified by:

invokeSync in interface RoutingStrategy

Parameters:

address - the address

invocation - the Invocation

asyncInvocationResultConsumerList - the list of Consumer<InvocationResult> instances

asyncInvocationErrorConsumer - the InvocationErrorConsumer to receive the error of the invocation

Returns:

the return value of the remote invocation

Throws:

Exception

getRemoteInvokers

protected List<RemoteInvoker> getRemoteInvokers(List<Object> address)

Gets the List<RemoteInvoker> for the supplied address. By default this just gets all instances for a particular application UUID.

Parameters:

address - the address

Returns:

a List<RemoteInvoker> to use.

newInitialResult

protected abstract Object newInitialResult()

Gets the initial result to be fed into the combine(Object, Object) call. This should represent a zero-state result. For example, if combining List instances, this should ensure that it contains an initial empty list.

Returns:

the Object for the initial aggregate operation.

newInitialInvocationResult

protected InvocationResult newInitialInvocationResult()

Creates a new InvocationResult which is used as the initial value for combining results. This should be a zero-state InvocationResult. For example, if combining List instances, this should ensure that it contains an initial empty list.

Returns:

the InvocationResult used as the initial value for aggregations

combine

protected abstract Object combine(Object a,
 Object b)

Combines two raw Object results.

Parameters:

a - the first object

b - the second object

Returns:

the combined Object

combine

protected InvocationResult combine(InvocationResult ra,
 InvocationResult rb)

Combines two InvocationResult instances. Specifically the returned InvocationResult shoud contain the aggregate result in the InvocationResult.getResult() and return it.

Parameters:

ra - the first InvocationResult

rb - the second InvocationResult

Returns:

the InvocationResult combining the results of both a and b

getApplicationId

public ApplicationId getApplicationId()

setApplicationId

@Inject
public void setApplicationId(ApplicationId applicationId)

getRemoteInvokerRegistry

public RemoteInvokerRegistry getRemoteInvokerRegistry()

setRemoteInvokerRegistry

@Inject
public void setRemoteInvokerRegistry(RemoteInvokerRegistry remoteInvokerRegistry)