Overview
HOWTOs
Deprecated

nbm:cluster-app

Full name:

org.netbeans.maven:nbm-maven-plugin:4.2-SNAPSHOT:cluster-app

Description:

Create the NetBeans module clusters/application for the 'nbm-application' packaging projects

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
brandingToken String - The branding token for the application based on NetBeans platform.
User property is: netbeans.branding.token.
outputDirectory File - output directory where the the NetBeans application will be created.
Default value is: ${project.build.directory}.

Optional Parameters

Name Type Since Description
binDirectory File - Directory which contains the executables that will be copied to the final application's bin/ directory. Please note that the name of the executables shall generally match the brandingToken parameter. Otherwise the application can be wrongly branded.
User property is: netbeans.bin.directory.
defaultCluster String - If the depending NBM file doesn't contain any application cluster information, use this value as default location for such module NBMs.
Default value is: extra.
etcClustersFile File - Optional path to custom etc/${brandingToken}.clusters file. If not defined, a default one will be generated.
User property is: netbeans.clusters.file.
etcConfFile File - Optional path to custom etc/${brandingToken}.conf file. If not defined, a default template will be used.
User property is: netbeans.conf.file.
verifyIntegrity boolean - attempts to verify the integrity of module artifacts making sure that all dependencies are included and that all required tokens are provided
Default value is: true.
User property is: netbeans.verify.integrity.

Parameter Details

binDirectory:

Directory which contains the executables that will be copied to the final application's bin/ directory. Please note that the name of the executables shall generally match the brandingToken parameter. Otherwise the application can be wrongly branded.
  • Type: java.io.File
  • Required: No
  • User Property: netbeans.bin.directory

brandingToken:

The branding token for the application based on NetBeans platform.
  • Type: java.lang.String
  • Required: Yes
  • User Property: netbeans.branding.token

defaultCluster:

If the depending NBM file doesn't contain any application cluster information, use this value as default location for such module NBMs.
  • Type: java.lang.String
  • Required: No
  • Default: extra

etcClustersFile:

Optional path to custom etc/${brandingToken}.clusters file. If not defined, a default one will be generated.
  • Type: java.io.File
  • Required: No
  • User Property: netbeans.clusters.file

etcConfFile:

Optional path to custom etc/${brandingToken}.conf file. If not defined, a default template will be used.
  • Type: java.io.File
  • Required: No
  • User Property: netbeans.conf.file

outputDirectory:

output directory where the the NetBeans application will be created.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}

verifyIntegrity:

attempts to verify the integrity of module artifacts making sure that all dependencies are included and that all required tokens are provided
  • Type: boolean
  • Required: No
  • User Property: netbeans.verify.integrity
  • Default: true