Skip navigation links
A B C D E G H I L M N O P R S T V W 

A

AbstractCircuitBreaker<R> - Class in net.secodo.jcircuitbreaker.breaker.impl
 
AbstractCircuitBreaker() - Constructor for class net.secodo.jcircuitbreaker.breaker.impl.AbstractCircuitBreaker
 
allOf(BreakStrategy...) - Static method in class net.secodo.jcircuitbreaker.breakstrategy.SimpleStrategyDsl
Returns BreakStrategy which returns true if all of the given strategies returns true.
anyOf(BreakStrategy...) - Static method in class net.secodo.jcircuitbreaker.breakstrategy.SimpleStrategyDsl
Returns BreakStrategy which returns true if at least one of the given strategies returns true.

B

BreakHandler<R> - Interface in net.secodo.jcircuitbreaker.breakhandler
Handles break situation.
BreakHandlerException - Exception in net.secodo.jcircuitbreaker.breakhandler.exception
Thrown by implementations of BreakHandler to indicate that the break handler failed to handle break and was not able to provide the fallback value.
BreakHandlerException(String) - Constructor for exception net.secodo.jcircuitbreaker.breakhandler.exception.BreakHandlerException
 
BreakHandlerException(String, Throwable) - Constructor for exception net.secodo.jcircuitbreaker.breakhandler.exception.BreakHandlerException
 
BreakHandlerFactory<R> - Interface in net.secodo.jcircuitbreaker.breakhandler
This is generic factory method interface.
BreakStrategy<R> - Interface in net.secodo.jcircuitbreaker.breakstrategy
Break strategy defines if the circuit breaker should "break".
build() - Method in class net.secodo.jcircuitbreaker.breaker.builder.impl.ReusableCircuitBreakerBuilder
Creates new instance of the breaker.
builder() - Static method in class net.secodo.jcircuitbreaker.breaker.impl.ReusableCircuitBreaker
builderP() - Static method in class net.secodo.jcircuitbreaker.breaker.impl.ReusableCircuitBreaker
BuilderValidationException - Exception in net.secodo.jcircuitbreaker.breaker.builder
 
BuilderValidationException(String) - Constructor for exception net.secodo.jcircuitbreaker.breaker.builder.BuilderValidationException
 
buildMessage(Task<R>, ExecutionContext<R>) - Method in class net.secodo.jcircuitbreaker.breakhandler.impl.ExceptionThrowingHandler
 
buildMessage(Task<R>, ExecutionContext<R>) - Method in interface net.secodo.jcircuitbreaker.breakhandler.impl.ExceptionThrowingHandlerMessageCallback
 

C

CircuitBreaker<R> - Interface in net.secodo.jcircuitbreaker.breaker
This interface defines the circuit breaker contract.
CircuitBreakerException - Exception in net.secodo.jcircuitbreaker.exception
 
CircuitBreakerException(String) - Constructor for exception net.secodo.jcircuitbreaker.exception.CircuitBreakerException
 
CircuitBreakerException(String, Throwable) - Constructor for exception net.secodo.jcircuitbreaker.exception.CircuitBreakerException
 
constructSingleParamInstance(Class<? extends BreakHandler>, P) - Static method in class net.secodo.jcircuitbreaker.breakhandler.helper.InstantiationHelper
Creates new instances of given BreakHandler class.
ContextAwareCircuitBreaker<R> - Interface in net.secodo.jcircuitbreaker.breaker
This interface defines the method which allows to execute a task within given ExecutionContext.
createNewHandler(Task<R>, ExecutionContext<R>) - Method in class net.secodo.jcircuitbreaker.breakhandler.impl.ReusableRetryHandler
 
createNewHandler(Task<R>, ExecutionContext<R>) - Method in interface net.secodo.jcircuitbreaker.breakhandler.OnePerExecutionHandlerFactory
Constructs and returns new BreakHandler.

D

