Package org.infinispan.interceptors

Class BaseAsyncInterceptor

java.lang.Object

org.infinispan.interceptors.BaseAsyncInterceptor

All Implemented Interfaces:

AsyncInterceptor

Direct Known Subclasses:

DDAsyncInterceptor

@Experimental
public abstract class BaseAsyncInterceptor
extends Object
implements AsyncInterceptor

Base class for an interceptor in the new asynchronous invocation chain.

Since:

9.0

Author:

Dan Berindei

Field Summary

Fields

Modifier and Type	Field	Description
protected Configuration	cacheConfiguration

Constructor Summary

Constructors

Constructor	Description
BaseAsyncInterceptor()

Method Summary

Modifier and Type	Method	Description
final Object	asyncInvokeNext(InvocationContext ctx, VisitableCommand command, Collection<? extends CompletionStage<?>> delays)	Suspend invocation until all delays complete, then if successful invoke the next interceptor.
final Object	asyncInvokeNext(InvocationContext ctx, VisitableCommand command, CompletionStage<?> delay)	Suspend the invocation until delay completes, then if successful invoke the next interceptor.
final Object	asyncInvokeNext(InvocationContext ctx, VisitableCommand command, InvocationStage invocationStage)	Suspend the invocation until invocationStage completes, then if successful invoke the next interceptor.
static InvocationStage	asyncValue(CompletionStage<?> valueFuture)	Suspend the invocation until valueFuture completes, then return its result without running the remaining interceptors.
static Object	delayedNull(CompletionStage<Void> stage)	The same as delayedValue(CompletionStage, Object), except that it is optimizes cases where the return value is null.
static Object	delayedValue(CompletionStage<?> stage, Object syncValue)	Returns an InvocationStage if the provided CompletionStage is null, not completed or completed via exception.
static Object	delayedValue(CompletionStage<?> stage, Object syncValue, Throwable throwable)	This method should be used instead of delayedValue(CompletionStage, Object) when a InvocationFinallyFunction is used to properly handle the exception if any is present.
final Object	invokeNext(InvocationContext ctx, VisitableCommand command)	Invoke the next interceptor, possibly with a new command.
final <C extends VisitableCommand> Object	invokeNextAndExceptionally(InvocationContext ctx, C command, InvocationExceptionFunction<C> function)	Invoke the next interceptor, possibly with a new command, and execute an InvocationCallback after all the interceptors have finished with an exception.
final <C extends VisitableCommand> Object	invokeNextAndFinally(InvocationContext ctx, C command, InvocationFinallyAction<C> action)	Invoke the next interceptor, possibly with a new command, and execute an InvocationCallback after all the interceptors have finished, with or without an exception.
final <C extends VisitableCommand> Object	invokeNextAndHandle(InvocationContext ctx, C command, InvocationFinallyFunction<C> function)	Invoke the next interceptor, possibly with a new command, and execute an InvocationCallback after all the interceptors have finished, with or without an exception.
final <C extends VisitableCommand> Object	invokeNextThenAccept(InvocationContext ctx, C command, InvocationSuccessAction<C> action)	Invoke the next interceptor, possibly with a new command, and execute an InvocationCallback after all the interceptors have finished successfully.
final <C extends VisitableCommand> Object	invokeNextThenApply(InvocationContext ctx, C command, InvocationSuccessFunction<C> function)	Invoke the next interceptor, possibly with a new command, and execute an InvocationCallback after all the interceptors have finished successfully.
protected static boolean	isSuccessfullyDone(Object maybeStage)
static InvocationStage	makeStage(Object rv)	Encode the result of an invokeNext(InvocationContext, VisitableCommand) in an InvocationStage.
final void	setNextInterceptor(AsyncInterceptor nextInterceptor)	Used internally to set up the interceptor.
static Object	valueOrException(Object rv, Throwable throwable)	Return the value if throwable != null, throw the exception otherwise.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.interceptors.AsyncInterceptor

visitCommand

Field Details

cacheConfiguration

protected Configuration cacheConfiguration

Constructor Details

BaseAsyncInterceptor

public BaseAsyncInterceptor()

Method Details

setNextInterceptor

public final void setNextInterceptor(AsyncInterceptor nextInterceptor)

Used internally to set up the interceptor.

Specified by:

setNextInterceptor in interface AsyncInterceptor

invokeNext

public final Object invokeNext(InvocationContext ctx,
 VisitableCommand command)

Invoke the next interceptor, possibly with a new command.

Use invokeNextThenApply(InvocationContext, VisitableCommand, InvocationSuccessFunction) or invokeNextThenAccept(InvocationContext, VisitableCommand, InvocationSuccessAction) instead if you need to process the return value of the next interceptor.

Note: invokeNext(ctx, command) does not throw exceptions. In order to handle exceptions from the next interceptors, you must use invokeNextAndHandle(InvocationContext, VisitableCommand, InvocationFinallyFunction), invokeNextAndFinally(InvocationContext, VisitableCommand, InvocationFinallyAction), or invokeNextAndExceptionally(InvocationContext, VisitableCommand, InvocationExceptionFunction).

