org.testcontainers.containers.wait.strategy

Class AbstractWaitStrategy

java.lang.Object

org.testcontainers.containers.wait.strategy.AbstractWaitStrategy

All Implemented Interfaces:

WaitStrategy

Direct Known Subclasses:

DockerHealthcheckWaitStrategy, HostPortWaitStrategy, HttpWaitStrategy, LogMessageWaitStrategy

public abstract class AbstractWaitStrategy
extends java.lang.Object
implements WaitStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected @NonNull java.time.Duration	startupTimeout
protected WaitStrategyTarget	waitStrategyTarget

Constructor Summary

Constructors

Constructor and Description
AbstractWaitStrategy()

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<java.lang.Integer>	getLivenessCheckPorts()
protected org.rnorth.ducttape.ratelimits.RateLimiter	getRateLimiter()
protected abstract void	waitUntilReady() Wait until waitStrategyTarget has started.
void	waitUntilReady(WaitStrategyTarget waitStrategyTarget) Wait until the target has started.
WaitStrategy	withRateLimiter(org.rnorth.ducttape.ratelimits.RateLimiter rateLimiter) Set the rate limiter being used
WaitStrategy	withStartupTimeout(java.time.Duration startupTimeout) Set the duration of waiting time until container treated as started.

Methods inherited from class java.lang.Object

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

Field Detail

waitStrategyTarget

protected WaitStrategyTarget waitStrategyTarget

startupTimeout

@NonNull
protected @NonNull java.time.Duration startupTimeout

Constructor Detail

AbstractWaitStrategy

public AbstractWaitStrategy()

Method Detail

waitUntilReady

public void waitUntilReady(WaitStrategyTarget waitStrategyTarget)

Wait until the target has started.

Specified by:

waitUntilReady in interface WaitStrategy

Parameters:

waitStrategyTarget - the target of the WaitStrategy

waitUntilReady

protected abstract void waitUntilReady()

Wait until waitStrategyTarget has started.

withStartupTimeout

public WaitStrategy withStartupTimeout(java.time.Duration startupTimeout)

Set the duration of waiting time until container treated as started.

Specified by:

withStartupTimeout in interface WaitStrategy

Parameters:

startupTimeout - timeout

Returns:

this

See Also:

WaitStrategy.waitUntilReady(WaitStrategyTarget)

getLivenessCheckPorts

protected java.util.Set<java.lang.Integer> getLivenessCheckPorts()

Returns:

the ports on which to check if the container is ready

getRateLimiter

protected org.rnorth.ducttape.ratelimits.RateLimiter getRateLimiter()

Returns:

the rate limiter to use

withRateLimiter

public WaitStrategy withRateLimiter(org.rnorth.ducttape.ratelimits.RateLimiter rateLimiter)

Set the rate limiter being used

Parameters:

rateLimiter - rateLimiter

Returns:

this