Overview

To use the X Platform's core libraries (nvx-core) you must have a license and agree to the license terms. To obtain a license:

• To obtain a free or evaluation license, visit http://license.neeveresearch.com and select the type of license you'd like to create. A license will be emailed to you with instructions.
• To purchase an unlimited license, contact your Neeve sales representative.

License Installation

You can install your license in your application's runtime environment and/or as an application resource and/or by placing it in the user home folder of the user running the JVM of the platform

Installing your license in your application's environment

1. Copy your license file to a disk location from which you will run the platform
2. Set one of the following environment variables or Java system properties to point to the license file.

• NVLICLOCATION
• nv.lic.location
• nv_lic_location

Installing your license as an application resource

Modify your application build to include xplatform.lic at the resource root i.e. /xplatform.lic (in either a jar or in your classes folder).

Installing your license in your home directory

Copy your xplatform.lic file to the home directory of the user that runs the X application(s).

A few points to note

1. You must not modify the contents of xplatform.lic or it will be rendered invalid and will fail to validate.

2. License enforcement is performed when using most libraries distributed with the platform. A failure to find a valid license file will result in System.exit(1) being called, which will terminate the JVM.

3. If multiple environment variables/system properties with the above name(s) are set, then the following rules apply:

• Environment variables take precedence over system properties.
• The precedence of property names is as listed above.

4. A license installed as an application resource will take precedence over a license installed in the user's home directory.

5. A license installed in the application's runtime environment will take precedence over a license installed as an application resource.

6. Finally, if none of the above locations specify a license, certain X tools, such as robin, will bundle a free license with an 8Gb memory limit. 

Debugging License Resolution 

To diagnose issues in license resolution you can set -Dnv.license.debug=true. Setting this property will dump a license resolution trace to System.err.

License Enforcement

The license enforcement check is done the first time one of the platform's license protected APIs is used. You may ensure that the license check has been completed by calling the following at an appropriate point in your application lifecycle.