fish.payara.microprofile.faulttolerance.policy

Class CircuitBreakerPolicy

java.lang.Object

fish.payara.microprofile.faulttolerance.policy.Policy

fish.payara.microprofile.faulttolerance.policy.CircuitBreakerPolicy

All Implemented Interfaces:

Serializable

public final class CircuitBreakerPolicy
extends Policy

The resolved "cached" information of a CircuitBreaker annotation an a specific method.

Author:

Jan Bernitt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
long	delay
ChronoUnit	delayUnit
Class<? extends Throwable>[]	failOn
double	failureRatio
int	requestVolumeThreshold
int	successThreshold

Constructor Summary

Constructors

Constructor and Description
CircuitBreakerPolicy(Method annotatedMethod, Class<? extends Throwable>[] failOn, long delay, ChronoUnit delayUnit, int requestVolumeThreshold, double failureRatio, int successThreshold)

Method Summary

Modifier and Type	Method and Description
static CircuitBreakerPolicy	create(javax.interceptor.InvocationContext context, FaultToleranceConfig config)
boolean	failOn(Exception ex) Helper method that checks whether or not the given exception is included in the failOn parameter.

Methods inherited from class fish.payara.microprofile.faulttolerance.policy.Policy

checkAtLeast, checkAtLeast, checkAtLeast, checkAtMost, checkReturnsSameAs, checkReturnsSameAs, describe, isCaught

Methods inherited from class java.lang.Object

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

Field Detail

failOn

public final Class<? extends Throwable>[] failOn

delay

public final long delay

delayUnit

public final ChronoUnit delayUnit

requestVolumeThreshold

public final int requestVolumeThreshold

failureRatio

public final double failureRatio

successThreshold

public final int successThreshold

Constructor Detail

CircuitBreakerPolicy

public CircuitBreakerPolicy(Method annotatedMethod,
                            Class<? extends Throwable>[] failOn,
                            long delay,
                            ChronoUnit delayUnit,
                            int requestVolumeThreshold,
                            double failureRatio,
                            int successThreshold)

Method Detail

create

public static CircuitBreakerPolicy create(javax.interceptor.InvocationContext context,
                                          FaultToleranceConfig config)

failOn

public boolean failOn(Exception ex)

Helper method that checks whether or not the given exception is included in the failOn parameter.

Parameters:

ex - The exception to check

Returns:

True if the exception is covered by failOn list of this policy