Modifier and Type	Class and Description
public static interface	OciCircuitBreaker.Config
public static class	OciCircuitBreaker.ErrorHistoryItem

Method Summary

Modifier and Type	Method and Description
public void	acquirePermission() Try to obtain a permission to execute a call.
public void	addToHistory(Throwable throwable, Integer status, Map<String, String> messages)
public String	circuitBreakerCallNotPermittedErrorMessage(String requestUri)
public CallNotAllowedException	createCallNotAllowedException()
public OciCircuitBreaker.Config	Returns: the CircuitBreakerConfig of this CircuitBreaker getCircuitBreakerConfig() Returns the CircuitBreakerConfig of this CircuitBreaker.
public long	Returns: current timestamp getCurrentTimestamp() Returns the current time with respect to the CircuitBreaker currentTimeFunction.
public List<OciCircuitBreaker.ErrorHistoryItem>	getHistory()
public String	getHistoryAsString()
public String	Returns: the name of this CircuitBreaker getName() Returns the name of this CircuitBreaker.
public CircuitBreaker	getR4jCircuitBreaker()
public CircuitBreaker.State	Returns: the state of this CircuitBreaker getState() Returns the state of this CircuitBreaker.
public TimeUnit	Returns: the timeUnit of current timestamp getTimestampUnit() Returns the timeUnit of current timestamp.
public void	onError(long The elapsed time duration of the call duration, TimeUnit The duration unit durationUnit, Throwable The throwable which must be recorded throwable) Records a failed call.
public void	onResult(long The elapsed time duration of the call duration, TimeUnit The duration unit durationUnit, Object The result of the protected function result) This method must be invoked when a call returned a result and the result predicate should decide if the call was successful or not.
public void	onSuccess(long The elapsed time duration of the call duration, TimeUnit The duration unit durationUnit) Records a successful call.
public void	releasePermission() Releases a permission.
public boolean	Returns: `true` if a permission was acquired and `false` otherwise tryAcquirePermission() Acquires a permission to execute a call, only if one is available at the time of invocation.

Method Detail

acquirePermission	back to summary
public void acquirePermission() Try to obtain a permission to execute a call. If a call is not permitted, the number of not permitted calls is increased. Throws a CallNotPermittedException when the state is OPEN or FORCED_OPEN. Returns when the state is CLOSED or DISABLED. Returns when the state is HALF_OPEN and further test calls are allowed. Throws a CallNotPermittedException when the state is HALF_OPEN and the number of test calls has been reached. If the state is HALF_OPEN, the number of allowed test calls is decreased. Important Note Make sure to call onSuccess or onError after the call is finished. If the call is cancelled before it is invoked, you have to release the permission again. Exceptions CallNotPermittedException: when CircuitBreaker is OPEN or HALF_OPEN and no further test calls are permitted.

acquirePermission

back to summary

public void acquirePermission()

Try to obtain a permission to execute a call. If a call is not permitted, the number of not permitted calls is increased.

Throws a CallNotPermittedException when the state is OPEN or FORCED_OPEN. Returns when the state is CLOSED or DISABLED. Returns when the state is HALF_OPEN and further test calls are allowed. Throws a CallNotPermittedException when the state is HALF_OPEN and the number of test calls has been reached. If the state is HALF_OPEN, the number of allowed test calls is decreased.

Important Note

Make sure to call onSuccess or onError after the call is finished. If the call is cancelled before it is invoked, you have to release the permission again.

Exceptions

CallNotPermittedException:: when CircuitBreaker is OPEN or HALF_OPEN and no further test calls are permitted.

addToHistory	back to summary
public void addToHistory(Throwable throwable, Integer status, Map<String, String> messages)

circuitBreakerCallNotPermittedErrorMessage	back to summary
public String circuitBreakerCallNotPermittedErrorMessage(String requestUri)

createCallNotAllowedException	back to summary
public CallNotAllowedException createCallNotAllowedException()

getCircuitBreakerConfig	back to summary
public OciCircuitBreaker.Config getCircuitBreakerConfig() Returns the CircuitBreakerConfig of this CircuitBreaker. Returns:OciCircuitBreaker.Config the CircuitBreakerConfig of this CircuitBreaker

getCircuitBreakerConfig

back to summary

public OciCircuitBreaker.Config getCircuitBreakerConfig()

Returns the CircuitBreakerConfig of this CircuitBreaker.

Returns:OciCircuitBreaker.Config: the CircuitBreakerConfig of this CircuitBreaker

getCurrentTimestamp	back to summary
public long getCurrentTimestamp() Returns the current time with respect to the CircuitBreaker currentTimeFunction. Returns System.nanoTime() by default. Returns:long current timestamp

getCurrentTimestamp

back to summary

public long getCurrentTimestamp()

Returns the current time with respect to the CircuitBreaker currentTimeFunction. Returns System.nanoTime() by default.

Returns:long: current timestamp

getHistory	back to summary
public List<OciCircuitBreaker.ErrorHistoryItem> getHistory()

getHistoryAsString	back to summary
public String getHistoryAsString()

getName	back to summary
public String getName() Returns the name of this CircuitBreaker. Returns:String the name of this CircuitBreaker

getName

back to summary

public String getName()

Returns the name of this CircuitBreaker.

Returns:String: the name of this CircuitBreaker

getR4jCircuitBreaker	back to summary
public CircuitBreaker getR4jCircuitBreaker()

getState	back to summary
public CircuitBreaker.State getState() Returns the state of this CircuitBreaker. Returns:CircuitBreaker.State the state of this CircuitBreaker

getState

back to summary

public CircuitBreaker.State getState()

Returns the state of this CircuitBreaker.

Returns:CircuitBreaker.State: the state of this CircuitBreaker

getTimestampUnit	back to summary
public TimeUnit getTimestampUnit() Returns the timeUnit of current timestamp. Default is TimeUnit.NANOSECONDS. Returns:TimeUnit the timeUnit of current timestamp

getTimestampUnit

back to summary

public TimeUnit getTimestampUnit()

Returns the timeUnit of current timestamp. Default is TimeUnit.NANOSECONDS.

Returns:TimeUnit: the timeUnit of current timestamp

onError	back to summary
public void onError(long duration, TimeUnit durationUnit, Throwable throwable) Records a failed call. This method must be invoked when a call failed. Parameters duration:long The elapsed time duration of the call durationUnit:TimeUnit The duration unit throwable:Throwable The throwable which must be recorded

onError

back to summary

public void onError(long duration, TimeUnit durationUnit, Throwable throwable)

Records a failed call. This method must be invoked when a call failed.

Parameters

duration:long: The elapsed time duration of the call
durationUnit:TimeUnit: The duration unit
throwable:Throwable: The throwable which must be recorded

onResult	back to summary
public void onResult(long duration, TimeUnit durationUnit, Object result) This method must be invoked when a call returned a result and the result predicate should decide if the call was successful or not. Parameters duration:long The elapsed time duration of the call durationUnit:TimeUnit The duration unit result:Object The result of the protected function

onResult

back to summary

public void onResult(long duration, TimeUnit durationUnit, Object result)

This method must be invoked when a call returned a result and the result predicate should decide if the call was successful or not.

Parameters

duration:long: The elapsed time duration of the call
durationUnit:TimeUnit: The duration unit
result:Object: The result of the protected function

onSuccess	back to summary
public void onSuccess(long duration, TimeUnit durationUnit) Records a successful call. This method must be invoked when a call was successful. Parameters duration:long The elapsed time duration of the call durationUnit:TimeUnit The duration unit

onSuccess

back to summary

public void onSuccess(long duration, TimeUnit durationUnit)

Records a successful call. This method must be invoked when a call was successful.

Parameters

duration:long: The elapsed time duration of the call
durationUnit:TimeUnit: The duration unit

releasePermission back to summary

releasePermission	back to summary
public void releasePermission() Releases a permission. Should only be used when a permission was acquired but not used. Otherwise use `CircuitBreaker#onSuccess(long, TimeUnit)` or `CircuitBreaker#onError(long, TimeUnit, Throwable)` to signal a completed or failed call. If the state is HALF_OPEN, the number of allowed test calls is increased by one.

public void releasePermission()

Releases a permission.

Should only be used when a permission was acquired but not used. Otherwise use CircuitBreaker#onSuccess(long, TimeUnit) or CircuitBreaker#onError(long, TimeUnit, Throwable) to signal a completed or failed call.

If the state is HALF_OPEN, the number of allowed test calls is increased by one.

tryAcquirePermission back to summary

tryAcquirePermission	back to summary
public boolean tryAcquirePermission() Acquires a permission to execute a call, only if one is available at the time of invocation. If a call is not permitted, the number of not permitted calls is increased. Returns false when the state is OPEN or FORCED_OPEN. Returns true when the state is CLOSED or DISABLED. Returns true when the state is HALF_OPEN and further test calls are allowed. Returns false when the state is HALF_OPEN and the number of test calls has been reached. If the state is HALF_OPEN, the number of allowed test calls is decreased. Important Note Make sure to call onSuccess or onError after the call is finished. If the call is cancelled before it is invoked, you have to release the permission again. Returns:boolean `true` if a permission was acquired and `false` otherwise

public boolean tryAcquirePermission()

Acquires a permission to execute a call, only if one is available at the time of invocation. If a call is not permitted, the number of not permitted calls is increased.

Returns false when the state is OPEN or FORCED_OPEN. Returns true when the state is CLOSED or DISABLED. Returns true when the state is HALF_OPEN and further test calls are allowed. Returns false when the state is HALF_OPEN and the number of test calls has been reached. If the state is HALF_OPEN, the number of allowed test calls is decreased.

Important Note

Make sure to call onSuccess or onError after the call is finished. If the call is cancelled before it is invoked, you have to release the permission again.

