com.github.ydespreaux.testcontainers.kafka.containers

Class KafkaContainer

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<SELF>

org.testcontainers.containers.FixedHostPortGenericContainer<KafkaContainer>

com.github.ydespreaux.testcontainers.kafka.containers.KafkaContainer

All Implemented Interfaces:

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

public class KafkaContainer
extends org.testcontainers.containers.FixedHostPortGenericContainer<KafkaContainer>
implements IContainer<KafkaContainer>

Kafka container.

Since:

1.0.0

Author:

Yoann Despréaux

Nested Class Summary

Nested classes/interfaces inherited from class org.testcontainers.containers.GenericContainer

org.testcontainers.containers.GenericContainer.AbstractWaitStrategy

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

org.testcontainers.containers.Container.ExecResult

Field Summary

Fields inherited from class org.testcontainers.containers.GenericContainer

CONTAINER_RUNNING_TIMEOUT_SEC, containerId, containerName, dockerClient, dockerDaemonInfo, INTERNAL_HOST_HOSTNAME, waitStrategy

Fields inherited from interface org.testcontainers.containers.ContainerState

STATE_HEALTHY

Constructor Summary

Constructors

Constructor and Description
KafkaContainer(String version)
KafkaContainer(String version, int brokersMappingPort)

Method Summary

Modifier and Type	Method and Description
protected void	configure() Configure the container.
boolean	equals(Object o)
String	getInternalURL() Get the local url.
String	getLocalURL() Deprecated. use getInternalURL()
String	getURL() Get the url.
int	hashCode()
boolean	isSecured()
protected void	registerKafkaEnvironment() Register spring boot properties.
boolean	registerSpringbootProperties()
void	start() start the container.
KafkaContainer	withAcls(List<AclsAddCmd> commands)
KafkaContainer	withBrokerServersSystemProperty(String brokerServersSystemProperty)
KafkaContainer	withFormatMessageVersion(String version) Set of the message compatibility version.
KafkaContainer	withIdentificationAlgorithmSystemProperty(String identificationAlgorithmSystemProperty)
KafkaContainer	withKafkaClientCertificates(Certificates certificates)
KafkaContainer	withKafkaServerCertificates(Certificates certificates)
KafkaContainer	withKeyPasswordSystemProperty(String keyPasswordSystemProperty)
KafkaContainer	withKeystoreLocationSystemProperty(String keystoreLocationSystemProperty)
KafkaContainer	withKeystorePasswordSystemProperty(String keystorePasswordSystemProperty)
KafkaContainer	withRegisterSpringbootProperties(boolean registerProperties)
KafkaContainer	withSecurityProtocolSystemProperty(String securityProtocolSystemProperty)
KafkaContainer	withTopics(List<TopicConfiguration> topics)
KafkaContainer	withTruststoreLocationSystemProperty(String truststoreLocationSystemProperty)
KafkaContainer	withTruststorePasswordSystemProperty(String truststorePasswordSystemProperty)
KafkaContainer	withZookeeperHostname(String zookeeperHostname)
KafkaContainer	withZookeeperPort(Integer port) Set the zookeeper port.

Methods inherited from class org.testcontainers.containers.FixedHostPortGenericContainer

withFixedExposedPort, withFixedExposedPort

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canEqual, containerIsCreated, containerIsStarted, containerIsStarting, copyFileFromContainer, copyFileFromContainer, copyFileToContainer, copyFileToContainer, createVolumeDirectory, doStart, execInContainer, execInContainer, failed, fetchDockerDaemonInfo, finished, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDockerClient, getDockerDaemonInfo, 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, isPrivilegedMode, logger, setBinds, setCommand, setCommand, setCommandParts, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, starting, stop, succeeded, toString, waitingFor, waitUntilContainerStarted, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, 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

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFileSystemBind, addLink, copyFileFromContainer, copyFileFromContainer, copyFileToContainer, copyFileToContainer, execInContainer, execInContainer, fetchDockerDaemonInfo, followOutput, followOutput, getBinds, getCommandParts, getDockerClient, getDockerDaemonInfo, getDockerImageName, getEnv, getEnvMap, getExtraHosts, getImage, getLinkedContainers, getPortBindings, getTestHostIpAddress, self, setBinds, setCommand, setCommand, setCommandParts, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setImage, setLinkedContainers, setPortBindings, setWaitStrategy, waitingFor, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withEnv, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withFileSystemBind, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, withStartupCheckStrategy, withStartupTimeout, withVolumesFrom, withWorkingDirectory

