nbm:nbm

Full name:

org.codehaus.mojo:nbm-maven-plugin:3.6:nbm

Description:

Create the Netbeans module artifact (nbm file), part of "nbm" lifecycle/packaging.

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
cluster String - Netbeans module's cluster. Replaces the cluster element in module descriptor.
Default value is: extra.

Optional Parameters

Name Type Since Description
descriptor File - a netbeans module descriptor containing dependency information and more..
Default value is: ${basedir}/src/main/nbm/module.xml.
distributionUrl String - Distribution base URL for the NBM at runtime deployment time. Note: Uselfulness of the parameter is questionable, it doesn't allow for mirrors and usually when downloading the nbm, one alreayd knows the location anyway. Please note that the netbeans.org Ant scripts put a dummy url here. The actual correct value used when constructing update site is explicitly set there. The general assuption there is that all modules from one update center come from one base URL.

The value is either a direct http protocol based URL that points to the location under which nbm file will be located, or

it allows to create an update site based on maven repository content. The later created autoupdate site document can use this information and compose the application from one or multiple maven repositories.
Format: id::layout::url same as in maven-deploy-plugin
with the 'default' and 'legacy' layouts. (maven2 vs maven1 layout)
If the value doesn't contain :: characters, it's assumed to be the flat structure and the value is just the URL.
encoding String 3.2 The character encoding scheme to be applied when filtering nbm resources.
Default value is: ${project.build.sourceEncoding}.
finalName String - Name of the jar packaged by the jar:jar plugin
keystore String - keystore location for signing the nbm file
keystorealias String - keystore alias
keystorepassword String - keystore password
nbmBuildDir File - Netbeans module assembly build directory. directory where the the netbeans jar and nbm file get constructed.
Default value is: ${project.build.directory}/nbm.
nbmJavahelpSource File 2.7 The location of JavaHelp sources for the project. The documentation itself is expected to be in the directory structure based on codenamebase of the module. eg. if your codenamebase is "org.netbeans.modules.apisupport", then the actual docs files shall go to ${basedir}/src/main/javahelp/org/netbeans/modules/apisupport/docs. Obsolete as of NetBeans 7.0 with @HelpSetRegistration.
Default value is: ${basedir}/src/main/javahelp.
nbmResources Resource[] 3.2 The list of nbmResources we want to include in the nbm file (not in module jar, but as external content within the nbm. Replaces the same configuration in the module descriptor file. For example to include external dll files in the nbm: <nbmResource>
  <directory>src/main/libs</directory>
  <targetPath>lib</targetPath>
  <includes>
    <include>*.dll</include>
    <include>*.so</include>
  </includes>
</nbmResource>
skipNbm boolean 3.0 Boolean parameter denoting if creation of NBM file shall be skipped or not. If skipped, just the expanded directory for cluster is created
Default value is: false.

Parameter Details

cluster:

Netbeans module's cluster. Replaces the cluster element in module descriptor.
  • Type: java.lang.String
  • Required: Yes
  • Default: extra

descriptor:

a netbeans module descriptor containing dependency information and more..
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/main/nbm/module.xml

distributionUrl:

Distribution base URL for the NBM at runtime deployment time. Note: Uselfulness of the parameter is questionable, it doesn't allow for mirrors and usually when downloading the nbm, one alreayd knows the location anyway. Please note that the netbeans.org Ant scripts put a dummy url here. The actual correct value used when constructing update site is explicitly set there. The general assuption there is that all modules from one update center come from one base URL.

The value is either a direct http protocol based URL that points to the location under which nbm file will be located, or

it allows to create an update site based on maven repository content. The later created autoupdate site document can use this information and compose the application from one or multiple maven repositories.
Format: id::layout::url same as in maven-deploy-plugin
with the 'default' and 'legacy' layouts. (maven2 vs maven1 layout)
If the value doesn't contain :: characters, it's assumed to be the flat structure and the value is just the URL.
  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.nbm.distributionURL}

encoding:

The character encoding scheme to be applied when filtering nbm resources.
  • Type: java.lang.String
  • Since: 3.2
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

finalName:

Name of the jar packaged by the jar:jar plugin
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.build.finalName}

keystore:

keystore location for signing the nbm file
  • Type: java.lang.String
  • Required: No
  • Expression: ${keystore}

keystorealias:

keystore alias
  • Type: java.lang.String
  • Required: No
  • Expression: ${keystorealias}

keystorepassword:

keystore password
  • Type: java.lang.String
  • Required: No
  • Expression: ${keystorepass}

nbmBuildDir:

Netbeans module assembly build directory. directory where the the netbeans jar and nbm file get constructed.
  • Type: java.io.File
  • Required: No
  • Expression: ${maven.nbm.buildDir}
  • Default: ${project.build.directory}/nbm

nbmJavahelpSource:

The location of JavaHelp sources for the project. The documentation itself is expected to be in the directory structure based on codenamebase of the module. eg. if your codenamebase is "org.netbeans.modules.apisupport", then the actual docs files shall go to ${basedir}/src/main/javahelp/org/netbeans/modules/apisupport/docs. Obsolete as of NetBeans 7.0 with @HelpSetRegistration.
  • Type: java.io.File
  • Since: 2.7
  • Required: No
  • Default: ${basedir}/src/main/javahelp

nbmResources:

The list of nbmResources we want to include in the nbm file (not in module jar, but as external content within the nbm. Replaces the same configuration in the module descriptor file. For example to include external dll files in the nbm: <nbmResource>
  <directory>src/main/libs</directory>
  <targetPath>lib</targetPath>
  <includes>
    <include>*.dll</include>
    <include>*.so</include>
  </includes>
</nbmResource>
  • Type: org.apache.maven.model.Resource[]
  • Since: 3.2
  • Required: No

skipNbm:

Boolean parameter denoting if creation of NBM file shall be skipped or not. If skipped, just the expanded directory for cluster is created
  • Type: boolean
  • Since: 3.0
  • Required: No
  • Expression: ${maven.nbm.skip}
  • Default: false