NetBeans Platform Maven Command Line Tutorial

Welcome to the NetBeans Platform!

This document demonstrates how to create a NetBeans Platform application and module from a command line prompt using the Maven build framework. To create this application you do not need to install or use the NetBeans IDE. You will need to create and edit some files, but you can use a simple text editor. However, an IDE can be very helpful when performing tasks such as editing the POM and managing dependencies.

In this tutorial you will see that after you install Maven, you can specify goals and parameters and execute Maven goals from the command line prompt to create and build projects. The IDE performs the same task, but provides an interface that simplifies the task of specifying the parameters for creating projects.

Contents

To follow this tutorial, you need the software and resources listed in the following table.

Software or Resource Version Required
Java Developer Kit (JDK) version 7 or above
Maven version 3.0.3 or higher, though 2.x versions may still work.

Before starting this tutorial you may want to familiarize yourself with the following documentation.

Creating the NetBeans Platform Application

In this exercise you will execute the Maven goal generate from the command line to generate a new NetBeans Platform application from an archetype in the codehaus.org repository. In the command you will specify the parameters that will be used when Maven generates the application.

  1. Install Maven.
  2. Open a command line terminal.
  3. Test your Maven installation by typing the following command.
    mvn -version

    After you type the command you will see details about the Maven installation, including the version of Maven and the JDK, such as the following:

    Apache Maven 3.0.4 (r1232337; 2012-01-17 09:44:56+0100)
    Maven home: C:\Users\Geertjan\Desktop\apache-maven-3.0.4\bin\..
    Java version: 1.7.0_06, vendor: Oracle Corporation
    Java home: c:\Program Files\Java\jdk1.7.0_06\jre
    Default locale: en_US, platform encoding: Cp1252
    OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"
  4. Navigate to the directory where you want to create the NetBeans Platform application.
  5. Type the following command, on a single line, in a terminal window (also known as the command prompt):
    mvn 
      -DarchetypeGroupId=org.codehaus.mojo.archetypes 
      -DarchetypeArtifactId=netbeans-platform-app-archetype 
      -DarchetypeVersion=1.12 
      archetype:generate

    Here it is on a single line:

    mvn -DarchetypeGroupId=org.codehaus.mojo.archetypes -DarchetypeArtifactId=netbeans-platform-app-archetype -DarchetypeVersion=1.12 archetype:generate
  6. When prompted, enter the following values:

    • groupId: com.mycompany
    • artifactId: mavenPlatformApp
    • version: <press Enter to accept the default>
    • package: <press Enter to accept the default>
    • netbeansVersion: RELEASE72

