org.testcontainers.containers.wait.strategy

Class Wait

java.lang.Object

org.testcontainers.containers.wait.strategy.Wait

public class Wait
extends java.lang.Object

Convenience class with logic for building common WaitStrategy instances.

Constructor Summary

Constructors

Constructor and Description
Wait()

Method Summary

Modifier and Type	Method and Description
static WaitStrategy	defaultWaitStrategy() Convenience method to return the default WaitStrategy.
static DockerHealthcheckWaitStrategy	forHealthcheck() Convenience method to return a WaitStrategy leveraging Docker's built-in healthcheck.
static HttpWaitStrategy	forHttp(java.lang.String path) Convenience method to return a WaitStrategy for an HTTP endpoint.
static HttpWaitStrategy	forHttps(java.lang.String path) Convenience method to return a WaitStrategy for an HTTPS endpoint.
static HostPortWaitStrategy	forListeningPort() Convenience method to return a WaitStrategy for an exposed or mapped port.
static LogMessageWaitStrategy	forLogMessage(java.lang.String regex, int times) Convenience method to return a WaitStrategy for log messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

Wait

public Wait()

Method Detail

defaultWaitStrategy

public static WaitStrategy defaultWaitStrategy()

Convenience method to return the default WaitStrategy.

Returns:

a WaitStrategy

forListeningPort

public static HostPortWaitStrategy forListeningPort()

Convenience method to return a WaitStrategy for an exposed or mapped port.

Returns:

the WaitStrategy

See Also:

HostPortWaitStrategy

forHttp

public static HttpWaitStrategy forHttp(java.lang.String path)

Convenience method to return a WaitStrategy for an HTTP endpoint.

Parameters:

path - the path to check

Returns:

the WaitStrategy

See Also:

HttpWaitStrategy

forHttps

public static HttpWaitStrategy forHttps(java.lang.String path)

Convenience method to return a WaitStrategy for an HTTPS endpoint.

Parameters:

path - the path to check

Returns:

the WaitStrategy

See Also:

HttpWaitStrategy

forLogMessage

public static LogMessageWaitStrategy forLogMessage(java.lang.String regex,
                                                   int times)

Convenience method to return a WaitStrategy for log messages.

Parameters:

regex - the regex pattern to check for

times - the number of times the pattern is expected

Returns:

LogMessageWaitStrategy

forHealthcheck

public static DockerHealthcheckWaitStrategy forHealthcheck()

Convenience method to return a WaitStrategy leveraging Docker's built-in healthcheck.

Returns:

DockerHealthcheckWaitStrategy