Luciad Developer Platform

This article explains how you can make LuciadLightspeed available through Apache Maven. Maven is a development project management and build automation tool. More information is available on the Maven website: http://maven.apache.org/.

Deploying to a repository

Luciad provides Project Object Model (POM) files for all libraries available in LuciadLightspeed. You can find those POM files in the build/maven/pom directory. To deploy them to your repository, run the script deploy.sh or deploy.bat in the build/maven directory. If you prefer to deploy private dependencies only, you can use the script deploy.private.sh or deploy.private.bat in the build/maven directory.

Private dependencies are:

Dependencies that aren’t available in public maven repositories.
Dependencies that are available in public maven repositories, but have a customized Luciad build, with a Luciad-specific version number.

When you run these scripts, you must give the URL and credentials to your Maven repository. The script then deploys all libraries available in your release.

The deployment script requires at least Ant 1.9.1. Ant must have access to the Maven Ant tasks library. You can give Ant access to that Maven Tasks library, either by storing it in Ant’s lib directory, by including it in the CLASSPATH environment variable, or by supplying it through the -lib command line parameter. LuciadLightspeed provides recent versions of the Maven Ant Tasks library in the build/ant directory of the LuciadLightspeed installation.

If you want support for protocols other than file and http, you can make use of Maven Wagon. See http://maven.apache.org/wagon/ for more information.

Using the Luciad libraries

You can use the Luciad libraries, like any other Maven dependency, by adding them to your project POM. We offer a number of convenience POM files that depend on all non-optional components in a LuciadLightspeed product tier: Essential, Advanced or Pro. If you have any optional components in your release, you must add POM dependencies for each of them. For more information about product tiers and their components, see LuciadLightspeed product tiers.

The available product tier POM dependencies

luciadlightspeed_essential
luciadlightspeed_advanced
luciadlightspeed_pro

Table 1. Overview of available optional components and their POM dependency name
Optional Component Name	POM Dependency Name
Aviation Standards	luciadlightspeed_aviation_standards
Database Connectors	luciadlightspeed_database_connectors
Defense Standards	luciadlightspeed_defense_standards
Defense Symbology	luciadlightspeed_defense_symbology
Google Earth Enterprise	luciadlightspeed_google_earth_enterprise
Graph and Routing Engine	luciadlightspeed_graph_and_routing_engine
Infrastructure Standards	luciadlightspeed_infrastructure_standards
Maritime Standards	luciadlightspeed_maritime_standards
OGC Server	luciadlightspeed_ogc_server
Radar Connectors	luciadlightspeed_radar_connectors
S-63	luciadlightspeed_s63
Terrain Analysis Engine	luciadlightspeed_terrain_analysis_engine
Weather & Environment Standards	luciadlightspeed_weather_environment_standards

You can put this information in your POM file to add a dependency for the LuciadLightspeed Pro tier:

Program: Adding a dependency for LuciadLightspeed Pro

    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_pro</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>

The example uses a placeholder for the LuciadLightspeed version. It’s recommended to define a Maven property for the LuciadLightspeed version as a value placeholder, to prevent an accidental mixing of versions. As a result, you only have to update the version number once, in the properties, when you upgrade to a new LuciadLightspeed version.

Adding a license

LuciadLightspeed license files aren’t automatically uploaded to the repository. You can add license files manually by means of Maven’s deploy-file goal, as in the example below.

Program: Adding a license

mvn deploy:deploy-file \
  -DgroupId=com.yourcompany \               # Do not use com.luciad.
  -DartifactId=luciadlightspeed_development_license \
  -Dversion=2021.0-20210404 \               # For instance the date that the license was received.
  -Dpackaging=jar \
  -Dfile=development.jar \
  -Durl=yourCompanyRepositoryUrl \
  -DrepositoryId=yourCompanyRepositoryId \ # Server Id to map on the <id> under <server> section of
                                           # settings.xml.
                                           # This parameter will be required for
                                           # authentication when using a remote repository.
                                           # This parameter can be omitted when using a local repo.

If you have more than one application, and each application uses a different Luciad license, you must ensure that the artifactId for each of these license files is unique.

If you are using a remote repository, you must authenticate the deploy:deploy-file command. To do so, you must define a server in your settings.xml with the necessary credentials, and pass the server ID to the command using the repositoryId parameter.

Here is an example server configuration in settings.xml:

