Overview
HOWTOs

nb-repository:populate

Full name:

org.netbeans.maven:nb-repository-plugin:1.4-SNAPSHOT:populate

Description:

A goal for identifying NetBeans modules from the installation and populating the local repository with them. Optionally you can also deploy to a remote repository.

If you are looking for an existing remote repository for NetBeans artifacts, check out http://bits.netbeans.org/nexus/content/groups/netbeans/, it contains API artifacts for multiple releases. http://bits.netbeans.org/netbeans/trunk/maven-snapshot/ may also be used for SNAPSHOT artifacts if you wish to test development builds.

See this HOWTO on how to generate the NetBeans binaries required by this goal.

Attributes:

  • Executes as an aggregator plugin.

Required Parameters

Name Type Since Description
netbeansInstallDirectory File - Location of NetBeans installation
User property is: netbeansInstallDirectory.
netbeansNbmDirectory File - If defined, will match the nbm files found in the designated folder with the modules and upload the nbm file next to the module jar in local and remote repositories. Assumes a folder with <code-name-base>.nbm files containing nbm files for modules.
User property is: netbeansNbmDirectory.

Optional Parameters

Name Type Since Description
defineCluster boolean - Whether to create cluster POMs in the org.netbeans.cluster group. Only meaningful when forcedVersion is defined.
Default value is: true.
User property is: defineCluster.
dependencyRepositoryId String - Repository ID to use when inspecting remote dependencies. Only meaningful when dependencyRepositoryUrl is defined.
Default value is: temp.
User property is: dependencyRepositoryId.
dependencyRepositoryUrl String - Optional remote repository to use for inspecting remote dependencies. This may be used to populate just part of an installation, when base modules are already available in Maven format. Currently only supported when forcedVersion is defined.
User property is: dependencyRepositoryUrl.
deployUrl String - an url where to deploy the NetBeans artifacts. Optional, if not specified, the artifacts will be only installed in local repository, if you need to give credentials to access remote repo, the id of the server is hardwired to "netbeans".
User property is: deployUrl.
forcedVersion String - When specified, will force all modules to have the designated version. Good when depending on releases. Then you would for example specify RELEASE50 in this parameter and all modules get this version in the repository. If not defined, the maven version is derived from the OpenIDE-Module-Specification-Version manifest attribute.

Highly Recommended!


User property is: forcedVersion.
groupIdPrefix String - a prefix for groupId of generated content, eg. for org.netbeans value will generate org.netbeans.cluster groupId for clusters and org.netbeans.modules for module artifacts.
Default value is: org.netbeans.
User property is: groupIdPrefix.
netbeansJavadocDirectory File - If you want to install/deploy also NetBeans api javadocs, download the javadoc zip file from netbeans.org expand it to a directory, it should contain multiple zip files. Define this parameter as absolute path to the zip files folder.
User property is: netbeansJavadocDirectory.
netbeansSourcesDirectory File - Assumes a folder with <code-name-base>.zip files containing sources for modules.
User property is: netbeansSourcesDirectory.
nexusIndexDirectory File - When specified it points to a directory containing a Maven Indexer (Nexus) Lucene index. This index will be used to find external libraries that are referenced by NetBeans modules and populate the POM metadata with correct dependencies. Any dependencies not found this way, will be generated with a unique id under the org.netbeans.external groupId. Use the download goal to retrieve the index.
User property is: nexusIndexDirectory.
skipLocalInstall boolean - By default the generated metadata is installed in local repository. Setting this parameter to false will avoid installing the bits. Only meaningful together with a defined "deployUrl" parameter.
Default value is: false.
User property is: skipInstall.

Parameter Details

defineCluster:

Whether to create cluster POMs in the org.netbeans.cluster group. Only meaningful when forcedVersion is defined.
  • Type: boolean
  • Required: No
  • User Property: defineCluster
  • Default: true

dependencyRepositoryId:

Repository ID to use when inspecting remote dependencies. Only meaningful when dependencyRepositoryUrl is defined.
  • Type: java.lang.String
  • Required: No
  • User Property: dependencyRepositoryId
  • Default: temp

dependencyRepositoryUrl:

Optional remote repository to use for inspecting remote dependencies. This may be used to populate just part of an installation, when base modules are already available in Maven format. Currently only supported when forcedVersion is defined.
  • Type: java.lang.String
  • Required: No
  • User Property: dependencyRepositoryUrl

deployUrl:

an url where to deploy the NetBeans artifacts. Optional, if not specified, the artifacts will be only installed in local repository, if you need to give credentials to access remote repo, the id of the server is hardwired to "netbeans".
  • Type: java.lang.String
  • Required: No
  • User Property: deployUrl

forcedVersion:

When specified, will force all modules to have the designated version. Good when depending on releases. Then you would for example specify RELEASE50 in this parameter and all modules get this version in the repository. If not defined, the maven version is derived from the OpenIDE-Module-Specification-Version manifest attribute.

Highly Recommended!

  • Type: java.lang.String
  • Required: No
  • User Property: forcedVersion

groupIdPrefix:

a prefix for groupId of generated content, eg. for org.netbeans value will generate org.netbeans.cluster groupId for clusters and org.netbeans.modules for module artifacts.
  • Type: java.lang.String
  • Required: No
  • User Property: groupIdPrefix
  • Default: org.netbeans

netbeansInstallDirectory:

Location of NetBeans installation
  • Type: java.io.File
  • Required: Yes
  • User Property: netbeansInstallDirectory

netbeansJavadocDirectory:

If you want to install/deploy also NetBeans api javadocs, download the javadoc zip file from netbeans.org expand it to a directory, it should contain multiple zip files. Define this parameter as absolute path to the zip files folder.
  • Type: java.io.File
  • Required: No
  • User Property: netbeansJavadocDirectory

netbeansNbmDirectory:

If defined, will match the nbm files found in the designated folder with the modules and upload the nbm file next to the module jar in local and remote repositories. Assumes a folder with <code-name-base>.nbm files containing nbm files for modules.
  • Type: java.io.File
  • Required: Yes
  • User Property: netbeansNbmDirectory

netbeansSourcesDirectory:

Assumes a folder with <code-name-base>.zip files containing sources for modules.
  • Type: java.io.File
  • Required: No
  • User Property: netbeansSourcesDirectory

nexusIndexDirectory:

When specified it points to a directory containing a Maven Indexer (Nexus) Lucene index. This index will be used to find external libraries that are referenced by NetBeans modules and populate the POM metadata with correct dependencies. Any dependencies not found this way, will be generated with a unique id under the org.netbeans.external groupId. Use the download goal to retrieve the index.
  • Type: java.io.File
  • Required: No
  • User Property: nexusIndexDirectory

skipLocalInstall:

By default the generated metadata is installed in local repository. Setting this parameter to false will avoid installing the bits. Only meaningful together with a defined "deployUrl" parameter.
  • Type: boolean
  • Required: No
  • User Property: skipInstall
  • Default: false