nbm:cluster-app

Full name:

org.codehaus.mojo:nbm-maven-plugin:3.7: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.
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.
defaultCluster String 3.2 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.
etcConfFile File - Optional path to custom etc/${brandingToken}.conf file. If not defined, a default template will be used.
useOSGiDependencies boolean 3.6 Process OSGi dependencies. These will all go into defaultCluster.
Default value is: false.

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
  • Expression: ${netbeans.bin.directory}

brandingToken:

The branding token for the application based on NetBeans platform.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${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
  • Since: 3.2
  • 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
  • Expression: ${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
  • Expression: ${netbeans.conf.file}

outputDirectory:

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

useOSGiDependencies:

Process OSGi dependencies. These will all go into defaultCluster.
  • Type: boolean
  • Since: 3.6
  • Required: No
  • Default: false