Program: Settings.xml configuration

  <servers>
    <server>
      <id>yourCompanyRepositoryId</id>
      <url>yourCompanyRepositoryUrl</url>
      <username>username</username>
      <password>password</password>
    </server>
  </servers>

Next, in your project’s pom.xml, specify:

Program: Adding a license

    <dependency>
      <groupId>com.yourcompany</groupId>
      <artifactId>luciadlightspeed_development_license</artifactId>
      <version>${luciad.license.version}</version>
    </dependency>

Adding JavaFX dependencies for JDK 11 and above

As of version 11, JavaFX has been removed from the Java Development Kit (JDK). JavaFX is now available as a standalone release. If you use JDK 11 or higher and want to create a JavaFX application, or compile the LuciadLightspeed JavaFX samples, you must add JavaFX dependencies to your project.

In your project’s pom.xml, specify:

Program: Adding JavaFX dependencies

    <dependency>
      <groupId>org.openjfx</groupId>
      <artifactId>javafx-base</artifactId>
      <version>11</version>
    </dependency>
    <dependency>
      <groupId>org.openjfx</groupId>
      <artifactId>javafx-swing</artifactId>
      <version>11</version>
    </dependency>
    <dependency>
      <groupId>org.openjfx</groupId>
      <artifactId>javafx-controls</artifactId>
      <version>11</version>
    </dependency>
    <dependency>
      <groupId>org.openjfx</groupId>
      <artifactId>javafx-graphics</artifactId>
      <version>11</version>
    </dependency>
    <dependency>
      <groupId>org.openjfx</groupId>
      <artifactId>javafx-web</artifactId>
      <version>11</version>
    </dependency>
    <dependency>
      <groupId>org.openjfx</groupId>
      <artifactId>javafx-fxml</artifactId>
      <version>11</version>
    </dependency>
    <dependency>
      <groupId>org.openjfx</groupId>
      <artifactId>javafx-media</artifactId>
      <version>11</version>
    </dependency>

Adding an execution plugin (optional)

If you want to run Lucy from the command line, you can add this plugin configuration to your project’s pom.xml. Once you configured this plugin, you can run the LucyMapCentric application using the command mvn compile exec:java. Alternatively, you can execute any LuciadLightspeed sample by changing the mainClass in this configuration to the main class of the sample you want to execute. For example, you can switch it to samples.gxy.decoder.MainPanel to execute the GXY decoder sample.

For an explanation of the configured system properties, see the IDE integration article.

Program: Adding an execution plugin

      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>exec-maven-plugin</artifactId>
        <executions>
          <execution>
            <goals>
              <goal>exec</goal>
            </goals>
          </execution>
        </executions>
        <configuration>
          <executable>java</executable>
          <longClasspath>true</longClasspath>
          <arguments>
            <argument>-Djava.net.useSystemProxies=true</argument>
            <argument>-Dsun.awt.noerasebackground=true</argument>
            <argument>-Dsun.java2d.opengl=false</argument>
            <argument>-Dswing.aatext=true</argument>
            <argument>-Dsun.java2d.d3d=false</argument>
            <argument>-Djava.library.path=</argument>
            <argument>-Xmx2g</argument>
            <argument>-classpath</argument>
            <classpath/>
            <argument>samples.lucy.frontend.mapcentric.Main</argument>
          </arguments>
        </configuration>
      </plugin>

Setting up the sample project

The build/maven directory also contains the script files setup-sample-project.bat and setup-sample-project.sh. Running this script sets up a sample Maven project in the directory build/maven/sampleProject. This directory contains all sample source and resource files present in your release, and a pom.xml file configured to depend on all Luciad components present in your release.

In the sample project directory:

Run the command mvn compile to compile all samples.
Run mvn exec:exec to start the Lucy MapCentric.

Example POM file

This is a complete example of a pom.xml file for a project that depends on LuciadLightspeed Pro.

Expand this section to view the example POM file

Program: A complete example POM file