You can see that the command specifies the archetype that Maven will use to create the NetBeans Platform application (netbeans-platform-app-archetype). The command also specifies the location of the repository for the archetype (http://repository.codehaus.org/) and the version (1.12) and GroupId (org.codehaus.mojo.archetypes) of the archetype.

When you run the command, Maven will automatically retrieve the archetype and create the project according to the details specified in the command (artifact id, version, package).

Note. When you use NetBeans IDE to create a Mavenized NetBeans Platform application, the IDE executes a Maven goal with the same parameters.

For more information about the plugin that is used to generate the artifacts, see the documentation on the nbm-maven-plugin.

When you run the command, you will see output similar to the following in the terminal window.

[INFO] Parameter: groupId, Value: my.company
[INFO] Parameter: artifactId, Value: mavenPlatformApp
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Parameter: package, Value: my.company
[INFO] Parameter: packageInPathFormat, Value: my/company
[INFO] Parameter: package, Value: my.company
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Parameter: netbeansVersion, Value: RELEASE72
[INFO] Parameter: groupId, Value: my.company
[INFO] Parameter: artifactId, Value: mavenPlatformApp
[INFO] project created from Archetype in dir: C:\Users\Geertjan\demo\mavenPlatformApp
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1:12.333s
[INFO] Finished at: Sat Sep 15 23:26:09 CEST 2012
[INFO] Final Memory: 16M/132M

If you look in the root directory mavenPlatformApp that was created, you can see that the new project contains a pom.xml file and a directory for each of the default sub-modules of the archetype: application and branding.

Screenshot of structure of mavenPlatformApp

If you open pom.xml for mavenPlatformApp in an editor, you will see that the POM specifies all the details required for building the application:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>my.company</groupId>
    <artifactId>mavenPlatformApp-parent</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>

    <name>mavenPlatformApp-parent</name>

    <repositories>
        <!--
        Repository hosting NetBeans modules, especially APIs.
        Versions are based on IDE releases, e.g.: RELEASE691
        To create your own repository, use: nbm:populate-repository
        -->
        <repository>
            <id>netbeans</id>
            <name>NetBeans</name>
            <url>http://bits.netbeans.org/maven2/</url>
        </repository>
    </repositories>

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.codehaus.mojo</groupId>
                    <artifactId>nbm-maven-plugin</artifactId>
                    <version>3.8</version>
                    <extensions>true</extensions>
                    <configuration>
                        <brandingToken>${brandingToken}</brandingToken>
                        <cluster>${brandingToken}</cluster>
                    </configuration>
                </plugin>
                <plugin>
                    <!-- NetBeans 6.9+ requires JDK 6 -->
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>2.5.1</version>
                    <configuration>
                        <source>1.6</source>
                        <target>1.6</target>
                    </configuration>
                </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>2.4</version>
            </plugin>
            </plugins>
        </pluginManagement>
    </build>

    <modules>
        <module>branding</module>
        <module>application</module>
    </modules>

    <properties>
        <netbeans.version>RELEASE72</netbeans.version>
        <brandingToken>mavenplatformapp</brandingToken>
    </properties>
</project>

If you look at the <properties> element, you can see that the version of the NetBeans Platform is specified as RELEASE72. In the POM of your sub-modules, you can specify ${netbeans.version} as the version and the module will use the version specified in the parent POM project. The enables you to easily update the NetBeans Platform version for all the project's sub-modules.

Installing and Running the NetBeans Platform Application

In this exercise you will run the Maven install goal from the command line to build the application and copy the artifacts in your local repository. The NetBeans Platform application is a multi-module application. You will use the reactor mechanism in Maven to build the application project and the project's dependencies. After you build the application you will execute the run-platform goal to launch the application.

  1. Navigate to the mavenPlatformApp directory and type the following command to build the project:
    mvn install

    The above command will take some time to complete. When the command completes, you will see the following:

    [INFO] ------------------------------------------------------------------------
    [INFO] Reactor Summary:
    [INFO]
    [INFO] mavenPlatformApp-parent ........................... SUCCESS [0.533s]
    [INFO] mavenPlatformApp-branding ......................... SUCCESS [8.684s]
    [INFO] mavenPlatformApp-app .............................. SUCCESS [33.900s]
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 1:31.177s
    [INFO] Finished at: Sat Sep 15 23:36:18 CEST 2012
    [INFO] Final Memory: 18M/59M
    [INFO] ------------------------------------------------------------------------
  2. After the command above completes, navigate to the application directory and type the following command to launch the application.
    mvn nbm:run-platform

When you run the nbm-maven-plugin with the run-platform goal, as done above, Maven will launch your NetBeans Platform application:

Screenshot of default application

Browse through the menus to see what your new application consists of. Open some windows, undock some of them, and you will have something that looks like this:

Screenshot of default application

You have now successfully created and launched your NetBeans Platform application. The default branding elements are located in the branding sub-module that was generated according to the archetype. The NetBeans IDE provides tools and wizards that can help you to modify the branding elements.

In the next section you will create a new module for the application.

Creating a NetBeans Module from an Archetype

You will now create a new module that is named mavenPlatformModuleA in the mavenPlatformApp directory. In the same way that you created the NetBeans Platform application, you will run a Maven command from the command line and use the module archetype nbm-archetype.

After you create the module, you will use a text editor to create a simple class in the module. You will then build the module to install the module in the local repository.

  1. Navigate to the mavenPlatformApp directory in the command line terminal and run the following command:
    mvn 
      -DarchetypeGroupId=org.codehaus.mojo.archetypes 
      -DarchetypeArtifactId=nbm-archetype 
      -DarchetypeVersion=1.11 
      archetype:generate

    Here it is on a single line:

    mvn -DarchetypeGroupId=org.codehaus.mojo.archetypes -DarchetypeArtifactId=nbm-archetype -DarchetypeVersion=1.11 archetype:generate
  2. When prompted, enter the following values:

    • groupId: com.mycompany
    • artifactId: mavenPlatformModuleA
    • version: <press Enter to accept the default>
    • package: com.mycompany.mavenplatformmodulea
    • netbeansVersion: RELEASE72

    You can see that the command specifies nbm-archetype. The archetype will be retrieved from the remote repository.

    When you run the command, you will see output similar to the following in the terminal window:

    [INFO] Parameter: groupId, Value: com.mycompany
    [INFO] Parameter: artifactId, Value: mavenPlatformModuleA
    [INFO] Parameter: version, Value: 1.0-SNAPSHOT
    [INFO] Parameter: package, Value: com.mycompany.mavenplatformmodulea
    [INFO] Parameter: packageInPathFormat, Value: com/mycompany/mavenplatformmodulea
    
    [INFO] Parameter: package, Value: com.mycompany.mavenplatformmodulea
    [INFO] Parameter: version, Value: 1.0-SNAPSHOT
    [INFO] Parameter: netbeansVersion, Value: RELEASE72
    [INFO] Parameter: groupId, Value: com.mycompany
    [INFO] Parameter: artifactId, Value: mavenPlatformModuleA
    [INFO] project created from Archetype in dir: C:\Users\Geertjan\demo\mavenPlatformApp\mavenPlatformModuleA
    [INFO] ------------------------------------------------------------------------
    [INFO] Reactor Summary:
    [INFO]
    [INFO] mavenPlatformApp-parent ........................... SUCCESS [58.613s]
    [INFO] mavenPlatformApp-branding ......................... SKIPPED
    [INFO] mavenPlatformApp-app .............................. SKIPPED
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 1:00.058s
    [INFO] Finished at: Sat Sep 15 23:52:13 CEST 2012
    [INFO] Final Memory: 19M/131M
    [INFO] ------------------------------------------------------------------------

    If you look at the contents of the mavenPlatformApp directory, you will see that the directory contains a new directory that is named mavenPlatformModuleA. The new directory contains a src directory and pom.xml. The file bundle.properties is generated in the resources/com/mycompany/mavenplatformmodulea directory:

    Screenshot of structure of mavenplatformmodulea

    In the next step you will create a class in the java/com/mycompany/mavenplatformmodulea directory.

  3. Edit the new module's pom.xml to make the following changes (in bold) to add a dependency on the modules you are referring to in the code above.
    <dependencies>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-netbeans-api-annotations-common</artifactId>
            <version>RELEASE72</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-util</artifactId>
            <version>RELEASE72</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-awt</artifactId>
            <version>RELEASE72</version>
        </dependency>
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-openide-dialogs</artifactId>
            <version>RELEASE72</version>
        </dependency>
    </dependencies>
  4. Use a text editor to create the following class HelloWorldActionListener.java in the java/com/mycompany/mavenplatformmodulea directory.
    package com.mycompany.mavenplatformmodulea;
    
    import java.awt.event.ActionEvent;
    import java.awt.event.ActionListener;
    import org.openide.DialogDisplayer;
    import org.openide.NotifyDescriptor;
    import org.openide.awt.ActionID;
    import org.openide.awt.ActionReference;
    import org.openide.awt.ActionRegistration;
    import org.openide.util.NbBundle.Messages;
    
    @ActionID(category = "Window",
    id = "com.mycompany.mavenproject2.HelloWorldActionListener")
    @ActionRegistration(displayName = "#CTL_HelloWorldActionListener")
    @ActionReference(path = "Menu/Window", position = 0)
    @Messages("CTL_HelloWorldActionListener=Hello World")
    public final class HelloWorldActionListener implements ActionListener {
    
        public void actionPerformed(ActionEvent e) {
            NotifyDescriptor d = new NotifyDescriptor.Message("hello...");
            DialogDisplayer.getDefault().notify(d);
        }
    
    }
  5. On the command line, navigate to the mavenPlatformModuleA directory and run the following command to build and install the module in the local repository.
    mvn install

    When you run the install command, Maven builds the module and copies the JAR and NBM artifacts to the local repository.

Now that the artifact is in the local repository, you can add the artifact as a dependency of the NetBeans Platform application, as shown in the next section.

Adding the New NetBeans Module as a Dependency

In this section you will add the module as a dependency of the NetBeans Platform application by declaring the dependency in the POM of the application project.

  1. Open the pom.xml file in the application directory in a text editor.
  2. Declare the mavenPlatformModuleA module as a dependency of the application by making the following changes (in bold) to the POM.
    <dependencies>
        <dependency>
            <groupId>org.netbeans.cluster</groupId>
            <artifactId>platform</artifactId>
            <version>${netbeans.version}</version>
            <type>pom</type>
        </dependency>
        <dependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>mavenPlatformApp-branding</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>com.mycompany</groupId>
            <artifactId>mavenPlatformModuleA</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!-- NbModuleSuite functional in RELEASE70 or later: -->
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-netbeans-modules-nbjunit</artifactId>
            <version>${netbeans.version}</version>
            <scope>test</scope>
        </dependency>
        <!-- To use Jelly Tools in your functional tests, add or replace with:
        <dependency>
            <groupId>org.netbeans.api</groupId>
            <artifactId>org-netbeans-modules-jellytools-platform</artifactId>
            <version>${netbeans.version}</version>
            <scope>test</scope>
        </dependency>
        -->
    </dependencies>

Building the NetBeans Platform Application With the New NetBeans Module

You are now almost ready to launch the NetBeans Platform application with the new module installed. You first need to make sure that the new module is specified as a module of the parent POM project. You can then repeat the steps to build and launch the application.

  1. Open the pom.xml in the mavenPlatformApp directory in a text editor.
  2. Confirm that the new module is specified in the list of modules that are included with the application.
    <modules>
        <module>branding</module>
        <module>application</module>
        <module>mavenPlatformModuleA</module>
    </modules>
  3. Navigate to the mavenPlatformApp directory in the command line terminal and type the following command to build the project.
    mvn install

    When you run the command, you can see that the new module is included in the list of modules.

    [INFO] ------------------------------------------------------------------------
    [INFO] Reactor Summary:
    [INFO]
    [INFO] mavenPlatformApp-parent ........................... SUCCESS [0.144s]
    [INFO] mavenPlatformApp-branding ......................... SUCCESS [2.044s]
    [INFO] mavenPlatformModuleA .............................. SUCCESS [0.491s]
    [INFO] mavenPlatformApp-app .............................. SUCCESS [7.790s]
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 11.724s
    [INFO] Finished at: Sun Sep 16 00:00:00 CEST 2012
    [INFO] Final Memory: 16M/226M
    [INFO] ------------------------------------------------------------------------
  4. Navigate to the application directory and type the following command to launch the application.
    mvn nbm:run-platform

    When you run the command, Maven will launch the application with the new module.

You have now successfully added a new module to the application and launched the application. To confirm that the module was loaded when the application launched, choose Window > Hello World from the main menu of the application to display the greeting:
Screenshot of Message Dialog Screenshot of Message Dialog

This tutorial demonstrated how you can use the Maven command line to create NetBeans Platform applications. For more examples on how to build NetBeans Platform applications and modules, see the tutorials listed in the NetBeans Platform Learning Trail.

 

See Also

This document described how to use the Maven build framework to create a new NetBeans Platform application without using NetBeans IDE. For more information about creating and developing applications, see the following resources.

If you have any questions about the NetBeans Platform, feel free to write to the mailing list, dev@platform.netbeans.org, or view the NetBeans Platform mailing list archive.

Project Features

Project Links

About this Project

Platform was started in November 2009, is owned by Antonin Nebuzelsky, and has 138 members.
By use of this website, you agree to the NetBeans Policies and Terms of Use (revision 20140418.2d69abc). © 2013, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo
 
 
Close
loading
Please Confirm
Close