Package org.infinispan.remoting.transport

Class ValidResponseCollector<T>

java.lang.Object

org.infinispan.remoting.transport.ValidResponseCollector<T>

All Implemented Interfaces:

ResponseCollector<T>

public abstract class ValidResponseCollector<T>
extends Object
implements ResponseCollector<T>

Base class for response collectors, splitting responses into valid responses, exception responses, and target missing. Returning a non-null value or throwing an exception from any of the addValidResponse(Address, ValidResponse), addException(Address, Exception), or addTargetNotFound(Address) methods will complete the request. If all invocations return null, the request will be completed with the result of finish().

Since:

9.1

Author:

Dan Berindei

Constructor Summary

Constructors

Constructor	Description
ValidResponseCollector()

Method Summary

Modifier and Type	Method	Description
protected abstract T	addException(Address sender, Exception exception)	Process an exception from a target.
T	addResponse(Address sender, Response response)	Called when a response is received, or when a target node becomes unavailable.
protected abstract T	addTargetNotFound(Address sender)	Process a target leaving the cluster or stopping the cache.
protected abstract T	addValidResponse(Address sender, ValidResponse response)	Process a valid response from a target.
abstract T	finish()	Called after ResponseCollector.addResponse(Address, Response) returns null for the last response.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidResponseCollector

public ValidResponseCollector()

Method Detail

addResponse

public final T addResponse(Address sender,
                           Response response)

Description copied from interface: ResponseCollector

Called when a response is received, or when a target node becomes unavailable.

When a target node leaves the cluster, this method is called with a CacheNotFoundResponse.

Should return a non-null result if the request should complete, or null if it should wait for more responses. If the method throws an exception, the request will be completed with that exception. If the last response is received and addResponse() still returns null, ResponseCollector.finish() will also be called to obtain a result.

Thread safety: addResponse() will *not* be called concurrently from multiple threads, and the request will not be completed while addResponse() is running.

Specified by:

addResponse in interface ResponseCollector<T>

finish

public abstract T finish()

Description copied from interface: ResponseCollector

Called after ResponseCollector.addResponse(Address, Response) returns null for the last response.

If finish() finishes normally, the request will complete with its return value (even if null). If finish() throws an exception, the request will complete exceptionally with that exception, wrapped in a CompletionException (unless the exception is already a CompletionException).

Specified by:

finish in interface ResponseCollector<T>

addValidResponse

protected abstract T addValidResponse(Address sender,
                                      ValidResponse response)

Process a valid response from a target.

Returns:

null to continue waiting for response, non-null to complete with that value.

addTargetNotFound

protected abstract T addTargetNotFound(Address sender)

Process a target leaving the cluster or stopping the cache.

Returns:

null to continue waiting for response, non-null to complete with that value.

addException

protected abstract T addException(Address sender,
                                  Exception exception)

Process an exception from a target.

Returns:

null to continue waiting for responses (the default), non-null to complete with that value.