smartics-jboss-modules:create-modules-archive

Full name:

de.smartics.maven.plugin:smartics-jboss-modules-maven-plugin:2.1.5:create-modules-archive

Description:

Generates a archive containing modules from a BOM project.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.0.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
archive MavenArchiveConfiguration 1.0 The archive configuration to use. See Maven Archiver Reference.
attach boolean 1.0 Allows to attach the generated modules as a ZIP archive to the build.
Default value is: true.
defaultSlot String 1.0 The name of the default slot to write to. See slotStrategy.
Default value is: main.
dependencyExcludes List 1.0 A list of dependencies to be excluded from the transitive dependency collection process. 
 <dependencyExcludes>
   <exclude>
     <groupId>com.sun</groupId>
     <artifactId>tools</artifactId>
   </exclude>
 </dependencyExcludes>

excludeDependencyManagementDependenciesInPomProject boolean 1.0 Exclude the dependencies in the dependency management block if the project is a POM project. If the project is not a POM project, these dependencies are never included.

For BOM projects the default of false is usually appropriate. In case of a multi module POM, the property usually is set to true.


Default value is: false.
followOptionalDependencies boolean 1.0 Controls whether or not optional dependencies should be followed.
Default value is: false.
User property is: smartics-jboss-modules.followOptionalDependencies.
generateFeaturePackDefinition boolean 2.1.0 Whether to generate a feature pack definition (true) or not (false). Refer to Provide camel subsystem as feature pack for details.
Default value is: false.
ignoreDependencyExclusions boolean 1.0 Allows to globally ignore exclusions declared in Maven dependencies.
Default value is: false.
ignoreOptionalDependencies boolean 2.1.0 Exclude any dependencies or transitive dependencies that are marked as optional = true.
Default value is: false.
modules List 1.0 The root directories to search for modules XML files that contain module descriptors.

If not specified, the default locations src/main/config/jboss-modules, src/main/resources/META-INF/jboss-modules, and src/etc/jboss-modules is probed and - if exists - are appended.

You may want to use only one of the locations given above. Use config if you do not want to have the configuration files included. Use resources/META-INF if they should and use etc if they should not, but be stored outside the main folder.

<modules>
  <dir>src/etc/jboss-modules</dir>
</modules>

modulesArchive File 1.0 The file to attach, containing the JBoss modules.
Default value is: ${project.build.directory}/${project.artifactId}-${project.version}-jboss-modules.jar.
offline boolean 1.0 Controls the system to act as being offline (true) or not ( false).
Default value is: ${offline}.
remoteRepos List 1.0 The project's remote repositories to use for the resolution of dependencies.
Default value is: ${project.remoteProjectRepositories}.
repositorySession RepositorySystemSession 1.0 The current repository/network configuration of Maven.
Default value is: ${repositorySystemSession}.
skip boolean 1.0 A simple flag to skip the execution of this MOJO. If set on the command line use -Dsmartics-jboss-modules.skip.
Default value is: false.
User property is: smartics-jboss-modules.skip.
slotStrategy String 1.0 The name of the slot strategy to us. If not specified, the major version of the dependency will be used as slot value.

Possible values are:

value description
version-major The slot has the major number of the version. The defaultSlot is prepended, if not set to main (e.g. defaultSlot=prodx and version 1.2.3 then the slot will be named prodx1.
main The slot has the name as given with defaultSlot.

Default value is: main.
targetFolder File 1.0 The folder to write the module structure to.
Default value is: ${project.build.directory}/jboss-modules.
targetNamespace String 2.1.4 The namespace to use in the generated module.xml files.
Default value is: urn:jboss:module:1.1.
updatePolicy String 1.0 Controls the update policy according the access of the remote repositories.

Allowed values are never, always, and daily.


Default value is: never.
User property is: smartics-jboss-modules.update.
verbose boolean 1.0 The verbose level. If set on the command line use -Dsmartics-jboss-modules.verbose.
Default value is: false.
User property is: smartics-jboss-modules.verbose.

Parameter Details

archive:

The archive configuration to use. See Maven Archiver Reference.
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Since: 1.0
  • Required: No

attach:

Allows to attach the generated modules as a ZIP archive to the build.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: true

defaultSlot:

The name of the default slot to write to. See slotStrategy.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: main

dependencyExcludes:

A list of dependencies to be excluded from the transitive dependency collection process. 
 <dependencyExcludes>
   <exclude>
     <groupId>com.sun</groupId>
     <artifactId>tools</artifactId>
   </exclude>
 </dependencyExcludes>
  • Type: java.util.List
  • Since: 1.0
  • Required: No

excludeDependencyManagementDependenciesInPomProject:

Exclude the dependencies in the dependency management block if the project is a POM project. If the project is not a POM project, these dependencies are never included.

For BOM projects the default of false is usually appropriate. In case of a multi module POM, the property usually is set to true.

  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

followOptionalDependencies:

Controls whether or not optional dependencies should be followed.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: smartics-jboss-modules.followOptionalDependencies
  • Default: false

generateFeaturePackDefinition:

Whether to generate a feature pack definition (true) or not (false). Refer to Provide camel subsystem as feature pack for details.
  • Type: boolean
  • Since: 2.1.0
  • Required: No
  • Default: false

ignoreDependencyExclusions:

Allows to globally ignore exclusions declared in Maven dependencies.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

ignoreOptionalDependencies:

Exclude any dependencies or transitive dependencies that are marked as optional = true.
  • Type: boolean
  • Since: 2.1.0
  • Required: No
  • Default: false

modules:

The root directories to search for modules XML files that contain module descriptors.

If not specified, the default locations src/main/config/jboss-modules, src/main/resources/META-INF/jboss-modules, and src/etc/jboss-modules is probed and - if exists - are appended.

You may want to use only one of the locations given above. Use config if you do not want to have the configuration files included. Use resources/META-INF if they should and use etc if they should not, but be stored outside the main folder.

<modules>
  <dir>src/etc/jboss-modules</dir>
</modules>
  • Type: java.util.List
  • Since: 1.0
  • Required: No

modulesArchive:

The file to attach, containing the JBoss modules.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Default: ${project.build.directory}/${project.artifactId}-${project.version}-jboss-modules.jar

offline:

Controls the system to act as being offline (true) or not ( false).
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: ${offline}

remoteRepos:

The project's remote repositories to use for the resolution of dependencies.
  • Type: java.util.List
  • Since: 1.0
  • Required: No
  • Default: ${project.remoteProjectRepositories}

repositorySession:

The current repository/network configuration of Maven.
  • Type: org.eclipse.aether.RepositorySystemSession
  • Since: 1.0
  • Required: No
  • Default: ${repositorySystemSession}

skip:

A simple flag to skip the execution of this MOJO. If set on the command line use -Dsmartics-jboss-modules.skip.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: smartics-jboss-modules.skip
  • Default: false

slotStrategy:

The name of the slot strategy to us. If not specified, the major version of the dependency will be used as slot value.

Possible values are:

value description
version-major The slot has the major number of the version. The defaultSlot is prepended, if not set to main (e.g. defaultSlot=prodx and version 1.2.3 then the slot will be named prodx1.
main The slot has the name as given with defaultSlot.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: main

targetFolder:

The folder to write the module structure to.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Default: ${project.build.directory}/jboss-modules

targetNamespace:

The namespace to use in the generated module.xml files.
  • Type: java.lang.String
  • Since: 2.1.4
  • Required: No
  • Default: urn:jboss:module:1.1

updatePolicy:

Controls the update policy according the access of the remote repositories.

Allowed values are never, always, and daily.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: smartics-jboss-modules.update
  • Default: never

verbose:

The verbose level. If set on the command line use -Dsmartics-jboss-modules.verbose.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: smartics-jboss-modules.verbose
  • Default: false