org.eclipse.jkube.kit.common

Class AssemblyConfiguration.AssemblyConfigurationBuilder

java.lang.Object

org.eclipse.jkube.kit.common.AssemblyConfiguration.AssemblyConfigurationBuilder

Enclosing class:

AssemblyConfiguration

public static class AssemblyConfiguration.AssemblyConfigurationBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
AssemblyConfiguration	build()
AssemblyConfiguration.AssemblyConfigurationBuilder	clearLayers()
AssemblyConfiguration.AssemblyConfigurationBuilder	excludeFinalOutputArtifact(boolean excludeFinalOutputArtifact) By default, the project's final artifact will be included in the assembly, set this flag to true in case the artifact should be excluded from the assembly.
AssemblyConfiguration.AssemblyConfigurationBuilder	exportTargetDir(Boolean exportTargetDir) Whether the target directory should be exported as a volume.
AssemblyConfiguration.AssemblyConfigurationBuilder	inline(Assembly inline) Deprecated. Use layers instead
AssemblyConfiguration.AssemblyConfigurationBuilder	layer(Assembly layer)
AssemblyConfiguration.AssemblyConfigurationBuilder	layers(Collection<? extends Assembly> layers)
AssemblyConfiguration.AssemblyConfigurationBuilder	mode(AssemblyMode mode) Mode how the assembled files should be collected.
AssemblyConfiguration.AssemblyConfigurationBuilder	modeString(String modeString)
AssemblyConfiguration.AssemblyConfigurationBuilder	name(String name) Assembly name, which is maven by default.
AssemblyConfiguration.AssemblyConfigurationBuilder	permissions(AssemblyConfiguration.PermissionMode permissions) Permission of the files to add.
AssemblyConfiguration.AssemblyConfigurationBuilder	permissionsString(String permissionsString)
AssemblyConfiguration.AssemblyConfigurationBuilder	targetDir(String targetDir) Directory under which the files and artifacts contained in the assembly will be copied within the container.
AssemblyConfiguration.AssemblyConfigurationBuilder	tarLongFileMode(String tarLongFileMode) Sets the TarArchiver behaviour on file paths with more than 100 characters length.
String	toString()
AssemblyConfiguration.AssemblyConfigurationBuilder	user(String user) User and/or group under which the files should be added.

Methods inherited from class java.lang.Object

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

Method Detail

permissionsString

public AssemblyConfiguration.AssemblyConfigurationBuilder permissionsString(String permissionsString)

modeString

public AssemblyConfiguration.AssemblyConfigurationBuilder modeString(String modeString)

name

public AssemblyConfiguration.AssemblyConfigurationBuilder name(String name)

Assembly name, which is maven by default. This name is used for the archives and directories created during the build.

If an external Dockerfile is used then this name is also the relative directory which contains the assembly files.

Returns:

this.

targetDir

public AssemblyConfiguration.AssemblyConfigurationBuilder targetDir(String targetDir)

Directory under which the files and artifacts contained in the assembly will be copied within the container.

The default value for this is /<assembly name>, so /maven if name is not set to a different value.

Returns:

this.

exportTargetDir

public AssemblyConfiguration.AssemblyConfigurationBuilder exportTargetDir(Boolean exportTargetDir)

Whether the target directory should be exported as a volume.

Returns:

this.

excludeFinalOutputArtifact

public AssemblyConfiguration.AssemblyConfigurationBuilder excludeFinalOutputArtifact(boolean excludeFinalOutputArtifact)

By default, the project's final artifact will be included in the assembly, set this flag to true in case the artifact should be excluded from the assembly.

Parameters:

excludeFinalOutputArtifact - set if artifact must be excluded from the assembly.

Returns:

this.

permissions

public AssemblyConfiguration.AssemblyConfigurationBuilder permissions(AssemblyConfiguration.PermissionMode permissions)

Permission of the files to add.

Returns:

this.

mode

public AssemblyConfiguration.AssemblyConfigurationBuilder mode(AssemblyMode mode)

Mode how the assembled files should be collected.

Returns:

this.

user

public AssemblyConfiguration.AssemblyConfigurationBuilder user(String user)

User and/or group under which the files should be added. The user must already exist in the base image.

It has the general format user[:group[:run-user]]. The user and group can be given either as numeric user and group-id or as names. The group id is optional.

If a third part is given, then the build changes to user root before changing the ownerships, changes the ownerships and then change to user run-user which is then used for the final command to execute.

Returns:

this.

tarLongFileMode

public AssemblyConfiguration.AssemblyConfigurationBuilder tarLongFileMode(String tarLongFileMode)

Sets the TarArchiver behaviour on file paths with more than 100 characters length.

Valid values are: "warn"(default), "fail", "truncate", "gnu", "posix", "posix_warn" or "omit".

Returns:

this.

inline

@Deprecated
public AssemblyConfiguration.AssemblyConfigurationBuilder inline(Assembly inline)

Deprecated. Use layers instead

Assembly defined inline in the pom.xml

Returns:

this.

layer

public AssemblyConfiguration.AssemblyConfigurationBuilder layer(Assembly layer)

layers

public AssemblyConfiguration.AssemblyConfigurationBuilder layers(Collection<? extends Assembly> layers)

clearLayers

public AssemblyConfiguration.AssemblyConfigurationBuilder clearLayers()

build

public AssemblyConfiguration build()

toString

public String toString()

Overrides:

toString in class Object