Returns:boolean: true if a permission was acquired and false otherwise

com.oracle.bmc.circuitbreaker back to summary

public Interface OciCircuitBreaker.Config

Known Direct Implementers: com.oracle.bmc.circuitbreaker.internal.resilience4j.OciCircuitBreakerImpl.OciCircuitBreakerConfigImpl

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	OciCircuitBreaker.Config.IntervalFunction An IntervalFunction which can be used to calculate the wait interval.
public static enum	OciCircuitBreaker.Config.SlidingWindowType

Method Summary

Modifier and Type	Method and Description
public float	getFailureRateThreshold()
public int	getMinimumNumberOfCalls()
public int	getPermittedNumberOfCallsInHalfOpenState()
public Predicate<Throwable>	getRecordExceptionPredicate()
public int	getSlidingWindowSize()
public OciCircuitBreaker.Config.SlidingWindowType	getSlidingWindowType()
public Duration	getSlowCallDurationThreshold()
public float	getSlowCallRateThreshold()
public boolean	isWritableStackTraceEnabled()

Method Detail

getFailureRateThreshold	back to summary
public float getFailureRateThreshold()

getMinimumNumberOfCalls	back to summary
public int getMinimumNumberOfCalls()

getPermittedNumberOfCallsInHalfOpenState	back to summary
public int getPermittedNumberOfCallsInHalfOpenState()

getRecordExceptionPredicate	back to summary
public Predicate<Throwable> getRecordExceptionPredicate()

getSlidingWindowSize	back to summary
public int getSlidingWindowSize()

getSlidingWindowType	back to summary
public OciCircuitBreaker.Config.SlidingWindowType getSlidingWindowType()

getSlowCallDurationThreshold	back to summary
public Duration getSlowCallDurationThreshold()

getSlowCallRateThreshold	back to summary
public float getSlowCallRateThreshold()

isWritableStackTraceEnabled	back to summary
public boolean isWritableStackTraceEnabled()

com.oracle.bmc.circuitbreaker back to summary

public Interface OciCircuitBreaker.Config.IntervalFunction

Annotations

extends Function<Integer, Long>

@FunctionalInterface

An IntervalFunction which can be used to calculate the wait interval. The input parameter of the function is the number of attempts (attempt), the output parameter the wait interval in milliseconds. The attempt parameter starts at 1 and increases with every further attempt.

Method Summary

Inherited from java.util.function.Function:: andThen apply compose identity

com.oracle.bmc.circuitbreaker back to summary

public final Enum OciCircuitBreaker.Config.SlidingWindowType

Class Inheritance

extends Enum<OciCircuitBreaker.Config.SlidingWindowType>

java.lang.Object
java.lang.Enum
com.oracle.bmc.circuitbreaker.OciCircuitBreaker.Config.SlidingWindowType

Field Summary

Modifier and Type	Field and Description
public static final OciCircuitBreaker.Config.SlidingWindowType	COUNT_BASED
public static final OciCircuitBreaker.Config.SlidingWindowType	TIME_BASED

Constructor Summary

Access	Constructor and Description
private	SlidingWindowType()

Method Summary

Modifier and Type	Method and Description
public static OciCircuitBreaker.Config.SlidingWindowType	valueOf(String name)
public static OciCircuitBreaker.Config.SlidingWindowType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COUNT_BASED	back to summary
public static final OciCircuitBreaker.Config.SlidingWindowType COUNT_BASED

TIME_BASED	back to summary
public static final OciCircuitBreaker.Config.SlidingWindowType TIME_BASED

Constructor Detail

SlidingWindowType	back to summary
private SlidingWindowType()

Method Detail

valueOf	back to summary
public static OciCircuitBreaker.Config.SlidingWindowType valueOf(String name)

values	back to summary
public static OciCircuitBreaker.Config.SlidingWindowType[] values()

com.oracle.bmc.circuitbreaker back to summary

public Class OciCircuitBreaker.ErrorHistoryItem

Class Inheritance

extends Object

java.lang.Object
com.oracle.bmc.circuitbreaker.OciCircuitBreaker.ErrorHistoryItem

Field Summary

Modifier and Type	Field and Description
private final Map<String, String>	messages
private final Integer	status
private final Throwable	throwable

Constructor Summary

Access	Constructor and Description
public	ErrorHistoryItem(Throwable throwable, Integer status, Map<String, String> messages)

Method Summary

Modifier and Type	Method and Description
public Map<String, String>	getMessages()
public int	getStatus()
public Throwable	getThrowable()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

messages	back to summary
private final Map<String, String> messages

status	back to summary
private final Integer status

throwable	back to summary
private final Throwable throwable

Constructor Detail

ErrorHistoryItem	back to summary
public ErrorHistoryItem(Throwable throwable, Integer status, Map<String, String> messages)

Method Detail

getMessages	back to summary
public Map<String, String> getMessages()

getStatus	back to summary
public int getStatus()

getThrowable	back to summary
public Throwable getThrowable()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object