Deprecated API

Contents

• Interfaces
• Classes
• Methods
• Constructors

Deprecated Interfaces

Interface	Description
org.testcontainers.containers.traits.LinkableContainer	Links are deprecated (see #465). Please use Network features instead.

Deprecated Classes

Class	Description
org.testcontainers.dockerclient.DockerDesktopClientProviderStrategy	this class is used by the SPI and should not be used directly
org.testcontainers.dockerclient.DockerMachineClientProviderStrategy	this class is used by the SPI and should not be used directly
org.testcontainers.dockerclient.EnvironmentAndSystemPropertyClientProviderStrategy	this class is used by the SPI and should not be used directly
org.testcontainers.dockerclient.LogToStringContainerCallback	use ResultCallback.Adapter
org.testcontainers.dockerclient.NpipeSocketClientProviderStrategy	this class is used by the SPI and should not be used directly
org.testcontainers.dockerclient.RootlessDockerClientProviderStrategy	this class is used by the SPI and should not be used directly
org.testcontainers.dockerclient.TestcontainersHostPropertyClientProviderStrategy	this class is used by the SPI and should not be used directly
org.testcontainers.dockerclient.UnixSocketClientProviderStrategy	this class is used by the SPI and should not be used directly
org.testcontainers.utility.DynamicPollInterval	For internal usage only.

Deprecated Methods

Method	Description
org.testcontainers.containers.Container.addFileSystemBind(String, String, BindMode)	use GenericContainer.withCopyToContainer(Transferable, String)
org.testcontainers.containers.Container.addFileSystemBind(String, String, BindMode, SelinuxContext)	use GenericContainer.withCopyToContainer(Transferable, String)
org.testcontainers.containers.Container.addLink(LinkableContainer, String)	Links are deprecated (see #465). Please use Network features instead.
org.testcontainers.containers.Container.getEnv()	use getEnvMap
org.testcontainers.containers.Container.getLinkedContainers()	Links are deprecated (see #465). Please use Network features instead.
org.testcontainers.containers.Container.getTestHostIpAddress()	use Testcontainers.exposeHostPorts(int...)
org.testcontainers.containers.Container.setLinkedContainers(Map<String, LinkableContainer>)	Links are deprecated (see #465). Please use Network features instead.
org.testcontainers.containers.Container.withClasspathResourceMapping(String, String, BindMode)	use GenericContainer.withCopyToContainer(Transferable, String)
org.testcontainers.containers.Container.withClasspathResourceMapping(String, String, BindMode, SelinuxContext)	use GenericContainer.withCopyToContainer(Transferable, String)
org.testcontainers.containers.Container.withCopyFileToContainer(MountableFile, String)	Use Container.withCopyToContainer(Transferable, String) instead
org.testcontainers.containers.Container.withFileSystemBind(String, String)	use GenericContainer.withCopyToContainer(Transferable, String)
org.testcontainers.containers.Container.withFileSystemBind(String, String, BindMode)	use GenericContainer.withCopyToContainer(Transferable, String)
org.testcontainers.containers.ContainerState.execInContainerWithUser(String, String...)	use ContainerState.execInContainer(ExecConfig)
org.testcontainers.containers.ContainerState.execInContainerWithUser(Charset, String, String...)	use ContainerState.execInContainer(Charset, ExecConfig)
org.testcontainers.containers.ContainerState.getContainerIpAddress()	use ContainerState.getHost()
org.testcontainers.containers.ExecInContainerPattern.execInContainer(InspectContainerResponse, String...)	use ExecInContainerPattern.execInContainer(DockerClient, InspectContainerResponse, String...)
org.testcontainers.containers.ExecInContainerPattern.execInContainer(InspectContainerResponse, Charset, String...)	use ExecInContainerPattern.execInContainer(DockerClient, InspectContainerResponse, Charset, String...)
org.testcontainers.containers.ExecInContainerPattern.execInContainerWithUser(DockerClient, InspectContainerResponse, String, String...)	use ExecInContainerPattern.execInContainer(DockerClient, InspectContainerResponse, ExecConfig)
org.testcontainers.containers.ExecInContainerPattern.execInContainerWithUser(DockerClient, InspectContainerResponse, Charset, String, String...)	use ExecInContainerPattern.execInContainer(DockerClient, InspectContainerResponse, Charset, ExecConfig)
org.testcontainers.containers.GenericContainer.addLink(LinkableContainer, String)	Links are deprecated (see #465). Please use Network features instead.
org.testcontainers.containers.GenericContainer.createVolumeDirectory(boolean)
org.testcontainers.containers.GenericContainer.getCopyToFileContainerPathMap()
org.testcontainers.containers.GenericContainer.getIpAddress()	please use getContainerIpAddress() instead
org.testcontainers.containers.GenericContainer.getLinkedContainers()	Links are deprecated (see #465). Please use Network features instead.
org.testcontainers.containers.GenericContainer.getLivenessCheckPort()	see GenericContainer.getLivenessCheckPorts() for replacement
org.testcontainers.containers.GenericContainer.getLivenessCheckPorts()	use GenericContainer.getLivenessCheckPortNumbers() instead
org.testcontainers.containers.GenericContainer.getTestHostIpAddress()
org.testcontainers.containers.GenericContainer.setCopyToFileContainerPathMap(Map<MountableFile, String>)
org.testcontainers.containers.GenericContainer.setLinkedContainers(Map<String, LinkableContainer>)	Links are deprecated (see #465). Please use Network features instead.
org.testcontainers.containers.Network.NetworkImpl.NetworkImplBuilder.id(String)
org.testcontainers.containers.startupcheck.StartupCheckStrategy.waitUntilStartupSuccessful(GenericContainer<?>)	internal API
org.testcontainers.dockerclient.DockerClientConfigUtils.getDockerHostIpAddress(URI)	use DockerClientProviderStrategy.getDockerHostIpAddress()
org.testcontainers.dockerclient.DockerClientProviderStrategy.getClient()	use DockerClientProviderStrategy.getDockerClient()
org.testcontainers.DockerClientFactory.checkAndPullImage(DockerClient, String)	use RemoteDockerImage
org.testcontainers.images.builder.ImageFromDockerfile.withDockerfilePath(String)	It is recommended to use ImageFromDockerfile.withDockerfile(java.nio.file.Path) instead because it honors .dockerignore files and will therefore be more efficient. Additionally, using ImageFromDockerfile.withDockerfile(java.nio.file.Path) supports Dockerfiles that depend upon images from authenticated private registries.
org.testcontainers.utility.DockerMachineClient.getDockerDaemonIpAddress(String)	Use getDockerDaemonUrl(@NonNull String machineName) for connection to docker-machine
org.testcontainers.utility.ResourceReaper.getLabels()	internal API
org.testcontainers.utility.ResourceReaper.init()	internal API
org.testcontainers.utility.ResourceReaper.performCleanup()	no longer supported API, use DockerClient directly
org.testcontainers.utility.ResourceReaper.register(GenericContainer<?>, CreateContainerCmd)	internal API
org.testcontainers.utility.ResourceReaper.registerContainerForCleanup(String, String)	no longer supported API
org.testcontainers.utility.ResourceReaper.registerFilterForCleanup(List<Map.Entry<String, String>>)	only label filter is supported by the prune API, use ResourceReaper.registerLabelsFilterForCleanup(Map)
org.testcontainers.utility.ResourceReaper.registerImageForCleanup(String)	no longer supported API
org.testcontainers.utility.ResourceReaper.registerNetworkIdForCleanup(String)	no longer supported API
org.testcontainers.utility.ResourceReaper.removeNetworkById(String)	use DockerClient directly
org.testcontainers.utility.ResourceReaper.stopAndRemoveContainer(String)	use DockerClient directly
org.testcontainers.utility.ResourceReaper.stopAndRemoveContainer(String, String)	use DockerClient directly
org.testcontainers.utility.ResourceReaper.unregisterContainer(String)	no longer supported API
org.testcontainers.utility.ResourceReaper.unregisterNetwork(String)	no longer supported API
org.testcontainers.utility.TestcontainersConfiguration.getAmbassadorContainerImage()
org.testcontainers.utility.TestcontainersConfiguration.getDockerComposeContainerImage()
org.testcontainers.utility.TestcontainersConfiguration.getKafkaImage()
org.testcontainers.utility.TestcontainersConfiguration.getLocalStackImage()
org.testcontainers.utility.TestcontainersConfiguration.getOracleImage()
org.testcontainers.utility.TestcontainersConfiguration.getProperties()	usages should be removed ASAP. See TestcontainersConfiguration.getEnvVarOrProperty(String, String), TestcontainersConfiguration.getEnvVarOrUserProperty(String, String) or TestcontainersConfiguration.getUserProperty(String, String) for suitable replacements.
org.testcontainers.utility.TestcontainersConfiguration.getPulsarImage()
org.testcontainers.utility.TestcontainersConfiguration.getRyukImage()
org.testcontainers.utility.TestcontainersConfiguration.getSocatContainerImage()
org.testcontainers.utility.TestcontainersConfiguration.getSSHdImage()
org.testcontainers.utility.TestcontainersConfiguration.getTinyImage()
org.testcontainers.utility.TestcontainersConfiguration.getVncRecordedContainerImage()
org.testcontainers.utility.TestcontainersConfiguration.updateGlobalConfig(String, String)

Deprecated Constructors

Constructor	Description
org.testcontainers.containers.DockerComposeContainer(List<File>)
org.testcontainers.containers.FixedHostPortGenericContainer(String)	it is highly recommended that FixedHostPortGenericContainer not be used, as it risks port conflicts.
org.testcontainers.containers.GenericContainer()	use GenericContainer(DockerImageName) instead
org.testcontainers.images.RemoteDockerImage(String, String)
org.testcontainers.images.RemoteDockerImage(String)
org.testcontainers.utility.DockerImageName(String)	use DockerImageName.parse(String) instead
org.testcontainers.utility.DockerImageName(String, String)	use DockerImageName.parse(String).DockerImageName.withTag(String) instead