Methods inherited from interface org.testcontainers.containers.traits.LinkableContainer

getContainerName

Methods inherited from interface org.testcontainers.containers.ContainerState

getBoundPortNumbers, getContainerId, getContainerInfo, getContainerIpAddress, getCurrentContainerInfo, getExposedPorts, getFirstMappedPort, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Constructor Detail

KafkaContainer

public KafkaContainer(String version)

Parameters:

version -

KafkaContainer

public KafkaContainer(String version,
                      int brokersMappingPort)

Parameters:

version -

brokersMappingPort -

Method Detail

configure

protected void configure()

Configure the container.

Overrides:

configure in class org.testcontainers.containers.GenericContainer<KafkaContainer>

isSecured

public boolean isSecured()

getURL

public String getURL()

Get the url.

Specified by:

getURL in interface IContainer<KafkaContainer>

Returns:

getInternalURL

public String getInternalURL()

Get the local url.

Specified by:

getInternalURL in interface IContainer<KafkaContainer>

Returns:

start

public void start()

start the container.

Specified by:

start in interface org.testcontainers.lifecycle.Startable

Overrides:

start in class org.testcontainers.containers.GenericContainer<KafkaContainer>

withZookeeperPort

public KafkaContainer withZookeeperPort(Integer port)

Set the zookeeper port.

Parameters:

port -

Returns:

withFormatMessageVersion

public KafkaContainer withFormatMessageVersion(String version)

Set of the message compatibility version.

Parameters:

version -

Returns:

withZookeeperHostname

public KafkaContainer withZookeeperHostname(String zookeeperHostname)

Parameters:

zookeeperHostname -

Returns:

withBrokerServersSystemProperty

public KafkaContainer withBrokerServersSystemProperty(String brokerServersSystemProperty)

Parameters:

brokerServersSystemProperty -

Returns:

withSecurityProtocolSystemProperty

public KafkaContainer withSecurityProtocolSystemProperty(String securityProtocolSystemProperty)

withKeyPasswordSystemProperty

public KafkaContainer withKeyPasswordSystemProperty(String keyPasswordSystemProperty)

withKeystoreLocationSystemProperty

public KafkaContainer withKeystoreLocationSystemProperty(String keystoreLocationSystemProperty)

withKeystorePasswordSystemProperty

public KafkaContainer withKeystorePasswordSystemProperty(String keystorePasswordSystemProperty)

withTruststoreLocationSystemProperty

public KafkaContainer withTruststoreLocationSystemProperty(String truststoreLocationSystemProperty)

withTruststorePasswordSystemProperty

public KafkaContainer withTruststorePasswordSystemProperty(String truststorePasswordSystemProperty)

withIdentificationAlgorithmSystemProperty

public KafkaContainer withIdentificationAlgorithmSystemProperty(String identificationAlgorithmSystemProperty)

withRegisterSpringbootProperties

public KafkaContainer withRegisterSpringbootProperties(boolean registerProperties)

Specified by:

withRegisterSpringbootProperties in interface IContainer<KafkaContainer>

Parameters:

registerProperties -

Returns:

registerSpringbootProperties

public boolean registerSpringbootProperties()

Specified by:

registerSpringbootProperties in interface IContainer<KafkaContainer>

Returns:

getLocalURL

@Deprecated
public String getLocalURL()

Deprecated. use getInternalURL()

Returns:

registerKafkaEnvironment

protected void registerKafkaEnvironment()

Register spring boot properties.

withKafkaServerCertificates

public KafkaContainer withKafkaServerCertificates(Certificates certificates)

Parameters:

certificates -

Returns:

withKafkaClientCertificates

public KafkaContainer withKafkaClientCertificates(Certificates certificates)

Parameters:

certificates -

Returns:

withTopics

public KafkaContainer withTopics(List<TopicConfiguration> topics)

Parameters:

topics -

Returns:

withAcls

public KafkaContainer withAcls(List<AclsAddCmd> commands)

equals

public boolean equals(Object o)

Overrides:

equals in class org.testcontainers.containers.GenericContainer<KafkaContainer>

hashCode

public int hashCode()

Overrides:

hashCode in class org.testcontainers.containers.GenericContainer<KafkaContainer>