Package de.quantummaid.eventmaid.messageFunction

Interface ResponseFuture

All Superinterfaces:

Future<Object>

All Known Implementing Classes:

ExpectedResponseFuture

public interface ResponseFuture
extends Future<Object>

For each request, the related ResponseFuture provides methods, to query or wait on the result.

See Also:

EventMaid Documentation

Method Summary

Modifier and Type	Method	Description
Object	getErrorResponse()	Waits until the future is fulfilled and returns the error payload.
Object	getErrorResponse(long timeout, TimeUnit unit)	Waits until the future is fulfilled to return the error payload or the timeout expires.
ProcessingContext<Object>	getRaw()	Waits until the future is fulfilled and returns the ProcessingContext payload.
ProcessingContext<Object>	getRaw(long timeout, TimeUnit unit)	Waits until the future is fulfilled and returns the ProcessingContext payload or the timeout expires.
void	then(FollowUpAction followUpAction)	Adds a FollowUpAction, that gets executed, once the Future is fulfilled.
boolean	wasSuccessful()	Returns true if the future was fulfilled with an success response, false if an exception occurred, the future was cancelled or the error payload is not null.

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Detail

wasSuccessful

boolean wasSuccessful()

Returns true if the future was fulfilled with an success response, false if an exception occurred, the future was cancelled or the error payload is not null.

Returns:

true if only payload is set, false otherwise

getErrorResponse

Object getErrorResponse()
                 throws InterruptedException,
                        ExecutionException

Waits until the future is fulfilled and returns the error payload.

Returns:

the error payload of the message or null if none exists

Throws:

CancellationException - if the future was cancelled

InterruptedException - if the waiting Thread is interrupted

ExecutionException - if the future was fulfilled with an exception

getErrorResponse

Object getErrorResponse(long timeout,
                        TimeUnit unit)
                 throws InterruptedException,
                        ExecutionException,
                        TimeoutException

Waits until the future is fulfilled to return the error payload or the timeout expires.

Parameters:

timeout - the interval to wait

unit - the unit of the interval

Returns:

the error payload of the message or null if none exists

Throws:

CancellationException - if the future was cancelled

InterruptedException - if the waiting Thread is interrupted

ExecutionException - if the future was fulfilled with an exception

TimeoutException - if the timeout expired

getRaw

ProcessingContext<Object> getRaw()
                          throws InterruptedException,
                                 ExecutionException

Waits until the future is fulfilled and returns the ProcessingContext payload.

Returns:

the ProcessingContext of the message

Throws:

CancellationException - if the future was cancelled

InterruptedException - if the waiting Thread is interrupted

ExecutionException - if the future was fulfilled with an exception

getRaw

ProcessingContext<Object> getRaw(long timeout,
                                 TimeUnit unit)
                          throws InterruptedException,
                                 ExecutionException,
                                 TimeoutException

Waits until the future is fulfilled and returns the ProcessingContext payload or the timeout expires.

Parameters:

timeout - the interval to wait

unit - the unit of the interval

Returns:

the ProcessingContext of the message

Throws:

CancellationException - if the future was cancelled

InterruptedException - if the waiting Thread is interrupted

ExecutionException - if the future was fulfilled with an exception

TimeoutException - if the timeout expired

then

void then(FollowUpAction followUpAction)

Adds a FollowUpAction, that gets executed, once the Future is fulfilled.

Parameters:

followUpAction - the FollowUpAction to execute

Throws:

UnsupportedOperationException - if one FollowUpAction has already been set

CancellationException - if the future has already been cancelled