Licensing and Deployment

DME Component Libraries loads and validates its license at runtime. The way this works is as follows:

• A license file named AGI.Foundation.lic (exactly) is loaded from the "root" (top level) of your application's classpath. This file is then parsed and checked for tampering, and the set of available licenses is read and used for license checking as needed.

• You are responsible for ensuring that a valid license file is available at the root of your application's runtime classpath. The easiest way to do this is to embed the license file into your application's JAR.

As previously stated, in most cases applications built with DME Component Libraries are xcopy deployable. However, Insight3D depends on the Microsoft Visual C++ Redistributable for Visual Studio 2022, which should be installed on any system where you intend to run your application. For convenience, the installer, vc_redist.x64.exe, is included in the root directory of your DME Component Libraries installation.

The ability to load the required dependencies from the application directory ("app-local") is also technically possible, but due to the complexity is not described here. Contact AGI support if you have a need to deploy Insight3D applications without an installer on systems that cannot install the redistributable.

In addition to making sure that the DME Component Libraries JARs are in your CLASSPATH, you also need to make sure that agi.foundation.graphics.native.dll is in the JVM's library path. This DLL is found in the Jars directory of the DME Component Libraries distribution.

The easiest way to make sure that the necessary files and directories are in the JVM's library path is to put them in the current working directory from which you launch your application. In Eclipse, that can be accomplished by putting them directly into the root of your Eclipse project. Alternatively, you can specify the library path explicitly when launching the JVM from the command-line:

java -Djava.library.path=c:\path\to\directory\containing\agi.foundation.graphics.native.dll

Additionally, certain Insight3D features require third-party functionality from separate DLLs. Specifically, using videos as 2D textures requires FFmpeg video processing libraries (avcodec-58.dll, avformat-58.dll, avutil-56.dll, swresample-3.dll, swscale-5.dll), and MrSID imagery requires the LizardTech MrSID DSDK (Altidsdk_9.5.dll, Alb.dll).

These separate DLLs will be loaded when needed at runtime from the same directory as the Insight3D library (agi.foundation.graphics.native.dll).

Alternatively, if you don't use any functionality in Insight3D that requires the separate DLLs, you can skip this.

The TIREM library includes an implementation named TiremPropagationModel which uses a native library to perform the calculation. As a result, use of this functionality requires dependencies to be installed on the system.

See the TIREM topic for more information.

In certain advanced scenarios, the simple embedding of your license file may not be suitable. These include:

• You are building a plugin for an application that may end up loading multiple plugins that use DME Component Libraries (yours and others) into the same classpath. In this case, the Licensing subsystem may discover the licenses embedded by the wrong plugin and fail at runtime.

The alternate licensing process is to call the Licensing.activateLicense method near the start of your application, before using any other DME Component Libraries functionality. This requires that you manually embed the contents of your license file(s) in your application so that they can be accessed as a string at runtime and passed to the activateLicense method. Because AGI license files are XML, you can simply paste the contents into your source code as a string. For example:

Licensing.activateLicense(
        "<License>" +
        "  <Field name='Name'>Example Customer</Field>" +
        "  <Field name='Company'>Example Company</Field>" +
        "  <Field name='Note'>Not a Real License</Field>" +
        "  <Component name='Nonexistent Analysis Library' />" +
        "  <Signature>Q55ubmOJvPB1NlkN6R4QRkpH6s2wbc7cB/Z/Xdefzq1QvUDdKfQ6e1ZbJq7g7piGp4OCQV/ON0MycHhIw06xLNDCJxsNnq+yqdqpb1yBq9JXQb81jU2ogZDxowRCsXil3OR1fs0qENGW7LqE4JHcT/XudbTSWaQpIl6iRfWW0Do=</Signature>" +
        "</License>");

The activateLicense method can be called multiple times, and the available licenses will be the "best superset" of the licenses supplied in all calls.

The table below is a complete list of all libraries and the licenses required by each. In most cases, each library requires a single license, plus licenses for all libraries it depends upon. However, there are some cases where some classes require an additional license beyond those of the rest of the library. These cases are listed below as well.