org.eclipse.jkube.kit.common

Class AssemblyConfiguration

java.lang.Object

org.eclipse.jkube.kit.common.AssemblyConfiguration

All Implemented Interfaces:

Serializable

public class AssemblyConfiguration
extends Object
implements Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AssemblyConfiguration.AssemblyConfigurationBuilder
static class	AssemblyConfiguration.PermissionMode

Constructor Summary

Constructors

Constructor and Description
AssemblyConfiguration()
AssemblyConfiguration(String name, String targetDir, Boolean exportTargetDir, boolean excludeFinalOutputArtifact, AssemblyConfiguration.PermissionMode permissions, AssemblyMode mode, String user, String tarLongFileMode, Assembly inline, List<Assembly> layers, boolean flattened)

Method Summary

Modifier and Type	Method and Description
static AssemblyConfiguration.AssemblyConfigurationBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Boolean	getExportTargetDir() Whether the target directory should be exported as a volume.
AssemblyConfiguration	getFlattenedClone(JKubeConfiguration configuration)
Assembly	getInline() Deprecated. Use getLayers() instead
List<Assembly>	getLayers()
AssemblyMode	getMode()
String	getModeRaw()
String	getName() Assembly name, which is maven by default.
AssemblyConfiguration.PermissionMode	getPermissions()
String	getPermissionsRaw()
List<Assembly>	getProcessedLayers(JKubeConfiguration configuration)
String	getTargetDir() Directory under which the files and artifacts contained in the assembly will be copied within the container.
String	getTarLongFileMode() Sets the TarArchiver behaviour on file paths with more than 100 characters length.
String	getUser() User and/or group under which the files should be added.
int	hashCode()
boolean	isExcludeFinalOutputArtifact() 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.
void	setInline(Assembly inline) Deprecated. Use layers instead
AssemblyConfiguration.AssemblyConfigurationBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

AssemblyConfiguration

public AssemblyConfiguration(String name,
                             String targetDir,
                             Boolean exportTargetDir,
                             boolean excludeFinalOutputArtifact,
                             AssemblyConfiguration.PermissionMode permissions,
                             AssemblyMode mode,
                             String user,
                             String tarLongFileMode,
                             Assembly inline,
                             List<Assembly> layers,
                             boolean flattened)

AssemblyConfiguration

public AssemblyConfiguration()

Method Detail

getMode

public AssemblyMode getMode()

getModeRaw

public String getModeRaw()

getPermissions

public AssemblyConfiguration.PermissionMode getPermissions()

getPermissionsRaw

public String getPermissionsRaw()

getInline

@Deprecated
public Assembly getInline()

Deprecated. Use getLayers() instead

setInline

@Deprecated
public void setInline(Assembly inline)

Deprecated. Use layers instead

getLayers

@Nonnull
public List<Assembly> getLayers()

getProcessedLayers

@Nonnull
public List<Assembly> getProcessedLayers(@Nonnull
                                                  JKubeConfiguration configuration)

getFlattenedClone

@Nonnull
public AssemblyConfiguration getFlattenedClone(@Nonnull
                                                        JKubeConfiguration configuration)

builder

public static AssemblyConfiguration.AssemblyConfigurationBuilder builder()

toBuilder

public AssemblyConfiguration.AssemblyConfigurationBuilder toBuilder()

getName

public String getName()

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.

getTargetDir

public String getTargetDir()

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.

getExportTargetDir

public Boolean getExportTargetDir()

Whether the target directory should be exported as a volume.

isExcludeFinalOutputArtifact

public boolean isExcludeFinalOutputArtifact()

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.

Returns:

true if artifact must be excluded from the assembly false otherwise.

getUser

public String getUser()

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.

getTarLongFileMode

public String getTarLongFileMode()

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".

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object