dev.jeka.core.api.tooling.docker

Class JkDocker

java.lang.Object

dev.jeka.core.api.system.JkAbstractProcess<JkDocker>

dev.jeka.core.api.tooling.docker.JkDocker

All Implemented Interfaces:

java.lang.Runnable

public class JkDocker
extends JkAbstractProcess<JkDocker>

Class providing utility methods for executing Docker commands.

Field Summary

Fields inherited from class dev.jeka.core.api.system.JkAbstractProcess

CURRENT_JAVA_DIR

Method Summary

Modifier and Type	Method and Description
JkDocker	assertPresent() Asserts that Docker is present and responsive on the system.
protected JkDocker	copy()
JkProcResult	execJekaInDocker(java.lang.String... jekaCommandArgs) Executes Jeka in a docker container.
java.util.List<java.lang.String>	getLocalImages() Retrieves the names of Docker images available locally.
boolean	isPresent() Checks if Docker is present on the system.
JkDocker	login(java.lang.String registry, java.lang.String username, java.lang.String password) Login to a Docker registry using the specified credentials.
JkDocker	loginDockerHub(java.lang.String username, java.lang.String password)
static JkDocker	of()
JkAbstractProcess<?>	prepareExecJekaInDocker(java.nio.file.Path workingDir, java.lang.String... jekaCommandArgs) Prepares a JkProcess object to execute Jeka in a Docker container.
JkAbstractProcess<?>	prepareExecJekaInDocker(java.lang.String... jekaCommandArgs)

Methods inherited from class dev.jeka.core.api.system.JkAbstractProcess

addParams, addParams, addParamsAsCmdLine, addParamsAt, addParamsAt, addParamsIf, customizeCommand, exec, execAsync, execCmd, execCmdLine, getParamAt, getParams, getWorkingDir, inheritJkLogOptions, isFailOnError, redirectErrorStream, removeParam, run, setCollectStderr, setCollectStdout, setDestroyAtJvmShutdown, setEnv, setFailOnError, setInheritIO, setLogCommand, setLogWithJekaDecorator, setParamAt, setWorkingDir, setWorkingDir, toString

Methods inherited from class java.lang.Object

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

Method Detail

of

public static JkDocker of()

copy

protected JkDocker copy()

Overrides:

copy in class JkAbstractProcess<JkDocker>

login

public JkDocker login(java.lang.String registry,
                      java.lang.String username,
                      java.lang.String password)

Login to a Docker registry using the specified credentials.

Parameters:

registry - The URL or name of the Docker registry to log in to, i.e. $ACR_NAME.azurecr.io

username - The username for authentication with the registry.

password - The password for authentication with the registry.

loginDockerHub

public JkDocker loginDockerHub(java.lang.String username,
                               java.lang.String password)

isPresent

public boolean isPresent()

Checks if Docker is present on the system.

assertPresent

public JkDocker assertPresent()

Asserts that Docker is present and responsive on the system.

Throws:

java.lang.IllegalStateException - if the Docker daemon is not running or unresponsive.

getLocalImages

public java.util.List<java.lang.String> getLocalImages()

Retrieves the names of Docker images available locally. The image names are formatted as "repository:tag".

Returns:

A set of strings representing the names of local Docker images, where each name is in the format "repository:tag".

prepareExecJekaInDocker

public JkAbstractProcess<?> prepareExecJekaInDocker(java.nio.file.Path workingDir,
                                                    java.lang.String... jekaCommandArgs)

Prepares a JkProcess object to execute Jeka in a Docker container. This can be useful for creating native executable runnable in a container.

The latest jekadev/jeka image will be used to execute jeka.
The container will be map volumes to execute Jeka in the working directory, and to fetch cache in $HOME/.jeka/cache4c:/cache dir.
You can force a specific version of Jeka by adding -Djeka.version=xxx to jekaCommandArgs

Parameters:

jekaCommandArgs - The argument to pass to JeKa

prepareExecJekaInDocker

public JkAbstractProcess<?> prepareExecJekaInDocker(java.lang.String... jekaCommandArgs)

execJekaInDocker

public JkProcResult execJekaInDocker(java.lang.String... jekaCommandArgs)

Executes Jeka in a docker container.

See Also:

prepareExecJekaInDocker(Path, String...)