Class DockerEmulatorSupport

java.lang.Object

com.cloudforge.core.local.DockerEmulatorSupport

public final class DockerEmulatorSupport
extends Object

Shared Docker CLI helpers for local emulator containers.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_GATEWAY_PORT	Deprecated. use LocalEmulatorDefaults.GATEWAY_PORT
static final String	DEFAULT_NETWORK	Deprecated. use LocalEmulatorDefaults.DOCKER_NETWORK

Method Summary

Modifier and Type	Method	Description
static List<String>	capture(List<String> command)
static void	connectNetwork(String containerName, String networkName)
static boolean	containerExists(String containerName)
static void	ensureNetwork(String networkName)
static boolean	isContainerRunning(String containerName)
static boolean	isHttpHealthy(URI uri)
static boolean	isHttpReachable(URI uri)	Whether uri answers with any HTTP response at all -- unlike isHttpHealthy(URI), a 4xx/5xx still counts.
static String	primaryContainerNetwork(String containerName)	Returns the primary Docker network for a running container, preferring cfc-network or any network whose name contains cfc (e.g.
static void	pullImage(String image)
static void	removeContainer(String containerName)
static List<String>	removeContainersWithPrefix(String prefix)	Removes emulator-owned workload containers left behind when their LocalStack control plane has been stopped.
static void	run(List<String> command, Duration timeout)
static void	runDetached(List<String> dockerRunCommand)
static void	startExistingContainer(String containerName)
static void	stopContainer(String containerName)
static void	waitForHealthy(URI healthEndpoint)
static void	waitForHealthy(URI healthEndpoint, Duration timeout)
static void	waitForReachable(URI uri)
static void	waitForReachable(URI uri, Duration timeout)

Methods inherited from class Object

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

Field Details

DEFAULT_NETWORK

@Deprecated
public static final String DEFAULT_NETWORK

Deprecated.

use LocalEmulatorDefaults.DOCKER_NETWORK

See Also:

• Constant Field Values

DEFAULT_GATEWAY_PORT

@Deprecated
public static final int DEFAULT_GATEWAY_PORT

Deprecated.

use LocalEmulatorDefaults.GATEWAY_PORT

See Also:

• Constant Field Values

Method Details

ensureNetwork

public static void ensureNetwork(String networkName)
                          throws IOException

Throws:

IOException

primaryContainerNetwork

public static String primaryContainerNetwork(String containerName)
                                      throws IOException

Returns the primary Docker network for a running container, preferring cfc-network or any network whose name contains cfc (e.g. compose project networks).

Throws:

IOException

connectNetwork

public static void connectNetwork(String containerName,
 String networkName)
                           throws IOException

Throws:

IOException

containerExists

public static boolean containerExists(String containerName)
                               throws IOException

Throws:

IOException

isContainerRunning

public static boolean isContainerRunning(String containerName)
                                  throws IOException

Throws:

IOException

stopContainer

public static void stopContainer(String containerName)
                          throws IOException

Throws:

IOException

startExistingContainer

public static void startExistingContainer(String containerName)
                                   throws IOException

Throws:

IOException

removeContainer

public static void removeContainer(String containerName)
                            throws IOException

Throws:

IOException

removeContainersWithPrefix

public static List<String> removeContainersWithPrefix(String prefix)
                                               throws IOException

Removes emulator-owned workload containers left behind when their LocalStack control plane has been stopped. Names are filtered in-process rather than passed as a Docker wildcard so unrelated containers are never targeted.

Returns:

the removed container names

Throws:

IOException

pullImage

public static void pullImage(String image)
                      throws IOException

Throws:

IOException

runDetached

public static void runDetached(List<String> dockerRunCommand)
                        throws IOException

Throws:

IOException

waitForHealthy

public static void waitForHealthy(URI healthEndpoint)
                           throws IOException

Throws:

IOException

waitForHealthy

public static void waitForHealthy(URI healthEndpoint,
 Duration timeout)
                           throws IOException

Throws:

IOException

isHttpHealthy

public static boolean isHttpHealthy(URI uri)

waitForReachable

public static void waitForReachable(URI uri)
                             throws IOException

Throws:

IOException

waitForReachable

public static void waitForReachable(URI uri,
 Duration timeout)
                             throws IOException

Throws:

IOException

isHttpReachable

public static boolean isHttpReachable(URI uri)

Whether uri answers with any HTTP response at all -- unlike isHttpHealthy(URI), a 4xx/5xx still counts. For a plain reverse proxy (the emulator edge) with no default vhost, an unmatched request 404s the moment nginx itself is up and serving, before any application route has been reconciled in; requiring 2xx there (as isHttpHealthy does) reports the container unhealthy indefinitely on a cold start with nothing deployed yet, even though it's already serving traffic correctly.

run

public static void run(List<String> command,
 Duration timeout)
                throws IOException

Throws:

IOException

capture

public static List<String> capture(List<String> command)
                            throws IOException

Throws:

IOException