org.testcontainers.containers.wait

Class HttpWaitStrategy

java.lang.Object

org.testcontainers.containers.GenericContainer.AbstractWaitStrategy

org.testcontainers.containers.wait.HttpWaitStrategy

All Implemented Interfaces:

WaitStrategy

public class HttpWaitStrategy
extends GenericContainer.AbstractWaitStrategy

Waits until an HTTP(S) endpoint returns a given status code.

Author:

Pete Cornish <[email protected]>

Field Summary

Fields inherited from class org.testcontainers.containers.GenericContainer.AbstractWaitStrategy

container, startupTimeout

Constructor Summary

Constructors

Constructor and Description
HttpWaitStrategy()

Method Summary

Modifier and Type	Method and Description
HttpWaitStrategy	forPath(String path) Waits for the given path.
HttpWaitStrategy	forResponsePredicate(Predicate<String> responsePredicate) Waits for the response to pass the given predicate
HttpWaitStrategy	forStatusCode(int statusCode) Waits for the given status code.
HttpWaitStrategy	usingTls() Indicates that the status check should use HTTPS.
protected void	waitUntilReady() Wait until GenericContainer.AbstractWaitStrategy.container has started.
HttpWaitStrategy	withBasicCredentials(String username, String password) Authenticate with HTTP Basic Authorization credentials.

Methods inherited from class org.testcontainers.containers.GenericContainer.AbstractWaitStrategy

getLivenessCheckPort, getLivenessCheckPorts, getRateLimiter, logger, waitUntilReady, withStartupTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpWaitStrategy

public HttpWaitStrategy()

Method Detail

forStatusCode

public HttpWaitStrategy forStatusCode(int statusCode)

Waits for the given status code.

Parameters:

statusCode - the expected status code

Returns:

this

forPath

public HttpWaitStrategy forPath(String path)

Waits for the given path.

Parameters:

path - the path to check

Returns:

this

usingTls

public HttpWaitStrategy usingTls()

Indicates that the status check should use HTTPS.

Returns:

this

withBasicCredentials

public HttpWaitStrategy withBasicCredentials(String username,
                                             String password)

Authenticate with HTTP Basic Authorization credentials.

Parameters:

username - the username

password - the password

Returns:

this

forResponsePredicate

public HttpWaitStrategy forResponsePredicate(Predicate<String> responsePredicate)

Waits for the response to pass the given predicate

Parameters:

responsePredicate - The predicate to test the response against

Returns:

this

waitUntilReady

protected void waitUntilReady()

Description copied from class: GenericContainer.AbstractWaitStrategy

Wait until GenericContainer.AbstractWaitStrategy.container has started.

Specified by:

waitUntilReady in class GenericContainer.AbstractWaitStrategy