invokeNextThenApply

public final <C extends VisitableCommand> Object invokeNextThenApply(InvocationContext ctx,
 C command,
 InvocationSuccessFunction<C> function)

Invoke the next interceptor, possibly with a new command, and execute an InvocationCallback after all the interceptors have finished successfully.

You need to wrap the result with makeStage(Object) if you need to add another handler.

invokeNextThenAccept

public final <C extends VisitableCommand> Object invokeNextThenAccept(InvocationContext ctx,
 C command,
 InvocationSuccessAction<C> action)

Invoke the next interceptor, possibly with a new command, and execute an InvocationCallback after all the interceptors have finished successfully.

You need to wrap the result with makeStage(Object) if you need to add another handler.

invokeNextAndExceptionally

public final <C extends VisitableCommand> Object invokeNextAndExceptionally(InvocationContext ctx,
 C command,
 InvocationExceptionFunction<C> function)

Invoke the next interceptor, possibly with a new command, and execute an InvocationCallback after all the interceptors have finished with an exception.

You need to wrap the result with makeStage(Object) if you need to add another handler.

invokeNextAndFinally

public final <C extends VisitableCommand> Object invokeNextAndFinally(InvocationContext ctx,
 C command,
 InvocationFinallyAction<C> action)

Invoke the next interceptor, possibly with a new command, and execute an InvocationCallback after all the interceptors have finished, with or without an exception.

You need to wrap the result with makeStage(Object) if you need to add another handler.

invokeNextAndHandle

public final <C extends VisitableCommand> Object invokeNextAndHandle(InvocationContext ctx,
 C command,
 InvocationFinallyFunction<C> function)

Invoke the next interceptor, possibly with a new command, and execute an InvocationCallback after all the interceptors have finished, with or without an exception.

You need to wrap the result with makeStage(Object) if you need to add another handler.

asyncValue

public static InvocationStage asyncValue(CompletionStage<?> valueFuture)

Suspend the invocation until valueFuture completes, then return its result without running the remaining interceptors.

The caller can add a callback that will run when valueFuture completes, e.g. asyncValue(v).thenApply(ctx, command, (rCtx, rCommand, rv, t) -> invokeNext(rCtx, rCommand)). For this particular scenario, however, it's simpler to use asyncInvokeNext(InvocationContext, VisitableCommand, CompletionStage).

asyncInvokeNext

public final Object asyncInvokeNext(InvocationContext ctx,
 VisitableCommand command,
 CompletionStage<?> delay)

Suspend the invocation until delay completes, then if successful invoke the next interceptor.

If delay is null or already completed normally, immediately invoke the next interceptor in this thread.

If delay completes exceptionally, skip the next interceptor and continue with the exception.

You need to wrap the result with makeStage(Object) if you need to add another handler.

asyncInvokeNext

public final Object asyncInvokeNext(InvocationContext ctx,
 VisitableCommand command,
 InvocationStage invocationStage)

Suspend the invocation until invocationStage completes, then if successful invoke the next interceptor.

If invocationStage completes exceptionally, skip the next interceptor and continue with the exception.

You need to wrap the result with makeStage(Object) if you need to add another handler.

asyncInvokeNext

public final Object asyncInvokeNext(InvocationContext ctx,
 VisitableCommand command,
 Collection<? extends CompletionStage<?>> delays)

Suspend invocation until all delays complete, then if successful invoke the next interceptor. If the list is empty or null, invoke the next interceptor immediately.

If any of delays completes exceptionally, skip the next interceptor and continue with the exception.

You need to wrap the result with makeStage(Object) if you need to add another handler.

valueOrException

public static Object valueOrException(Object rv,
 Throwable throwable)
                               throws Throwable

Return the value if throwable != null, throw the exception otherwise.

Throws:

Throwable

makeStage

public static InvocationStage makeStage(Object rv)

Encode the result of an invokeNext(InvocationContext, VisitableCommand) in an InvocationStage.

May not create a new instance, if the result is already an InvocationStage.

delayedValue

public static Object delayedValue(CompletionStage<?> stage,
 Object syncValue)

Returns an InvocationStage if the provided CompletionStage is null, not completed or completed via exception. If these are not true the sync value is returned directly.

Parameters:

stage - wait for completion of this if not null

syncValue - sync value to return if stage is complete or as stage value

Returns:

invocation stage or sync value

delayedValue

public static Object delayedValue(CompletionStage<?> stage,
 Object syncValue,
 Throwable throwable)

This method should be used instead of delayedValue(CompletionStage, Object) when a InvocationFinallyFunction is used to properly handle the exception if any is present.

Parameters:

stage -

syncValue -

throwable -

Returns:

delayedNull

public static Object delayedNull(CompletionStage<Void> stage)

The same as delayedValue(CompletionStage, Object), except that it is optimizes cases where the return value is null.

Parameters:

stage - wait for completion of this if not null

Returns:

invocation stage or null sync value

isSuccessfullyDone

protected static boolean isSuccessfullyDone(Object maybeStage)