org.testcontainers.elasticsearch

Class ElasticsearchContainer

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<ElasticsearchContainer>

org.testcontainers.elasticsearch.ElasticsearchContainer

All Implemented Interfaces:

java.lang.AutoCloseable, org.junit.rules.TestRule, org.testcontainers.containers.Container<ElasticsearchContainer>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable

public class ElasticsearchContainer
extends org.testcontainers.containers.GenericContainer<ElasticsearchContainer>

Represents an elasticsearch docker instance which exposes by default port 9200 and 9300 (transport.tcp.port) The docker image is by default fetched from docker.elastic.co/elasticsearch/elasticsearch

Nested Class Summary

Nested classes/interfaces inherited from interface org.testcontainers.containers.Container

org.testcontainers.containers.Container.ExecResult

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_TAG Deprecated.
static java.lang.String	ELASTICSEARCH_DEFAULT_PASSWORD Elasticsearch Default Password for Elasticsearch >= 8

Fields inherited from class org.testcontainers.containers.GenericContainer

CONTAINER_RUNNING_TIMEOUT_SEC, dependencies, dockerClient, INTERNAL_HOST_HOSTNAME, waitStrategy

Fields inherited from interface org.testcontainers.containers.ContainerState

STATE_HEALTHY

Constructor Summary

Constructors

Constructor and Description
ElasticsearchContainer() Deprecated. use ElasticsearchContainer(DockerImageName) instead
ElasticsearchContainer(org.testcontainers.utility.DockerImageName dockerImageName) Create an Elasticsearch Container by passing the full docker image name
ElasticsearchContainer(java.lang.String dockerImageName) Create an Elasticsearch Container by passing the full docker image name

Method Summary

Modifier and Type	Method and Description
java.util.Optional<byte[]>	caCertAsBytes() If this is running above Elasticsearch 8, this will return the probably self-signed CA cert that has been extracted
protected void	containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
javax.net.ssl.SSLContext	createSslContextFromCa() A SSL context based on the self signed CA, so that using this SSL Context allows to connect to the Elasticsearch service
java.lang.String	getHttpHostAddress()
java.net.InetSocketAddress	getTcpHost() Deprecated.
ElasticsearchContainer	withCertPath(java.lang.String certPath) Configure a CA cert path that is not the default
ElasticsearchContainer	withPassword(java.lang.String password) Define the Elasticsearch password to set.

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canBeReused, configure, containerIsCreated, containerIsStarted, containerIsStarting, containerIsStarting, containerIsStopped, containerIsStopping, copyFileFromContainer, createVolumeDirectory, dependsOn, dependsOn, dependsOn, doStart, equals, failed, finished, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDependencies, getDockerClient, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLabels, getLinkedContainers, getLivenessCheckPort, getLivenessCheckPortNumbers, getLivenessCheckPorts, getLogConsumers, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getShmSize, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getTmpFsMapping, getVolumesFroms, getWaitStrategy, getWorkingDirectory, hashCode, isHostAccessible, isPrivilegedMode, isShouldBeReused, logger, setBinds, setCommand, setCommand, setCommandParts, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setHostAccessible, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, starting, stop, succeeded, toString, waitingFor, waitUntilContainerStarted, withAccessToHost, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withCopyToContainer, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withImagePullPolicy, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, withReuse, withSharedMemorySize, withStartupAttempts, withStartupCheckStrategy, withStartupTimeout, withTmpFs, withVolumesFrom, withWorkingDirectory

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.testcontainers.containers.Container

addFileSystemBind, followOutput, followOutput, self, withEnv, withFileSystemBind

Methods inherited from interface org.testcontainers.containers.ContainerState

copyFileFromContainer, copyFileToContainer, copyFileToContainer, execInContainer, execInContainer, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Field Detail

ELASTICSEARCH_DEFAULT_PASSWORD

public static final java.lang.String ELASTICSEARCH_DEFAULT_PASSWORD

Elasticsearch Default Password for Elasticsearch >= 8

See Also:

Constant Field Values

DEFAULT_TAG

@Deprecated
protected static final java.lang.String DEFAULT_TAG

Deprecated.

Elasticsearch Default version

See Also:

Constant Field Values

Constructor Detail

ElasticsearchContainer

@Deprecated
public ElasticsearchContainer()

Deprecated. use ElasticsearchContainer(DockerImageName) instead

ElasticsearchContainer

public ElasticsearchContainer(java.lang.String dockerImageName)

Create an Elasticsearch Container by passing the full docker image name

Parameters:

dockerImageName - Full docker image name as a String, like: docker.elastic.co/elasticsearch/elasticsearch:7.9.2

ElasticsearchContainer

public ElasticsearchContainer(org.testcontainers.utility.DockerImageName dockerImageName)

Create an Elasticsearch Container by passing the full docker image name

Parameters:

dockerImageName - Full docker image name as a DockerImageName, like: DockerImageName.parse("docker.elastic.co/elasticsearch/elasticsearch:7.9.2")

Method Detail

containerIsStarted

protected void containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)

Overrides:

containerIsStarted in class org.testcontainers.containers.GenericContainer<ElasticsearchContainer>

caCertAsBytes

public java.util.Optional<byte[]> caCertAsBytes()

If this is running above Elasticsearch 8, this will return the probably self-signed CA cert that has been extracted

Returns:

byte array optional containing the CA cert extracted from the docker container

createSslContextFromCa

public javax.net.ssl.SSLContext createSslContextFromCa()

A SSL context based on the self signed CA, so that using this SSL Context allows to connect to the Elasticsearch service

Returns:

a customized SSL Context

withPassword

public ElasticsearchContainer withPassword(java.lang.String password)

Define the Elasticsearch password to set. It enables security behind the scene for major version below 8.0.0. It's not possible to use security with the oss image.

Parameters:

password - Password to set

Returns:

this

withCertPath

public ElasticsearchContainer withCertPath(java.lang.String certPath)

Configure a CA cert path that is not the default

Parameters:

certPath - Path to the CA certificate within the Docker container to extract it from after start up

Returns:

this

getHttpHostAddress

public java.lang.String getHttpHostAddress()

getTcpHost

@Deprecated
public java.net.InetSocketAddress getTcpHost()

Deprecated.