org.testcontainers.containers.wait.strategy

Class HttpWaitStrategy

java.lang.Object

org.testcontainers.containers.wait.strategy.AbstractWaitStrategy

org.testcontainers.containers.wait.strategy.HttpWaitStrategy

All Implemented Interfaces:

WaitStrategy

public class HttpWaitStrategy
extends AbstractWaitStrategy

Field Summary

Fields inherited from class org.testcontainers.containers.wait.strategy.AbstractWaitStrategy

startupTimeout, waitStrategyTarget

Constructor Summary

Constructors

Constructor and Description
HttpWaitStrategy()

Method Summary

Modifier and Type	Method and Description
HttpWaitStrategy	allowInsecure() Indicates that HTTPS connection could use untrusted (self signed) certificate chains.
HttpWaitStrategy	forPath(java.lang.String path) Waits for the given path.
HttpWaitStrategy	forPort(int port) Wait for the given port.
HttpWaitStrategy	forResponsePredicate(java.util.function.Predicate<java.lang.String> responsePredicate) Waits for the response to pass the given predicate
HttpWaitStrategy	forStatusCode(int statusCode) Waits for the given status code.
HttpWaitStrategy	forStatusCodeMatching(java.util.function.Predicate<java.lang.Integer> statusCodePredicate) Waits for the status code to pass the given predicate
HttpWaitStrategy	usingTls() Indicates that the status check should use HTTPS.
protected void	waitUntilReady() Wait until AbstractWaitStrategy.waitStrategyTarget has started.
HttpWaitStrategy	withBasicCredentials(java.lang.String username, java.lang.String password) Authenticate with HTTP Basic Authorization credentials.
HttpWaitStrategy	withHeader(java.lang.String name, java.lang.String value) Add a custom HTTP Header to the call.
HttpWaitStrategy	withHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Add multiple custom HTTP Headers to the call.
HttpWaitStrategy	withMethod(java.lang.String method) Indicates the HTTP method to use (GET by default).
HttpWaitStrategy	withReadTimeout(java.time.Duration timeout) Set the HTTP connections read timeout.

Methods inherited from class org.testcontainers.containers.wait.strategy.AbstractWaitStrategy

getLivenessCheckPorts, getRateLimiter, waitUntilReady, withRateLimiter, 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

forStatusCodeMatching

public HttpWaitStrategy forStatusCodeMatching(java.util.function.Predicate<java.lang.Integer> statusCodePredicate)

Waits for the status code to pass the given predicate

Parameters:

statusCodePredicate - The predicate to test the response against

Returns:

this

forPath

public HttpWaitStrategy forPath(java.lang.String path)

Waits for the given path.

Parameters:

path - the path to check

Returns:

this

forPort

public HttpWaitStrategy forPort(int port)

Wait for the given port.

Parameters:

port - the given port

Returns:

this

usingTls

public HttpWaitStrategy usingTls()

Indicates that the status check should use HTTPS.

Returns:

this

withMethod

public HttpWaitStrategy withMethod(java.lang.String method)

Indicates the HTTP method to use (GET by default).

Parameters:

method - the HTTP method.

Returns:

this

allowInsecure

public HttpWaitStrategy allowInsecure()

Indicates that HTTPS connection could use untrusted (self signed) certificate chains.

Returns:

this

withBasicCredentials

public HttpWaitStrategy withBasicCredentials(java.lang.String username,
                                             java.lang.String password)

Authenticate with HTTP Basic Authorization credentials.

Parameters:

username - the username

password - the password

Returns:

this

withHeader

public HttpWaitStrategy withHeader(java.lang.String name,
                                   java.lang.String value)

Add a custom HTTP Header to the call.

Parameters:

name - The HTTP Header name

value - The HTTP Header value

Returns:

this

withHeaders

public HttpWaitStrategy withHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Add multiple custom HTTP Headers to the call.

Parameters:

headers - Headers map of name/value

Returns:

this

withReadTimeout

public HttpWaitStrategy withReadTimeout(java.time.Duration timeout)

Set the HTTP connections read timeout.

Parameters:

timeout - the timeout (minimum 1 millisecond)

Returns:

this

forResponsePredicate

public HttpWaitStrategy forResponsePredicate(java.util.function.Predicate<java.lang.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: AbstractWaitStrategy

Wait until AbstractWaitStrategy.waitStrategyTarget has started.

Specified by:

waitUntilReady in class AbstractWaitStrategy