Package io.axoniq.framework.workflow.dsl.api.retry

Record Class RetryContext

java.lang.Object

java.lang.Record

io.axoniq.framework.workflow.dsl.api.retry.RetryContext

Record Components:

stepName - name of the step being retried.

attempt - current retry attempt number (1-based).

maxRetries - maximum number of retries configured.

error - the error that triggered the retry.

delay - the computed backoff delay before this retry attempt.

public record RetryContext(String stepName, int attempt, int maxRetries, Throwable error, Duration delay)
extends Record

Context passed to a RetryHandler on each retry attempt.

Since:

5.4.0

Author:

Stefan Dragisic

Constructor Summary

Constructors

Constructor	Description
RetryContext(String stepName, int attempt, int maxRetries, Throwable error)	Creates a retry context with no backoff delay.
RetryContext(String stepName, int attempt, int maxRetries, Throwable error, Duration delay)	Creates an instance of a RetryContext record class.

Method Summary

Modifier and Type	Method	Description
int	attempt()	Returns the value of the attempt record component.
Duration	delay()	Returns the value of the delay record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Throwable	error()	Returns the value of the error record component.
final int	hashCode()	Returns a hash code value for this object.
int	maxRetries()	Returns the value of the maxRetries record component.
String	stepName()	Returns the value of the stepName record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RetryContext

public RetryContext(String stepName,
 int attempt,
 int maxRetries,
 Throwable error)

Creates a retry context with no backoff delay.

Parameters:

stepName - name of the step being retried

attempt - current retry attempt number (1-based)

maxRetries - maximum number of configured retries

error - error that triggered the retry

RetryContext

public RetryContext(String stepName,
 int attempt,
 int maxRetries,
 Throwable error,
 Duration delay)

Creates an instance of a RetryContext record class.

Parameters:

stepName - the value for the stepName record component

attempt - the value for the attempt record component

maxRetries - the value for the maxRetries record component

error - the value for the error record component

delay - the value for the delay record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

stepName

public String stepName()

Returns the value of the stepName record component.

Returns:

the value of the stepName record component

attempt

public int attempt()

Returns the value of the attempt record component.

Returns:

the value of the attempt record component

maxRetries

public int maxRetries()

Returns the value of the maxRetries record component.

Returns:

the value of the maxRetries record component

error

public Throwable error()

Returns the value of the error record component.

Returns:

the value of the error record component

delay

public Duration delay()

Returns the value of the delay record component.

Returns:

the value of the delay record component