AbstractProbe 8.0.0 API

All Implemented Interfaces:: com.intershop.gradle.icm.utils.Probe


public abstract class AbstractProbe
 implements Probe

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Duration`	`retryInterval`
`private Duration`	`retryTimeout`

Constructor Summary

Constructors
Constructor	Description
`AbstractProbe(Function0<ServiceRegistry> serviceRegistrySupplier)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Duration`	`getRetryInterval()`
`final Unit`	`setRetryInterval(Duration value)`
`final Duration`	`getRetryTimeout()`
`final Unit`	`setRetryTimeout(Duration value)`
`Probe`	`onSuccess(Function1<Unit, Unit> onSuccess)`	Assigns a callback that is executed when this Probe finishes with a success.
`Probe`	`onFailure(Function1<Unit, Unit> onFailure)`	Assigns a callback that is executed when this Probe finishes with a failure.
`Boolean`	`execute()`	Executes this probe
`Probe`	`withRetryInterval(Duration interval)`	Sets the retry interval
`Probe`	`withRetryTimeout(Duration timeout)`	Sets the retry timeout

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractProbe
```
AbstractProbe(Function0<ServiceRegistry> serviceRegistrySupplier)
```
- Method Detail
  - getRetryInterval
```
 final Duration getRetryInterval()
```
  - setRetryInterval
```
 final Unit setRetryInterval(Duration value)
```
  - getRetryTimeout
```
 final Duration getRetryTimeout()
```
  - setRetryTimeout
```
 final Unit setRetryTimeout(Duration value)
```
  - onSuccess
```
 Probe onSuccess(Function1<Unit, Unit> onSuccess)
```
    Assigns a callback that is executed when this Probe finishes with a success. The callback is not called for each internal retry attempt.
  - onFailure
```
 Probe onFailure(Function1<Unit, Unit> onFailure)
```
    Assigns a callback that is executed when this Probe finishes with a failure. The callback is not called for each internal retry attempt.
  - execute
```
 Boolean execute()
```
    Executes this probe
    
    Returns:
    
    true on success otherwise false
  - withRetryInterval
```
 Probe withRetryInterval(Duration interval)
```
    Sets the retry interval
    
    Returns:
    
    this Probe
  - withRetryTimeout
```
 Probe withRetryTimeout(Duration timeout)
```
    Sets the retry timeout
    
    Returns:
    
    this Probe