org.testcontainers.dockerclient

Class DockerClientProviderStrategy

java.lang.Object

org.testcontainers.dockerclient.DockerClientProviderStrategy

Direct Known Subclasses:

DockerMachineClientProviderStrategy, EnvironmentAndSystemPropertyClientProviderStrategy, NpipeSocketClientProviderStrategy, UnixSocketClientProviderStrategy, WindowsClientProviderStrategy

public abstract class DockerClientProviderStrategy
extends java.lang.Object

Mechanism to find a viable Docker client configuration according to the host system environment.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.github.dockerjava.api.DockerClient	client
protected com.github.dockerjava.core.DockerClientConfig	config
protected static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
DockerClientProviderStrategy()

Method Summary

Modifier and Type	Method and Description
protected void	checkOSType()
com.github.dockerjava.api.DockerClient	getClient()
protected com.github.dockerjava.api.DockerClient	getClientForConfig(com.github.dockerjava.core.DockerClientConfig config)
abstract java.lang.String	getDescription()
java.lang.String	getDockerHostIpAddress()
static DockerClientProviderStrategy	getFirstValidStrategy(java.util.List<DockerClientProviderStrategy> strategies) Determine the right DockerClientConfig to use for building clients by trial-and-error.
protected int	getPriority()
protected boolean	isApplicable()
protected boolean	isPersistable()
protected void	ping(com.github.dockerjava.api.DockerClient client, int timeoutInSeconds)
abstract void	test()

Methods inherited from class java.lang.Object

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

Field Detail

client

protected com.github.dockerjava.api.DockerClient client

config

protected com.github.dockerjava.core.DockerClientConfig config

LOGGER

protected static final org.slf4j.Logger LOGGER

Constructor Detail

DockerClientProviderStrategy

public DockerClientProviderStrategy()

Method Detail

test

public abstract void test()
                   throws InvalidConfigurationException

Throws:

InvalidConfigurationException - if this strategy fails

getDescription

public abstract java.lang.String getDescription()

Returns:

a short textual description of the strategy

isApplicable

protected boolean isApplicable()

isPersistable

protected boolean isPersistable()

getPriority

protected int getPriority()

Returns:

highest to lowest priority value

getFirstValidStrategy

public static DockerClientProviderStrategy getFirstValidStrategy(java.util.List<DockerClientProviderStrategy> strategies)

Determine the right DockerClientConfig to use for building clients by trial-and-error.

Returns:

a working DockerClientConfig, as determined by successful execution of a ping command

getClient

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

Returns:

a usable, tested, Docker client configuration for the host system environment

getClientForConfig

protected com.github.dockerjava.api.DockerClient getClientForConfig(com.github.dockerjava.core.DockerClientConfig config)

ping

protected void ping(com.github.dockerjava.api.DockerClient client,
                    int timeoutInSeconds)

getDockerHostIpAddress

public java.lang.String getDockerHostIpAddress()

checkOSType

protected void checkOSType()