fish.payara.microprofile.faulttolerance

Class FaultToleranceService

java.lang.Object

fish.payara.microprofile.faulttolerance.FaultToleranceService

All Implemented Interfaces:

EventListener

@Service(name="microprofile-fault-tolerance-service")
 @RunLevel(value=10)
public class FaultToleranceService
extends Object
implements EventListener

Base Service for MicroProfile Fault Tolerance.

Author:

Andrew Pielage

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.api.event.EventListener

EventListener.Event<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	FALLBACK_HANDLER_METHOD_NAME
static String	FAULT_TOLERANCE_ENABLED_PROPERTY

Constructor Summary

Constructors

Constructor and Description
FaultToleranceService()

Method Summary

Modifier and Type	Method and Description
void	event(EventListener.Event event) Process a Glassfish/Payara event
String	getApplicationName(InvocationManager invocationManager, javax.interceptor.InvocationContext invocationContext) Gets the application name from the invocation manager.
Semaphore	getBulkheadExecutionQueueSemaphore(String applicationName, Method annotatedMethod, int bulkheadWaitingTaskQueue) Gets the Bulkhead Execution Queue Semaphore for a given application method, registering it to the FaultToleranceService if it hasn't already.
Semaphore	getBulkheadExecutionSemaphore(String applicationName, Method annotatedMethod, int bulkheadValue) Gets the Bulkhead Execution Semaphore for a given application method, registering it to the FaultToleranceService if it hasn't already.
CircuitBreakerState	getCircuitBreakerState(String applicationName, Method annotatedMethod, org.eclipse.microprofile.faulttolerance.CircuitBreaker circuitBreaker) Gets the CircuitBreakerState object for a given application name and method.
javax.enterprise.concurrent.ManagedExecutorService	getManagedExecutorService() Gets the configured ManagedExecutorService.
javax.enterprise.concurrent.ManagedScheduledExecutorService	getManagedScheduledExecutorService() Gets the configured ManagedScheduledExecutorService.
Boolean	isFaultToleranceEnabled(String applicationName, org.eclipse.microprofile.config.Config config) Checks whether fault tolerance is enabled for a given application, setting its enabled value if it doesn't already have one.
void	postConstruct()
void	traceFaultToleranceEvent(RequestEvent requestEvent, InvocationManager invocationManager, javax.interceptor.InvocationContext invocationContext)

Methods inherited from class java.lang.Object

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

Field Detail

FAULT_TOLERANCE_ENABLED_PROPERTY

public static final String FAULT_TOLERANCE_ENABLED_PROPERTY

See Also:

Constant Field Values

FALLBACK_HANDLER_METHOD_NAME

public static final String FALLBACK_HANDLER_METHOD_NAME

See Also:

Constant Field Values

Constructor Detail

FaultToleranceService

public FaultToleranceService()

Method Detail

postConstruct

@PostConstruct
public void postConstruct()

event

public void event(EventListener.Event event)

Description copied from interface: EventListener

Process a Glassfish/Payara event

Specified by:

event in interface EventListener

isFaultToleranceEnabled

public Boolean isFaultToleranceEnabled(String applicationName,
                                       org.eclipse.microprofile.config.Config config)

Checks whether fault tolerance is enabled for a given application, setting its enabled value if it doesn't already have one.

Parameters:

applicationName - The application to check if Fault Tolerance is enabled for.

config - The application config to check for any override values when setting the enabled status for an unregistered application.

Returns:

True if Fault Tolerance is enabled for the given application name

getManagedExecutorService

public javax.enterprise.concurrent.ManagedExecutorService getManagedExecutorService()
                                                                             throws NamingException

Gets the configured ManagedExecutorService.

Returns:

The configured ManagedExecutorService, or the default ManagedExecutorService if the configured one couldn't be found

Throws:

NamingException - If the default ManagedExecutorService couldn't be found

getManagedScheduledExecutorService

public javax.enterprise.concurrent.ManagedScheduledExecutorService getManagedScheduledExecutorService()
                                                                                               throws NamingException

Gets the configured ManagedScheduledExecutorService.

Returns:

The configured ManagedExecutorService, or the default ManagedScheduledExecutorService if the configured one couldn't be found

Throws:

NamingException - If the default ManagedScheduledExecutorService couldn't be found

getBulkheadExecutionSemaphore

public Semaphore getBulkheadExecutionSemaphore(String applicationName,
                                               Method annotatedMethod,
                                               int bulkheadValue)

Gets the Bulkhead Execution Semaphore for a given application method, registering it to the FaultToleranceService if it hasn't already.

Parameters:

applicationName - The name of the application

annotatedMethod - The method that's annotated with @Bulkhead

bulkheadValue - The value parameter of the Bulkhead annotation

Returns:

The Semaphore for the given application method.

getBulkheadExecutionQueueSemaphore

public Semaphore getBulkheadExecutionQueueSemaphore(String applicationName,
                                                    Method annotatedMethod,
                                                    int bulkheadWaitingTaskQueue)

Gets the Bulkhead Execution Queue Semaphore for a given application method, registering it to the FaultToleranceService if it hasn't already.

Parameters:

applicationName - The name of the application

annotatedMethod - The method that's annotated with @Bulkhead and @Asynchronous

bulkheadWaitingTaskQueue - The waitingTaskQueue parameter of the Bulkhead annotation

Returns:

The Semaphore for the given application method.

getCircuitBreakerState

public CircuitBreakerState getCircuitBreakerState(String applicationName,
                                                  Method annotatedMethod,
                                                  org.eclipse.microprofile.faulttolerance.CircuitBreaker circuitBreaker)

Gets the CircuitBreakerState object for a given application name and method. If a CircuitBreakerState hasn't been registered for the given application name and method, it will register the given CircuitBreaker.

Parameters:

applicationName - The application name

annotatedMethod - The method annotated with @CircuitBreaker

circuitBreaker - The @CircuitBreaker annotation from the annotated method

Returns:

The CircuitBreakerState for the given application and method

getApplicationName

public String getApplicationName(InvocationManager invocationManager,
                                 javax.interceptor.InvocationContext invocationContext)

Gets the application name from the invocation manager. Failing that, it will use the module name, component name, or method signature (in that order).

Parameters:

invocationManager - The invocation manager to get the application name from

invocationContext - The context of the current invocation

Returns:

The application name

traceFaultToleranceEvent

public void traceFaultToleranceEvent(RequestEvent requestEvent,
                                     InvocationManager invocationManager,
                                     javax.interceptor.InvocationContext invocationContext)