Package org.ldaptive

Class AbstractRetryMetadata

java.lang.Object

org.ldaptive.AbstractRetryMetadata

All Implemented Interfaces:

RetryMetadata

Direct Known Subclasses:

ClosedRetryMetadata, InitialRetryMetadata, LdapURLRetryMetadata

public abstract class AbstractRetryMetadata
extends Object
implements RetryMetadata

Common implementation of retry metadata.

Field Summary

Fields

Modifier and Type	Field	Description
private AtomicInteger	attempts	Attempt count.
private Instant	createTime	Time at which this metadata was created.
protected Instant	failureTime	Time at which the failure occurred.
protected Instant	successTime	Time at which the last success occurred.

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractRetryMetadata()	Creates a new abstract retry metadata.
protected	AbstractRetryMetadata(Clock clock)	Creates a new abstract retry metadata.

Method Summary

Modifier and Type	Method	Description
int	getAttempts()	Number of attempts for this retry.
Instant	getCreateTime()	Returns the create time.
Instant	getFailureTime()	Returns the failure time.
Instant	getSuccessTime()	Returns the success time.
void	recordFailure(Instant time)	Records a connection failure at the given instant.
void	recordSuccess(Instant time)	Records a connection success at the given instant.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

successTime

protected Instant successTime

Time at which the last success occurred.

failureTime

protected Instant failureTime

Time at which the failure occurred.

createTime

private final Instant createTime

Time at which this metadata was created.

attempts

private final AtomicInteger attempts

Attempt count.

Constructor Detail

AbstractRetryMetadata

public AbstractRetryMetadata()

Creates a new abstract retry metadata.

AbstractRetryMetadata

protected AbstractRetryMetadata(Clock clock)

Creates a new abstract retry metadata.

Parameters:

clock - to set the create time

Method Detail

getSuccessTime

public Instant getSuccessTime()

Description copied from interface: RetryMetadata

Returns the success time.

Specified by:

getSuccessTime in interface RetryMetadata

Returns:

time that the success occurred

getFailureTime

public Instant getFailureTime()

Description copied from interface: RetryMetadata

Returns the failure time.

Specified by:

getFailureTime in interface RetryMetadata

Returns:

time that the failure occurred

getCreateTime

public Instant getCreateTime()

Description copied from interface: RetryMetadata

Returns the create time.

Specified by:

getCreateTime in interface RetryMetadata

Returns:

time that the metadata was created

getAttempts

public int getAttempts()

Description copied from interface: RetryMetadata

Number of attempts for this retry.

Specified by:

getAttempts in interface RetryMetadata

Returns:

retry attempts

recordSuccess

public void recordSuccess(Instant time)

Description copied from interface: RetryMetadata

Records a connection success at the given instant.

Specified by:

recordSuccess in interface RetryMetadata

Parameters:

time - Point in time when connection was opened.

recordFailure

public void recordFailure(Instant time)

Description copied from interface: RetryMetadata

Records a connection failure at the given instant.

Specified by:

recordFailure in interface RetryMetadata

Parameters:

time - Point in time when connection failed.

toString

public String toString()

Overrides:

toString in class Object