org.wildfly.galleon.maven

Class WfFeaturePackBuildMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.wildfly.galleon.maven.AbstractFeaturePackBuildMojo

org.wildfly.galleon.maven.WfFeaturePackBuildMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="build-feature-pack",
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      defaultPhase=COMPILE)
public class WfFeaturePackBuildMojo
extends AbstractFeaturePackBuildMojo

This Maven mojo creates a WildFly style feature-pack archive from the provided resources according to the feature-pack build configuration file and attaches it to the current Maven project as an artifact. The content of the future feature-pack archive is first created in the directory called `layout` under the module's build directory which is then ZIPped to create the feature-pack artifact.

Author:

Alexey Loubyansky

Field Summary

Fields

Modifier and Type	Field and Description
protected File	featureSpecsOutput The directory where the generated feature specs are written.
protected boolean	forkEmbedded Used only for feature spec generation and indicates whether to launch the embedded server to read feature descriptions in a separate process
protected boolean	jakartaTransform Whether to transform artifacts from javax.* to jakarta.* before generating feature specs.
protected File	jakartaTransformConfigsDir Directory where external user provided transformation configs are located (turns of default transformation rules).
protected List<String>	jakartaTransformExcludedArtifacts A list of regular expression filters to exclude a list of GroupId:ArtifactId from jakarta transformation.
protected File	jakartaTransformRepo The directory where a generated local maven repo containing Jakarta-transformed artifacts are stored.
protected boolean	jakartaTransformVerbose If jakarta-transform is true, whether to produce verbose log output of the transformation work.
protected File	moduleTemplatesDir Used only for feature spec generation and points to a directory where the module templates from the dependent feature packs are gathered before they are transformed and copied under their default destination wildflyHome/modules.
protected File	wildflyHome Used only for feature spec generation and points to a directory from which the embedded WildFly instance will be started that is used for exporting the meta-model.

Fields inherited from class org.wildfly.galleon.maven.AbstractFeaturePackBuildMojo

artifactResolver, project, repoSession, repositories, repoSystem, session, taskProps

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
WfFeaturePackBuildMojo()

Method Summary

Modifier and Type	Method and Description
protected void	doExecute()
protected WildFlyFeaturePackBuild	getBuildConfig()

Methods inherited from class org.wildfly.galleon.maven.AbstractFeaturePackBuildMojo

addPackage, buildFeaturePack, debug, execute, getArtifactVersions, getFpDependencies, getFpDir, getPackagesDir, getWildFlyResourcesDir, getWorkDir, handleAddOns, handleLayers, handleModules, processFeaturePackDependencies, resolveArtifact, resolveVersion, setupDirs, warn

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

forkEmbedded

@Parameter(alias="fork-embedded",
           required=false)
protected boolean forkEmbedded

Used only for feature spec generation and indicates whether to launch the embedded server to read feature descriptions in a separate process

wildflyHome

@Parameter(alias="wildfly-home",
           property="wfgp.wildflyHome",
           defaultValue="${project.build.directory}/wildfly",
           required=true)
protected File wildflyHome

Used only for feature spec generation and points to a directory from which the embedded WildFly instance will be started that is used for exporting the meta-model. Intended mainly for debugging.

moduleTemplatesDir

@Parameter(alias="module-templates",
           property="wfgp.moduleTemplatesDir",
           defaultValue="${project.build.directory}/module-templates",
           required=true)
protected File moduleTemplatesDir

Used only for feature spec generation and points to a directory where the module templates from the dependent feature packs are gathered before they are transformed and copied under their default destination wildflyHome/modules. Intended mainly for debugging.

featureSpecsOutput

@Parameter(alias="feature-specs-output",
           defaultValue="${project.build.directory}/resources/features",
           required=true)
protected File featureSpecsOutput

The directory where the generated feature specs are written.

jakartaTransform

@Parameter(alias="jakarta-transform",
           required=false)
protected boolean jakartaTransform

Whether to transform artifacts from javax.* to jakarta.* before generating feature specs.

jakartaTransformConfigsDir

@Parameter(alias="jakarta-transform-configs-dir",
           required=false)
protected File jakartaTransformConfigsDir

Directory where external user provided transformation configs are located (turns of default transformation rules).

jakartaTransformVerbose

@Parameter(alias="jakarta-transform-verbose",
           required=false)
protected boolean jakartaTransformVerbose

If jakarta-transform is true, whether to produce verbose log output of the transformation work.

jakartaTransformRepo

@Parameter(alias="jakarta-transform-maven-repo",
           defaultValue="${project.build.directory}/jakarta-transform-maven-repo",
           required=true)
protected File jakartaTransformRepo

The directory where a generated local maven repo containing Jakarta-transformed artifacts are stored.

jakartaTransformExcludedArtifacts

@Parameter(alias="jakarta-transform-excluded-artifacts",
           required=false)
protected List<String> jakartaTransformExcludedArtifacts

A list of regular expression filters to exclude a list of GroupId:ArtifactId from jakarta transformation. For example, to exclude wildfly-ee and smallrye-config artifacts:

 
 <jakarta-transform-excluded-artifacts>
   <exclude>org.wildfly:wildfly-ee\z</exclude>
   <exclude>io.smallrye.config:smallrye-config\z</exclude>
 </jakarta-transform-excluded-artifacts>
 
 

Constructor Detail

WfFeaturePackBuildMojo

public WfFeaturePackBuildMojo()

Method Detail

getBuildConfig

protected WildFlyFeaturePackBuild getBuildConfig()
                                          throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

doExecute

protected void doExecute()
                  throws org.apache.maven.plugin.MojoExecutionException,
                         org.apache.maven.plugin.MojoFailureException

Specified by:

doExecute in class AbstractFeaturePackBuildMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException