Overview
HOWTOs
Deprecated

NetBeansModule

Maven's model for the NetBeans module descriptor.

<nbm>
  <moduleType/>
  <codeNameBase/>
  <cluster/>
  <requiresRestart/>
  <manifest/>
  <homepageUrl/>
  <distributionUrl/>
  <author/>
  <licenseName/>
  <licenseFile/>
  <libraries/>
  <dependencies>
    <dependency>
      <id/>
      <type/>
      <explicitValue/>
    </dependency>
  </dependencies>
  <nbmResources>
    <nbmResource>
      <baseDirectory/>
      <relativeClusterPath/>
      <includes/>
      <excludes/>
    </nbmResource>
  </nbmResources>
</nbm>

nbm

Describes the layout, dependencies and packaging of a NetBeans module.

Element Type Description
moduleType String

DEPRECATED, use the plugin configuration instead. Type of the module. Possible values are

autoload - Such a module is automatically enabled when some other module requires it and automatically disabled otherwise.

eager - This module type gets automatically enabled when all it's dependencies are satisfied. Disabled otherwise.

normal - This is the default value. This kind of module is enabled/disabled manually by the user. It installs enabled.

codeNameBase String DEPRECATED, use the plugin configuration instead. Codenamebase of the module. Primary identification of the module. Usually the package name. Eg. "org.codehaus.mevenide.project". If not defined here, the default value is constructed from groupId and artifactId.
cluster String DEPRECATED, use the plugin configuration instead. Each modules should belong to a cluster. A cluster is a group of related modules. For individual modules it's not that important. Refer to netbeans.org documentation for more details.
requiresRestart boolean DEPRECATED, use the plugin configuration instead. Determines if the module requires restart of the IDE/platform upon installation.
Default value is: false.
manifest String DEPRECATED, use the plugin configuration instead. Location of the manifest file with NetBeans specific manifest entries.
homepageUrl String DEPRECATED, use the plugin configuration instead. Homepage URL of the module. Is accessible from NetBeans UI upon installation, should point to place with additional information about the functionality. If not defined, it defaults to POM's url element.
distributionUrl String DEPRECATED, use the plugin configuration instead. Http URL of the location where the module can be downloaded from the internet. This value put into the NBM and used when generating the Autoupdate Site. Should point directly to the NBM download.
author String DEPRECATED, use the plugin configuration instead. Author of the module. Is used when generating the NBM file.
licenseName String DEPRECATED, use the plugin configuration instead. Name of the license. If the user already agreed to the same license before, he/she won't be asked again to agree.
licenseFile String DEPRECATED, use the plugin configuration instead. Path to the license agreement file.
libraries/library* List<String> (Many) groupId:artifactId of artifacts that shall become part of the module and be added on the classpath (ClassPath: manifest entry gets created and the jar is included in the nbm file)
dependencies/dependency* List<Dependency> (Many) DEPRECATED, use the plugin configuration instead. List of module dependencies. The plugin will use it to Generate the OpenIDE-Module-Module-Dependencies manifest entry.
nbmResources/nbmResource* List<NbmResource> (Many) DEPRECATED, use the plugin configuration instead. List of resources that shall be also included into the Nbm file along with the module jar and library jars.

dependency

Element Type Description
id String groupId:artifactId of the dependency defined in the POM (or a transitive dependency)
type String Type of module dependency. 3 possible values allowed.

spec - specification dependency, module can only use public APIs in public packages. Works with the version defined and any later version.

impl - implementation dependency, module can use any class in the dependency module, but works with just the one version of the module.

loose - similar to spec, but isa very loose connection, no version is required, just the module presence.


Default value is: spec.
explicitValue String The plugin tries to resolve the correct module name and module specification/implementation version by examining the dependency jar's manifest. You can override this behaviour by explicitly defining the value here. For example org.openide.io/1 > 10.1 for a "spec" type of dependency.

nbmResource

No description.

Element Type Description
baseDirectory String The base directory, all paths within the nbm file will be the same as paths within the base directory.
relativeClusterPath String A relative path to be added to cluster root where the files will be copied to.
includes/include* List<String> (Many) Include pattern, what shall be included in the nbm.
excludes/exclude* List<String> (Many) Exclude pattern, what files within the basedir shall not be included.