org.testcontainers

Class DockerClientFactory

java.lang.Object

org.testcontainers.DockerClientFactory

public class DockerClientFactory
extends Object

Singleton class that provides initialized Docker clients.

The correct client configuration to use will be determined on first use, and cached thereafter.

Method Summary

Modifier and Type	Method and Description
com.github.dockerjava.api.DockerClient	client()
String	dockerHostIpAddress()
String	getActiveApiVersion()
String	getActiveExecutionDriver()
static DockerClientFactory	instance() Obtain an instance of the DockerClientFactory.
boolean	isUsing(Class<? extends DockerClientProviderStrategy> providerStrategyClass)
<T> T	runInsideDocker(Consumer<com.github.dockerjava.api.command.CreateContainerCmd> createContainerCmdConsumer, BiFunction<com.github.dockerjava.api.DockerClient,String,T> block)

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static DockerClientFactory instance()

Obtain an instance of the DockerClientFactory.

Returns:

the singleton instance of DockerClientFactory

client

public com.github.dockerjava.api.DockerClient client()

Returns:

a new initialized Docker client

dockerHostIpAddress

public String dockerHostIpAddress()

Returns:

the IP address of the host running Docker

runInsideDocker

public <T> T runInsideDocker(Consumer<com.github.dockerjava.api.command.CreateContainerCmd> createContainerCmdConsumer,
                             BiFunction<com.github.dockerjava.api.DockerClient,String,T> block)

getActiveApiVersion

public String getActiveApiVersion()

Returns:

the docker API version of the daemon that we have connected to

getActiveExecutionDriver

public String getActiveExecutionDriver()

Returns:

the docker execution driver of the daemon that we have connected to

isUsing

public boolean isUsing(Class<? extends DockerClientProviderStrategy> providerStrategyClass)

Parameters:

providerStrategyClass - a class that extends DockerMachineClientProviderStrategy

Returns:

whether or not the currently active strategy is of the provided type