dev.jeka.core.api.tooling.docker

Class JkDockerJvmBuild

java.lang.Object

dev.jeka.core.api.tooling.docker.JkDockerBuild

dev.jeka.core.api.tooling.docker.JkDockerJvmBuild

public class JkDockerJvmBuild
extends JkDockerBuild

Docker Builder assistant for creating Docker images that run JVM applications.
Provides functionality tailored to JVM programs, such as setting classes, classpaths, agents, and Maven repositories for fetching tools.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkDockerJvmBuild.PopularBaseImage

Nested classes/interfaces inherited from class dev.jeka.core.api.tooling.docker.JkDockerBuild

JkDockerBuild.AddUserStatement, JkDockerBuild.DockerfileTemplate, JkDockerBuild.NonRootMode

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_BASE_IMAGE
protected JkRepoSet	repos

Fields inherited from class dev.jeka.core.api.tooling.docker.JkDockerBuild

dockerfileTemplate

Method Summary

Modifier and Type	Method and Description
JkDockerJvmBuild	adaptTo(JkBuildable buildable) Adapts this JkDockerBuild instance to build the specified JkProject.
JkDockerJvmBuild	addAgent(java.nio.file.Path file, java.lang.String agentOptions) Adds the specified agent to the running JVM
JkDockerJvmBuild	addAgent(java.lang.String agentCoordinate) Adds the specified agent to the running JVM, without passing any option.
JkDockerJvmBuild	addAgent(java.lang.String agentCoordinate, java.lang.String agentOptions) Adds the specified agent to the running JVM
JkDockerJvmBuild	addJvmOptions(java.util.List<java.lang.String> jvmOptions) Adds the specified JVM options to the Java process.
void	buildImage(java.nio.file.Path contextDir, java.lang.String imageName) Builds the Docker image with the specified image name.
static JkDockerJvmBuild	of() Creates a instannce.
static JkDockerJvmBuild	of(JkBuildable buildable) Creates a JkDockerBuild instance for the specified JkProject.
java.lang.String	renderInfo() Returns a formatted string that contains information about this Docker build.
JkDockerJvmBuild	setClasses(JkPathTree classes) Sets the compiled Java classes that constitute the Java program to be executed.
JkDockerJvmBuild	setClasspath(java.util.List<java.nio.file.Path> classpath) Sets the jar files that constitute the classpath of the program to be executed.
JkDockerBuild	setDownloadMavenRepos(JkRepoSet repos) Sets the Maven repository used for downloading agent jars.
JkDockerJvmBuild	setMainClass(java.lang.String mainClass) Specifies the main class to run to execute the Program.

Methods inherited from class dev.jeka.core.api.tooling.docker.JkDockerBuild

addFsOperation, addTokenResolver, buildImageInTemp, computeImportedFileRelativePath, generateContextDir, getBaseImage, getExposedPorts, getPortMappingArgs, hasNonRootUserCreation, renderDockerfile, setAddUserStatement, setAddUserStatement, setBaseImage, setExposedPorts, setGroupId, setNonRootUserCreationMode, setUserId, toDoubleQuotedArgs, toDoubleQuotedArgs

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BASE_IMAGE

public static final java.lang.String DEFAULT_BASE_IMAGE

repos

protected JkRepoSet repos

Method Detail

of

public static JkDockerJvmBuild of()

Creates a instannce.

of

public static JkDockerJvmBuild of(JkBuildable buildable)

Creates a JkDockerBuild instance for the specified JkProject.

buildImage

public void buildImage(java.nio.file.Path contextDir,
                       java.lang.String imageName)

Description copied from class: JkDockerBuild

Builds the Docker image with the specified image name.

Overrides:

buildImage in class JkDockerBuild

Parameters:

contextDir - the directory where the Dockerfile will be generated and from which COPY paths will be resolved.

imageName - the name of the image to build. It may include a tag name.

adaptTo

public JkDockerJvmBuild adaptTo(JkBuildable buildable)

Adapts this JkDockerBuild instance to build the specified JkProject.

setClasses

public JkDockerJvmBuild setClasses(JkPathTree classes)

Sets the compiled Java classes that constitute the Java program to be executed.

setClasspath

public JkDockerJvmBuild setClasspath(java.util.List<java.nio.file.Path> classpath)

Sets the jar files that constitute the classpath of the program to be executed.

setMainClass

public JkDockerJvmBuild setMainClass(java.lang.String mainClass)

Specifies the main class to run to execute the Program.

addAgent

public JkDockerJvmBuild addAgent(java.nio.file.Path file,
                                 java.lang.String agentOptions)

Adds the specified agent to the running JVM

Parameters:

file - The agent jar file in the host system

agentOptions - The agent options that will be prepended to '-javaagent:' option

addAgent

public JkDockerJvmBuild addAgent(java.lang.String agentCoordinate,
                                 java.lang.String agentOptions)

Adds the specified agent to the running JVM

Parameters:

agentCoordinate - The agent maven coordinate to download agent.

agentOptions - The agent options that will be prepended to '-javaagent:' option

addAgent

public JkDockerJvmBuild addAgent(java.lang.String agentCoordinate)

Adds the specified agent to the running JVM, without passing any option.

Parameters:

agentCoordinate - The agent maven coordinate to download agent.

addJvmOptions

public JkDockerJvmBuild addJvmOptions(java.util.List<java.lang.String> jvmOptions)

Adds the specified JVM options to the Java process.

setDownloadMavenRepos

public final JkDockerBuild setDownloadMavenRepos(JkRepoSet repos)

Sets the Maven repository used for downloading agent jars. Initial value is Maven central.

renderInfo

public java.lang.String renderInfo()

Returns a formatted string that contains information about this Docker build.

Overrides:

renderInfo in class JkDockerBuild