Package io.quarkus.deployment.pkg

Interface PackageConfig.JarConfig

Enclosing interface:
PackageConfig
public static interface PackageConfig.JarConfig
Configuration for creating packages as JARs.

  • Method Details

    • enabled

      @WithDefault("true") boolean enabled()
      If set to false, no JAR will be produced.

    • type

      @WithDefault("fast-jar") PackageConfig.JarConfig.JarType type()
      The JAR output type to use.

    • compress

      @ConfigDocDefault("true") @WithDefault("true") boolean compress()
      Whether the created jar will be compressed. This setting is not used when building a native image

    • manifest

      PackageConfig.JarConfig.ManifestConfig manifest()
      The JAR's manifest sub-configuration.

    • userConfiguredIgnoredEntries

      Optional<List<String>> userConfiguredIgnoredEntries()
      Files that should not be copied to the output artifact.

    • includedOptionalDependencies

      Optional<Set<io.quarkus.maven.dependency.GACT>> includedOptionalDependencies()
      List of all the dependencies that have been defined as optional to include into the final package of the application. Each optional dependency needs to be expressed in the following format:

      groupId:artifactId[:[classifier][:[type]]]

      With the classifier and type being optional (note that the brackets ([]) denote optionality and are not a part of the syntax specification). The group ID and artifact ID must be present and non-empty.

      If the type is missing, the artifact is assumed to be of type jar.

      This parameter is optional; if absent, no optional dependencies will be included into the final package of the application.

      For backward compatibility reasons, this parameter is ignored by default and can be enabled by setting the parameter quarkus.package.jar.filter-optional-dependencies to true.

      This parameter is meant to be used in modules where multi-builds have been configured to avoid getting a final package with unused dependencies.

    • filterOptionalDependencies

      @WithDefault("false") boolean filterOptionalDependencies()
      Flag indicating whether the optional dependencies should be filtered out or not.

      This parameter is meant to be used in modules where multi-builds have been configured to avoid getting a final package with unused dependencies.

    • addRunnerSuffix

      @WithDefault("true") boolean addRunnerSuffix()
      Indicates whether the generated JAR file should have the runner suffix appended. Only applicable to the uber-JAR output type. If disabled, the JAR built by the original build system (Maven, Gradle, etc.) will be replaced with the Quarkus-built uber-JAR.

    • appcds

      PackageConfig.JarConfig.AppcdsConfig appcds()
      AppCDS archive sub-configuration. This configuration only applies to certain JAR types.

    • userProvidersDirectory

      Optional<String> userProvidersDirectory()
      This is an advanced option that only takes effect for development mode.

      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.

    • includeDependencyList

      @WithDefault("true") boolean includeDependencyList()
      If this option is true then a list of all the coordinates of the artifacts that made up this image will be included in the quarkus-app directory. This list can be used by vulnerability scanners to determine if your application has any vulnerable dependencies. Only supported for the fast JAR and mutable JAR output types.

    • decompiler

      PackageConfig.DecompilerConfig decompiler()
      Decompiler configuration