org.testcontainers.utility

Class ResourceReaper

java.lang.Object

org.testcontainers.utility.ResourceReaper

public final class ResourceReaper
extends Object

Component that responsible for container removal and automatic cleanup of dead containers at JVM shutdown.

Method Summary

Modifier and Type	Method and Description
static ResourceReaper	instance()
void	performCleanup() Perform a cleanup.
void	registerContainerForCleanup(String containerId, String imageName) Register a container to be cleaned up, either on explicit call to stopAndRemoveContainer, or at JVM shutdown.
void	registerNetworkForCleanup(String networkName) Deprecated. see registerNetworkIdForCleanup(String)
void	registerNetworkIdForCleanup(String id) Register a network to be cleaned up at JVM shutdown.
void	removeNetworkById(String id) Removes a network by ID.
void	removeNetworks(String identifier) Deprecated. see removeNetworkById(String)
void	stopAndRemoveContainer(String containerId) Stop a potentially running container and remove it, including associated volumes.
void	stopAndRemoveContainer(String containerId, String imageName) Stop a potentially running container and remove it, including associated volumes.
void	unregisterContainer(String identifier)
void	unregisterNetwork(String identifier)

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static ResourceReaper instance()

performCleanup

public void performCleanup()

Perform a cleanup.

registerContainerForCleanup

public void registerContainerForCleanup(String containerId,
                                        String imageName)

Register a container to be cleaned up, either on explicit call to stopAndRemoveContainer, or at JVM shutdown.

Parameters:

containerId - the ID of the container

imageName - the image name of the container (used for logging)

stopAndRemoveContainer

public void stopAndRemoveContainer(String containerId)

Stop a potentially running container and remove it, including associated volumes.

Parameters:

containerId - the ID of the container

stopAndRemoveContainer

public void stopAndRemoveContainer(String containerId,
                                   String imageName)

Stop a potentially running container and remove it, including associated volumes.

Parameters:

containerId - the ID of the container

imageName - the image name of the container (used for logging)

registerNetworkIdForCleanup

public void registerNetworkIdForCleanup(String id)

Register a network to be cleaned up at JVM shutdown.

Parameters:

id - the ID of the network

registerNetworkForCleanup

@Deprecated
public void registerNetworkForCleanup(String networkName)

Deprecated. see registerNetworkIdForCleanup(String)

Parameters:

networkName - the name of the network

removeNetworkById

public void removeNetworkById(String id)

Removes a network by ID.

Parameters:

id -

removeNetworks

@Deprecated
public void removeNetworks(String identifier)

Deprecated. see removeNetworkById(String)

Removes a network by ID.

Parameters:

identifier -

unregisterNetwork

public void unregisterNetwork(String identifier)

unregisterContainer

public void unregisterContainer(String identifier)