expanders:expansionResource

Full name:

net.democritus.maven.plugins:expanders-maven-plugin:2022.5.3-SNAPSHOT:expansionResource

Description:

Generate ApplicationExpansionResource for a project.

Requires net.democritus:expanders-common dependency available in classpath/project dependencies.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Since version: 2020.1.0.
  • Binds by default to the lifecycle phase: generate-resources.

Required Parameters

Name Type Since Description
<expansionSettings> File 2019.5.3 Expansion settings used for expansion.
Default value is: ${project.basedir}/conf/expansionSettings.xml.
User property is: expansion.settings.
<mavenBuildDir> File 2019.5.3

Alternative location where nsx-prime should be installed.

nsf command will be available in ${mavenBuildDir}/repositories/nsx/prime/nsf


Default value is: ${project.build.directory}.
<rootDirectory> File 2020.1.0 Root directory under which resources should be located.
The rootDirectory is typically the parent of resources directory.
Default value is: ${project.basedir}/src/main.
<targetDirectory> File 2020.1.0 Directory to which expansionResource.xml should be generated.
If overridden, the targetDirectory must be added as a build resource.


<build>
   <resource>
     <directory>custom-target-directory</directory>
     <filtering>false</filtering>
   </resource>
 </build>


Default value is: ${project.build.outputDirectory}.

Optional Parameters

Name Type Since Description
<clean> Boolean 2019.5.3 Remove previous expansion before expanding, or harvest files before harvesting.
Default value is: false.
User property is: expansion.clean.
<debugAddress> String 2020.18.0 Set a debug address (hostname:port) to debug expansion/harvest
User property is: expansion.debug.address.
<descriptionFile> File 2020.16.0 File containing the description of the expansion resource
Default value is: ${project.basedir}/DESCRIPTION.md.
<exclusions> List 2022.3.0 Excluded directories
<includeClassPathDependencies> Boolean 2022.1.0 Add Class-Path dependencies to the manifest, so that the dependencies can be added when needed at expand time. Requires at least prime-core 2022.4.0
Default value is: false.
User property is: expansion.resource.classpath.
<nsfArgs> List 2020.8.0

Experimental. Additional arguments passed directly to nsf/NsxPrimeRunner. Example:


<nsfArgs>
  <arg>--expander</arg>
  <arg>DataExpander</arg>
</nsfArgs>


Parameter Details

<clean>

Remove previous expansion before expanding, or harvest files before harvesting.
  • Type: java.lang.Boolean
  • Since: 2019.5.3
  • Required: No
  • User Property: expansion.clean
  • Default: false

<debugAddress>

Set a debug address (hostname:port) to debug expansion/harvest
  • Type: java.lang.String
  • Since: 2020.18.0
  • Required: No
  • User Property: expansion.debug.address

<descriptionFile>

File containing the description of the expansion resource
  • Type: java.io.File
  • Since: 2020.16.0
  • Required: No
  • Default: ${project.basedir}/DESCRIPTION.md

<exclusions>

Excluded directories
  • Type: java.util.List
  • Since: 2022.3.0
  • Required: No

<expansionSettings>

Expansion settings used for expansion.
  • Type: java.io.File
  • Since: 2019.5.3
  • Required: Yes
  • User Property: expansion.settings
  • Default: ${project.basedir}/conf/expansionSettings.xml

<includeClassPathDependencies>

Add Class-Path dependencies to the manifest, so that the dependencies can be added when needed at expand time. Requires at least prime-core 2022.4.0
  • Type: java.lang.Boolean
  • Since: 2022.1.0
  • Required: No
  • User Property: expansion.resource.classpath
  • Default: false

<mavenBuildDir>

Alternative location where nsx-prime should be installed.

nsf command will be available in ${mavenBuildDir}/repositories/nsx/prime/nsf

  • Type: java.io.File
  • Since: 2019.5.3
  • Required: Yes
  • Default: ${project.build.directory}

<nsfArgs>

Experimental. Additional arguments passed directly to nsf/NsxPrimeRunner. Example:


<nsfArgs>
  <arg>--expander</arg>
  <arg>DataExpander</arg>
</nsfArgs>

  • Type: java.util.List
  • Since: 2020.8.0
  • Required: No

<rootDirectory>

Root directory under which resources should be located.
The rootDirectory is typically the parent of resources directory.
  • Type: java.io.File
  • Since: 2020.1.0
  • Required: Yes
  • Default: ${project.basedir}/src/main

<targetDirectory>

Directory to which expansionResource.xml should be generated.
If overridden, the targetDirectory must be added as a build resource.


<build>
   <resource>
     <directory>custom-target-directory</directory>
     <filtering>false</filtering>
   </resource>
 </build>

  • Type: java.io.File
  • Since: 2020.1.0
  • Required: Yes
  • Default: ${project.build.outputDirectory}