<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/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.yourcompany</groupId>
  <artifactId>sample-project</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>jar</packaging>
  <name>sample-project</name>
  <url>http://maven.apache.org</url>
  <repositories>
    <repository>
      <id>luciad-repo</id>
      <name>Luciad Maven Repository</name>
      <url>yourCompanyUrl</url>
    </repository>
    <repository>
      <id>mvn-central</id>
      <name>Maven Central Repository</name>
      <layout>default</layout>
      <url>https://repo1.maven.org/maven2</url>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
    </repository>
  </repositories>
  <properties>
    <luciad.version>2021.0</luciad.version>
    <luciad.license.version>2021.0-20210404</luciad.license.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
  <build>
    <resources>
      <resource>
        <directory>src/main/resources</directory>
      </resource>
    </resources>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.3</version>
        <configuration>
          <source>1.8</source>
          <target>1.8</target>
          <fork>true</fork>
          <encoding>UTF-8</encoding>
          <meminitial>512m</meminitial>
          <maxmem>2048m</maxmem>
        </configuration>
      </plugin>
      <!-- shorten argument list -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jar-plugin</artifactId>
        <version>3.2.0</version>
        <configuration>
          <archive>
            <manifest>
              <addClasspath>true</addClasspath>
            </manifest>
          </archive>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>exec-maven-plugin</artifactId>
        <executions>
          <execution>
            <goals>
              <goal>exec</goal>
            </goals>
          </execution>
        </executions>
        <configuration>
          <executable>java</executable>
          <longClasspath>true</longClasspath>
          <arguments>
            <argument>-Djava.net.useSystemProxies=true</argument>
            <argument>-Dsun.awt.noerasebackground=true</argument>
            <argument>-Dsun.java2d.opengl=false</argument>
            <argument>-Dswing.aatext=true</argument>
            <argument>-Dsun.java2d.d3d=false</argument>
            <argument>-Djava.library.path=</argument>
            <argument>-Xmx2g</argument>
            <argument>-classpath</argument>
            <classpath/>
            <argument>samples.lucy.frontend.mapcentric.Main</argument>
          </arguments>
        </configuration>
      </plugin>
    </plugins>
  </build>
  <dependencies>
    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_pro</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>
    <dependency>
      <groupId>com.yourcompany</groupId>
      <artifactId>luciadlightspeed_development_license</artifactId>
      <version>${luciad.license.version}</version>
    </dependency>
    <dependency>
      <groupId>org.openjfx</groupId>
      <artifactId>javafx-base</artifactId>
      <version>11</version>
    </dependency>
    <dependency>
      <groupId>org.openjfx</groupId>
      <artifactId>javafx-swing</artifactId>
      <version>11</version>
    </dependency>
    <dependency>
      <groupId>org.openjfx</groupId>
      <artifactId>javafx-controls</artifactId>
      <version>11</version>
    </dependency>
    <dependency>
      <groupId>org.openjfx</groupId>
      <artifactId>javafx-graphics</artifactId>
      <version>11</version>
    </dependency>
    <dependency>
      <groupId>org.openjfx</groupId>
      <artifactId>javafx-web</artifactId>
      <version>11</version>
    </dependency>
    <dependency>
      <groupId>org.openjfx</groupId>
      <artifactId>javafx-fxml</artifactId>
      <version>11</version>
    </dependency>
    <dependency>
      <groupId>org.openjfx</groupId>
      <artifactId>javafx-media</artifactId>
      <version>11</version>
    </dependency>
    <!-- Optional components available for Advanced and Pro Tiers -->
    <!--
    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_database_connectors</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>
    -->
    <!--
    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_google_earth_enterprise</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>
    -->
    <!--
    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_graph_and_routing_engine</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>
    -->
    <!--
    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_ogc_server</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>
    -->
    <!--
    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_terrain_analysis_engine</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>
    -->
    <!--
    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_weather_environment_standards</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>
    -->
    <!-- Optional components available for Pro Tier only -->
    <!--
    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_aviation_standards</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>
    -->
    <!--
    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_defense_standards</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>
    -->
    <!--
    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_defense_symbology</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>
    -->
    <!--
    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_infrastructure_standards</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>
    -->
    <!--
    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_maritime_standards</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>
    -->
    <!--
    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_radar_connectors</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>
    -->
    <!--
    <dependency>
      <groupId>com.luciad</groupId>
      <artifactId>luciadlightspeed_s63</artifactId>
      <version>${luciad.version}</version>
      <type>pom</type>
    </dependency>
    -->
  </dependencies>
</project>

Using LuciadLightspeed in a Maven repository

Deploying to a repository

Using the Luciad libraries

Adding a license

Adding JavaFX dependencies for JDK 11 and above

Adding an execution plugin (optional)

Setting up the sample project

Example POM file