io.quarkus.deployment.pkg

Class PackageConfig

java.lang.Object

io.quarkus.deployment.pkg.PackageConfig

@ConfigRoot
public class PackageConfig
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
boolean	createAppcds Whether to automate the creation of AppCDS.
static String	FAST_JAR This is the new packaging format, it is intended to become the default soonish, so it will just be referred to as 'jar'.
static String	JAR
static String	LEGACY
Optional<String>	mainClass The entry point of the application.
ManifestConfig	manifest Manifest configuration of the runner jar.
static String	MUTABLE_JAR
static String	NATIVE
Optional<String>	outputDirectory The output folder in which to place the output, this is resolved relative to the build systems target directory.
Optional<String>	outputName The name of the final artifact
String	runnerSuffix The suffix that is applied to the runner jar and native images
String	type The requested output type.
static String	UBER_JAR
boolean	uberJar Deprecated.
Optional<List<String>>	userConfiguredIgnoredEntries Files that should not be copied to the output artifact
Optional<String>	userProvidersDirectory This is an advanced option that only takes effect for the mutable-jar format.

Constructor Summary

Constructors

Constructor and Description
PackageConfig()

Method Summary

Modifier and Type	Method and Description
boolean	isAnyJarType()
boolean	isFastJar()
boolean	isLegacyJar()

Methods inherited from class java.lang.Object

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

Field Detail

JAR

public static final String JAR

See Also:

Constant Field Values

UBER_JAR

public static final String UBER_JAR

See Also:

Constant Field Values

FAST_JAR

public static final String FAST_JAR

This is the new packaging format, it is intended to become the default soonish, so it will just be referred to as 'jar'.

See Also:

Constant Field Values

MUTABLE_JAR

public static final String MUTABLE_JAR

See Also:

Constant Field Values

LEGACY

public static final String LEGACY

See Also:

Constant Field Values

NATIVE

public static final String NATIVE

See Also:

Constant Field Values

type

@ConfigItem(defaultValue="jar")
public String type

The requested output type. The default built in types are 'jar', 'fast-jar' (a prototype more performant version of the default 'jar' type), 'uber-jar' and 'native'.

uberJar

@Deprecated
 @ConfigItem(defaultValue="false")
public boolean uberJar

Deprecated.

If the java runner should be packed as an uberjar This is deprecated, you should use quarkus.package.type=uber-jar instead

manifest

@ConfigItem
public ManifestConfig manifest

Manifest configuration of the runner jar.

mainClass

@ConfigItem
public Optional<String> mainClass

The entry point of the application. This can either be a a fully qualified name of a standard Java class with a main method, or QuarkusApplication. If your application has main classes annotated with QuarkusMain then this can also reference the name given in the annotation, to avoid the need to specify fully qualified names in the config.

userConfiguredIgnoredEntries

@ConfigItem
public Optional<List<String>> userConfiguredIgnoredEntries

Files that should not be copied to the output artifact

runnerSuffix

@ConfigItem(defaultValue="-runner")
public String runnerSuffix

The suffix that is applied to the runner jar and native images

outputDirectory

@ConfigItem
public Optional<String> outputDirectory

The output folder in which to place the output, this is resolved relative to the build systems target directory.

outputName

@ConfigItem
public Optional<String> outputName

The name of the final artifact

createAppcds

@ConfigItem
public boolean createAppcds

Whether to automate the creation of AppCDS. This has not effect when a native binary is needed and will be ignored in that case. Furthermore, this option only works for Java 11+ and is considered experimental for the time being. Finally, care must be taken to use the same exact JVM version when building and running the application.

userProvidersDirectory

@ConfigItem
public Optional<String> userProvidersDirectory

This is an advanced option that only takes effect for the mutable-jar format. If this is specified a directory of this name will be created in the jar distribution. Users can place jar files in this directory, and when re-augmentation is performed these will be processed and added to the class-path. Note that before reaugmentation has been performed these jars will be ignored, and if they are updated the app should be reaugmented again.

Constructor Detail

PackageConfig

public PackageConfig()

Method Detail

isAnyJarType

public boolean isAnyJarType()

isFastJar

public boolean isFastJar()

isLegacyJar

public boolean isLegacyJar()