fish.payara.microprofile.faulttolerance

Interface FaultToleranceService

All Known Implementing Classes:

FaultToleranceServiceImpl

public interface FaultToleranceService

Essentially a list of all methods needed to process FT behaviour. Decouples the FT processing facilities and state from any specific implementation to allow e.g. unit testing.

Author:

Jan Bernitt

Method Summary

Modifier and Type	Method and Description
void	delay(long delayMillis, javax.interceptor.InvocationContext context) Delays the current thread by the given duration.
void	endTrace() Ends the innermost trace.
Object	fallbackHandle(Class<? extends org.eclipse.microprofile.faulttolerance.FallbackHandler<?>> fallbackClass, javax.interceptor.InvocationContext context, Exception ex) Invokes the instance of the given FallbackHandler Class defined in the given context to handle the given Exception.
Object	fallbackInvoke(Method fallbackMethod, javax.interceptor.InvocationContext context) Invokes the given fallback Method in the given context.
BulkheadSemaphore	getConcurrentExecutions(int maxConcurrentThreads, javax.interceptor.InvocationContext context)
FaultToleranceConfig	getConfig(javax.interceptor.InvocationContext context, Stereotypes stereotypes) Creates an instance of a FaultToleranceConfig bound to the given InvocationContext and Stereotypes lookup.
FaultToleranceMetrics	getMetrics(javax.interceptor.InvocationContext context) Creates an instance of FaultToleranceMetrics bound to the given InvocationContext.
CircuitBreakerState	getState(int requestVolumeThreshold, javax.interceptor.InvocationContext context)
BulkheadSemaphore	getWaitingQueuePopulation(int queueCapacity, javax.interceptor.InvocationContext context)
void	runAsynchronous(CompletableFuture<Object> asyncResult, javax.interceptor.InvocationContext context, Callable<Object> task) Runs the task asynchronously and completes the given asyncResult with the its outcome.
Future<?>	runDelayed(long delayMillis, Runnable task) Runs a given task after a certain waiting time.
void	trace(String method, javax.interceptor.InvocationContext context) Starts tracing the given context named with the given method label.

Method Detail

getConfig

FaultToleranceConfig getConfig(javax.interceptor.InvocationContext context,
                               Stereotypes stereotypes)

Creates an instance of a FaultToleranceConfig bound to the given InvocationContext and Stereotypes lookup.

Parameters:

context - currently processed context

stereotypes - way to lookup sterotype annotations

Returns:

a thread safe FaultToleranceConfig instance bound to the given context

getMetrics

FaultToleranceMetrics getMetrics(javax.interceptor.InvocationContext context)

Creates an instance of FaultToleranceMetrics bound to the given InvocationContext.

Parameters:

context - currently processed context

Returns:

a thread safe FaultToleranceMetrics instance bound to the given context

getState

CircuitBreakerState getState(int requestVolumeThreshold,
                             javax.interceptor.InvocationContext context)

getConcurrentExecutions

BulkheadSemaphore getConcurrentExecutions(int maxConcurrentThreads,
                                          javax.interceptor.InvocationContext context)

getWaitingQueuePopulation

BulkheadSemaphore getWaitingQueuePopulation(int queueCapacity,
                                            javax.interceptor.InvocationContext context)

delay

void delay(long delayMillis,
           javax.interceptor.InvocationContext context)
    throws InterruptedException

Delays the current thread by the given duration. The delay is traced.

Parameters:

delayMillis - the time to sleep in milliseconds

context - current context delayed

Throws:

InterruptedException - In case waiting is interrupted

runDelayed

Future<?> runDelayed(long delayMillis,
                     Runnable task)
              throws Exception

Runs a given task after a certain waiting time.

Parameters:

delayMillis - time to wait in milliseconds before running the given task

task - operation to run

Returns:

A future that can be cancelled if the operation should no longer be run

Throws:

Exception

runAsynchronous

void runAsynchronous(CompletableFuture<Object> asyncResult,
                     javax.interceptor.InvocationContext context,
                     Callable<Object> task)
              throws RejectedExecutionException

Runs the task asynchronously and completes the given asyncResult with the its outcome.

Parameters:

asyncResult - a not yet completed CompletableFuture that should receive the result of the operation when it is executed

context - the currently processed context (for e.g. tracing)

task - an operation that must compute a value of type Future or CompletionStage.

Throws:

RejectedExecutionException - In case the task could not be accepted for execution. Usually due to too many work in progress.

fallbackHandle

Object fallbackHandle(Class<? extends org.eclipse.microprofile.faulttolerance.FallbackHandler<?>> fallbackClass,
                      javax.interceptor.InvocationContext context,
                      Exception ex)
               throws Exception

Invokes the instance of the given FallbackHandler Class defined in the given context to handle the given Exception.

Parameters:

fallbackClass - the type of FallbackHandler to resolve or instantiate and use

context - the currently processed context to use for arguments

ex - the Exception thrown by the FT processing to handle by the FallbackHandler

Returns:

the result returned by the invoked FallbackHandler

Throws:

Exception - in case resolving, instantiating or invoking the handler method fails

fallbackInvoke

Object fallbackInvoke(Method fallbackMethod,
                      javax.interceptor.InvocationContext context)
               throws Exception

Invokes the given fallback Method in the given context.

Parameters:

fallbackMethod - the Method to invoke

context - the currently processed context to use for target instance and method arguments

Returns:

the result returned by the invoked fallback method

Throws:

Exception - in case invoking the method fails or the invoked method threw an Exception

trace

void trace(String method,
           javax.interceptor.InvocationContext context)

Starts tracing the given context named with the given method label.

Parameters:

method - the label to use for the trace

context - the currently processed context

endTrace

void endTrace()

Ends the innermost trace.