DefaultCircuitBreaker<R> - Class in net.secodo.jcircuitbreaker.breaker.impl
Default implementation of the CircuitBreaker which requires each component (ie.
DefaultCircuitBreaker() - Constructor for class net.secodo.jcircuitbreaker.breaker.impl.DefaultCircuitBreaker
 
DefaultExecutionContextImpl<R> - Class in net.secodo.jcircuitbreaker.breaker.execution.impl
 
DefaultExecutionContextImpl(ConcurrentHashMap<String, ExecutedTask<R>>, Object) - Constructor for class net.secodo.jcircuitbreaker.breaker.execution.impl.DefaultExecutionContextImpl
 
DslAndStrategy<R> - Class in net.secodo.jcircuitbreaker.breakstrategy.impl.dsl
 
DslAndStrategy(BreakStrategy<R>, BreakStrategy<R>) - Constructor for class net.secodo.jcircuitbreaker.breakstrategy.impl.dsl.DslAndStrategy
 
DslOrStrategy<R> - Class in net.secodo.jcircuitbreaker.breakstrategy.impl.dsl
 
DslOrStrategy(BreakStrategy<R>, BreakStrategy<R>) - Constructor for class net.secodo.jcircuitbreaker.breakstrategy.impl.dsl.DslOrStrategy
 

E

equals(Object) - Method in class net.secodo.jcircuitbreaker.breaker.execution.ExecutedTask
 
ExceptionThrowingHandler<R> - Class in net.secodo.jcircuitbreaker.breakhandler.impl
The handler that throws custom exception in case "break" occurs.
ExceptionThrowingHandler(String) - Constructor for class net.secodo.jcircuitbreaker.breakhandler.impl.ExceptionThrowingHandler
Constructs new instance of ExceptionThrowingHandler which will throw BreakHandlerException with given message in case "break" occurred (circuit breaker executed break handler instead of real-method).
ExceptionThrowingHandler(ExceptionThrowingHandlerMessageCallback<R>) - Constructor for class net.secodo.jcircuitbreaker.breakhandler.impl.ExceptionThrowingHandler
ExceptionThrowingHandler(Class<? extends BreakHandlerException>, String) - Constructor for class net.secodo.jcircuitbreaker.breakhandler.impl.ExceptionThrowingHandler
Constructs new instance of ExceptionThrowingHandler which will throw exception of given class with given message in case "break" occurred (circuit breaker executed break handler instead of real-method).
ExceptionThrowingHandler(Class<? extends BreakHandlerException>, ExceptionThrowingHandlerMessageCallback<R>) - Constructor for class net.secodo.jcircuitbreaker.breakhandler.impl.ExceptionThrowingHandler
Constructs new instance of ExceptionThrowingHandler which will throw exception of given class with message obtained from given callback, in case "break" occurred (circuit breaker executed break handler instead of real-method).
ExceptionThrowingHandlerMessageCallback<R> - Interface in net.secodo.jcircuitbreaker.breakhandler.impl
 
execute(Task<R>, BreakStrategy<R>, BreakHandler<R>) - Method in interface net.secodo.jcircuitbreaker.breaker.CircuitBreaker
Executes the given Callable only when given BreakStrategy allows the execution at the time of call.
execute(Task<R>, BreakStrategy<R>, BreakHandler<R>, U) - Method in interface net.secodo.jcircuitbreaker.breaker.CircuitBreaker
Executes the given Callable only when given BreakStrategy allows the execution at the time of call.
execute(Task<R>, BreakStrategy<R>, BreakHandler<R>, U) - Method in class net.secodo.jcircuitbreaker.breaker.impl.AbstractCircuitBreaker
 
execute(Task<R>) - Method in class net.secodo.jcircuitbreaker.breaker.impl.ReusableCircuitBreaker
Executes given Task within this breaker using BreakStrategy and BreakHandler given as the params.
execute(Task<R>, U) - Method in class net.secodo.jcircuitbreaker.breaker.impl.ReusableCircuitBreaker
Executes given Task within this breaker using BreakStrategy and BreakHandler given as the params with custom data passed as userData param.
execute() - Method in class net.secodo.jcircuitbreaker.task.experimental.MethodInvokingTask
 
execute() - Method in interface net.secodo.jcircuitbreaker.task.Task
 
execute() - Method in interface net.secodo.jcircuitbreaker.task.VoidTask
 
ExecutedTask<R> - Class in net.secodo.jcircuitbreaker.breaker.execution
Class that wraps the real executed method (Task).
ExecutedTask(Task<R>, long) - Constructor for class net.secodo.jcircuitbreaker.breaker.execution.ExecutedTask
 
executeInContext(Task<R>, BreakStrategy<R>, BreakHandler<R>, ExecutionContext<R>) - Method in interface net.secodo.jcircuitbreaker.breaker.ContextAwareCircuitBreaker
Executes given task within given execution context.
executeInContext(Task<R>, BreakStrategy<R>, BreakHandler<R>, ExecutionContext<R>) - Method in class net.secodo.jcircuitbreaker.breaker.impl.AbstractCircuitBreaker
 
executeVoid() - Method in interface net.secodo.jcircuitbreaker.task.VoidTask
 
ExecutionContext<R> - Interface in net.secodo.jcircuitbreaker.breaker.execution
Defines context which is specific to single execution of Task (target method) by circuit breaker.

G

getContextAttribute(String) - Method in interface net.secodo.jcircuitbreaker.breaker.execution.ExecutionContext
Returns value of given context attribute or null of there is no such attribute.
getContextAttribute(String) - Method in class net.secodo.jcircuitbreaker.breaker.execution.impl.DefaultExecutionContextImpl
 
getCurrentTimeMilis() - Method in class net.secodo.jcircuitbreaker.util.TimeUtil
Convenience method.
getExecutionsInProgress() - Method in interface net.secodo.jcircuitbreaker.breaker.execution.ExecutionContext
Returns collection of Tasks which are currently executed by circuit breaker.
getExecutionsInProgress() - Method in class net.secodo.jcircuitbreaker.breaker.execution.impl.DefaultExecutionContextImpl
 
getExecutionStartedTimestamp() - Method in class net.secodo.jcircuitbreaker.breaker.execution.ExecutedTask
 
getOnePerExecutionContextParamName(Task<R>, ExecutionContext<R>) - Method in class net.secodo.jcircuitbreaker.breakhandler.impl.ReusableRetryHandler
 
getOnePerExecutionContextParamName(Task<R>, ExecutionContext<R>) - Method in interface net.secodo.jcircuitbreaker.breakhandler.OnePerExecutionHandlerFactory
Returns execution context parameter name under which produced break handler will be stored.
getTask() - Method in class net.secodo.jcircuitbreaker.breaker.execution.ExecutedTask
 
getTaskException() - Method in exception net.secodo.jcircuitbreaker.exception.TaskExecutionException
 
getUserData() - Method in interface net.secodo.jcircuitbreaker.breaker.execution.ExecutionContext
Returns custom data that could haven been passed to the circuit breaker when executing Task.
getUserData() - Method in class net.secodo.jcircuitbreaker.breaker.execution.impl.DefaultExecutionContextImpl
 

H

hasContextAttribute(String) - Method in interface net.secodo.jcircuitbreaker.breaker.execution.ExecutionContext
Return true if context attribute with given name exists.
hasContextAttribute(String) - Method in class net.secodo.jcircuitbreaker.breaker.execution.impl.DefaultExecutionContextImpl
 
hashCode() - Method in class net.secodo.jcircuitbreaker.breaker.execution.ExecutedTask
 

I

InstantiationHelper - Class in net.secodo.jcircuitbreaker.breakhandler.helper
Helper class which role is to create new instances of given BreakHandler class.
InstantiationHelper() - Constructor for class net.secodo.jcircuitbreaker.breakhandler.helper.InstantiationHelper
 

L

LimitedConcurrentExecutionsStrategy<R> - Class in net.secodo.jcircuitbreaker.breakstrategy.impl
An implementation of BreakStrategy which causes the circuit breaker to break (not execute the Task) in case all tasks currently running inside the circuit breaker reaches the allowed maximum (defined by maxSupportedExecutions constructor param).
LimitedConcurrentExecutionsStrategy(long) - Constructor for class net.secodo.jcircuitbreaker.breakstrategy.impl.LimitedConcurrentExecutionsStrategy
 
LimitedCurrentAverageExecutionTimeStrategy<R> - Class in net.secodo.jcircuitbreaker.breakstrategy.impl
An implementation of BreakStrategy which causes the circuit breaker to break (not execute the Task) in case all tasks currently running inside the circuit breaker takes long time on average.
LimitedCurrentAverageExecutionTimeStrategy(long, int) - Constructor for class net.secodo.jcircuitbreaker.breakstrategy.impl.LimitedCurrentAverageExecutionTimeStrategy
Constructs new strategy with given maximum allowed execution.
LimitedCurrentAverageExecutionTimeStrategy(long) - Constructor for class net.secodo.jcircuitbreaker.breakstrategy.impl.LimitedCurrentAverageExecutionTimeStrategy
Constructs new strategy with given maximum allowed execution.

M

makeHandler(Task<R>, ExecutionContext<R>) - Method in interface net.secodo.jcircuitbreaker.breakhandler.BreakHandlerFactory
Returns an instance of BreakHandler which should be used to handle the break.
makeHandler(Task<R>, ExecutionContext<R>) - Method in class net.secodo.jcircuitbreaker.breakhandler.impl.SimpleHandlerFactory
 
makeHandler(Task<R>, ExecutionContext<R>) - Method in interface net.secodo.jcircuitbreaker.breakhandler.OnePerExecutionHandlerFactory
 
maxAllowedExecutionTimeMillis - Variable in class net.secodo.jcircuitbreaker.breakstrategy.impl.LimitedCurrentAverageExecutionTimeStrategy
Protected access to allow extending classes to dynamically change it, e.g. via MBean
maxSupportedExecutions - Variable in class net.secodo.jcircuitbreaker.breakstrategy.impl.LimitedConcurrentExecutionsStrategy
Protected access to allow extending classes to dynamically change it, e.g. via MBean
MethodInvokingTask<R,T> - Class in net.secodo.jcircuitbreaker.task.experimental
Explicitly encapsulates and object and method of the object which should be executed by circuit breaker.
MethodInvokingTask(T, String, Class<R>, Object...) - Constructor for class net.secodo.jcircuitbreaker.task.experimental.MethodInvokingTask
Constructs new Task which invokes method with given name and method arguments on given object.

N

net.secodo.jcircuitbreaker.breaker - package net.secodo.jcircuitbreaker.breaker
 
net.secodo.jcircuitbreaker.breaker.builder - package net.secodo.jcircuitbreaker.breaker.builder
 
net.secodo.jcircuitbreaker.breaker.builder.impl - package net.secodo.jcircuitbreaker.breaker.builder.impl
 
net.secodo.jcircuitbreaker.breaker.execution - package net.secodo.jcircuitbreaker.breaker.execution
 
net.secodo.jcircuitbreaker.breaker.execution.impl - package net.secodo.jcircuitbreaker.breaker.execution.impl
 
net.secodo.jcircuitbreaker.breaker.impl - package net.secodo.jcircuitbreaker.breaker.impl
 
net.secodo.jcircuitbreaker.breakhandler - package net.secodo.jcircuitbreaker.breakhandler
 
net.secodo.jcircuitbreaker.breakhandler.exception - package net.secodo.jcircuitbreaker.breakhandler.exception
 
net.secodo.jcircuitbreaker.breakhandler.helper - package net.secodo.jcircuitbreaker.breakhandler.helper
 
net.secodo.jcircuitbreaker.breakhandler.impl - package net.secodo.jcircuitbreaker.breakhandler.impl
 
net.secodo.jcircuitbreaker.breakstrategy - package net.secodo.jcircuitbreaker.breakstrategy
 
net.secodo.jcircuitbreaker.breakstrategy.impl - package net.secodo.jcircuitbreaker.breakstrategy.impl
 
net.secodo.jcircuitbreaker.breakstrategy.impl.dsl - package net.secodo.jcircuitbreaker.breakstrategy.impl.dsl
 
net.secodo.jcircuitbreaker.exception - package net.secodo.jcircuitbreaker.exception
 
net.secodo.jcircuitbreaker.task - package net.secodo.jcircuitbreaker.task
 
net.secodo.jcircuitbreaker.task.experimental - package net.secodo.jcircuitbreaker.task.experimental
 
net.secodo.jcircuitbreaker.util - package net.secodo.jcircuitbreaker.util
 
NoActionHandler<R> - Class in net.secodo.jcircuitbreaker.breakhandler.impl
An implementation of BreakHandler that does completely nothing.
NoActionHandler() - Constructor for class net.secodo.jcircuitbreaker.breakhandler.impl.NoActionHandler
 

O

onBreak(ContextAwareCircuitBreaker<R>, Task<R>, BreakStrategy<R>, ExecutionContext<R>) - Method in interface net.secodo.jcircuitbreaker.breakhandler.BreakHandler
Handles situation when break occurs.
onBreak(ContextAwareCircuitBreaker<R>, Task<R>, BreakStrategy<R>, ExecutionContext<R>) - Method in interface net.secodo.jcircuitbreaker.breakhandler.BreakHandlerFactory
 
onBreak(ContextAwareCircuitBreaker<R>, Task<R>, BreakStrategy<R>, ExecutionContext<R>) - Method in class net.secodo.jcircuitbreaker.breakhandler.impl.ExceptionThrowingHandler
 
onBreak(ContextAwareCircuitBreaker<R>, Task<R>, BreakStrategy<R>, ExecutionContext<R>) - Method in class net.secodo.jcircuitbreaker.breakhandler.impl.NoActionHandler
 
onBreak(ContextAwareCircuitBreaker<R>, Task<R>, BreakStrategy<R>, ExecutionContext<R>) - Method in class net.secodo.jcircuitbreaker.breakhandler.impl.ReturnStaticValueHandler
 
onBreak(ContextAwareCircuitBreaker<R>, Task<R>, BreakStrategy<R>, ExecutionContext<R>) - Method in class net.secodo.jcircuitbreaker.breakhandler.impl.StatefulRetryHandler
 
OnePerExecutionHandlerFactory<R> - Interface in net.secodo.jcircuitbreaker.breakhandler
An implementation of BreakHandlerFactory which creates new instance of given BreakHandler if it does not exist in current execution context, otherwise returns BreakHandler bound to current execution context (reuses the same instance for handling subsequent calls to BreakHandler.onBreak(ContextAwareCircuitBreaker, Task, BreakStrategy, ExecutionContext)).
onRetry(int, ExecutionContext<R>) - Method in interface net.secodo.jcircuitbreaker.breakhandler.impl.RetryHandlerOnRetryCallback
 
onRetry(int, Task<R>, ExecutionContext<R>) - Method in class net.secodo.jcircuitbreaker.breakhandler.impl.StatefulRetryHandler
 

P

percentageOfMaxTimesToSkip - Variable in class net.secodo.jcircuitbreaker.breakstrategy.impl.LimitedCurrentAverageExecutionTimeStrategy
Protected access to allow extending classes to dynamically change it, e.g. via MBean

R

RetryHandlerException - Exception in net.secodo.jcircuitbreaker.breakhandler.impl
 
RetryHandlerException(String) - Constructor for exception net.secodo.jcircuitbreaker.breakhandler.impl.RetryHandlerException
 
RetryHandlerOnRetryCallback<R> - Interface in net.secodo.jcircuitbreaker.breakhandler.impl
 
ReturnStaticValueHandler<R> - Class in net.secodo.jcircuitbreaker.breakhandler.impl
An implementation of BreakHandler that always returns the value given as a parameter.
ReturnStaticValueHandler(R) - Constructor for class net.secodo.jcircuitbreaker.breakhandler.impl.ReturnStaticValueHandler
 
ReusableCircuitBreaker<R> - Class in net.secodo.jcircuitbreaker.breaker.impl
An abstract implementation of CircuitBreaker which stores its BreakStrategy and BreakHandler as fields, so that there is no need to pass them each time.
ReusableCircuitBreaker(BreakStrategy<R>, BreakHandler<R>) - Constructor for class net.secodo.jcircuitbreaker.breaker.impl.ReusableCircuitBreaker
Constructs new breaker with given break strategy and break handler.
ReusableCircuitBreakerBuilder<R> - Class in net.secodo.jcircuitbreaker.breaker.builder.impl
A builder class for ReusableCircuitBreaker.
ReusableCircuitBreakerBuilder() - Constructor for class net.secodo.jcircuitbreaker.breaker.builder.impl.ReusableCircuitBreakerBuilder
 
ReusableRetryHandler<R> - Class in net.secodo.jcircuitbreaker.breakhandler.impl
An implementation of BreakHandler which creates single instance of StatefulRetryHandler per execution context.
ReusableRetryHandler(int) - Constructor for class net.secodo.jcircuitbreaker.breakhandler.impl.ReusableRetryHandler
 

S

setContextAttribute(String, T) - Method in interface net.secodo.jcircuitbreaker.breaker.execution.ExecutionContext
Creates or sets new value for context attribute with given name.
setContextAttribute(String, T) - Method in class net.secodo.jcircuitbreaker.breaker.execution.impl.DefaultExecutionContextImpl
 
shouldBreak(Task<R>, ExecutionContext<R>) - Method in interface net.secodo.jcircuitbreaker.breakstrategy.BreakStrategy
Returns true if "break" should happen, so that the Task (target-method) does not execute and circuit breaker executes fallback break handler.
shouldBreak(Task<R>, ExecutionContext<R>) - Method in class net.secodo.jcircuitbreaker.breakstrategy.impl.dsl.DslAndStrategy
 
shouldBreak(Task<R>, ExecutionContext<R>) - Method in class net.secodo.jcircuitbreaker.breakstrategy.impl.dsl.DslOrStrategy
 
shouldBreak(Task<R>, ExecutionContext<R>) - Method in class net.secodo.jcircuitbreaker.breakstrategy.impl.LimitedConcurrentExecutionsStrategy
 
shouldBreak(Task<R>, ExecutionContext<R>) - Method in class net.secodo.jcircuitbreaker.breakstrategy.impl.LimitedCurrentAverageExecutionTimeStrategy
 
SimpleHandlerFactory<R> - Class in net.secodo.jcircuitbreaker.breakhandler.impl
An implementation of BreakHandlerFactory which creates new instance of given BreakHandler class for each invocation of SimpleHandlerFactory.makeHandler(Task, ExecutionContext) .
SimpleHandlerFactory(Class<? extends BreakHandler<R>>) - Constructor for class net.secodo.jcircuitbreaker.breakhandler.impl.SimpleHandlerFactory
 
SimpleStrategyDsl - Class in net.secodo.jcircuitbreaker.breakstrategy
Contains methods (which may be accessed statically) for chaining multiple breaker strategies into single break strategy using "and","or" expressions.
SimpleStrategyDsl() - Constructor for class net.secodo.jcircuitbreaker.breakstrategy.SimpleStrategyDsl
 
SingleExecutionAllowedStrategy<R> - Class in net.secodo.jcircuitbreaker.breakstrategy.impl
This implementation of BreakStrategy allows execution only if there is no other execution at the moment.
SingleExecutionAllowedStrategy() - Constructor for class net.secodo.jcircuitbreaker.breakstrategy.impl.SingleExecutionAllowedStrategy
 
StatefulRetryHandler<R> - Class in net.secodo.jcircuitbreaker.breakhandler.impl
An implementation of BreakHandler that retries to execute given Task again.
StatefulRetryHandler() - Constructor for class net.secodo.jcircuitbreaker.breakhandler.impl.StatefulRetryHandler
 
StatefulRetryHandler(int) - Constructor for class net.secodo.jcircuitbreaker.breakhandler.impl.StatefulRetryHandler
 
StatefulRetryHandler(int, RetryHandlerOnRetryCallback<R>) - Constructor for class net.secodo.jcircuitbreaker.breakhandler.impl.StatefulRetryHandler
 

T

Task<R> - Interface in net.secodo.jcircuitbreaker.task
Represents the java method that should be executed (called target-method in this context).
TaskExecutionException - Exception in net.secodo.jcircuitbreaker.exception
Thrown by CircuitBreaker when the call to real-method resulted in exception.
TaskExecutionException(String, Throwable) - Constructor for exception net.secodo.jcircuitbreaker.exception.TaskExecutionException
 
TimeUtil - Class in net.secodo.jcircuitbreaker.util
 
TimeUtil() - Constructor for class net.secodo.jcircuitbreaker.util.TimeUtil
 

V

VoidTask - Interface in net.secodo.jcircuitbreaker.task
Represents the java method that should be executed (called target-method in this context) which does not return value.

W

withBreakHandler(BreakHandler<R>) - Method in class net.secodo.jcircuitbreaker.breaker.builder.impl.ReusableCircuitBreakerBuilder
 
withBreakStrategy(BreakStrategy<R>) - Method in class net.secodo.jcircuitbreaker.breaker.builder.impl.ReusableCircuitBreakerBuilder
 
A B C D E G H I L M N O P R S T V W 
Skip navigation links

Copyright © 2017. All rights reserved.