Migrating to a New STK Java API Release

Each release of the STK Java API undergoes additions and improvements from previous versions. Every effort is taken to provide a backward compatible API that requires little to no changes by the end user application. However, to provide the best possible product sometimes changes are necessary, including breaking compilation and runtime changes. This page provides a list of instructions to successfully migrate your STK Java API application to a newer release.

Before beginning, please read the What Is New page for the STK Java API to familiarize yourself with the changes between releases.

Migration list

STK Java API 13.0

Eclipse project migration
Standalone environment migration

STK Java API 12.0

Eclipse project migration
Standalone environment migration

STK Java API 11.5

agi.ntvapp.jar migration

STK Java API 11.0

Eclipse project migration
Standalone environment migration

STK Java API 10.0

Eclipse project migration
Standalone environment migration

STK Java API 9.2.1

Eclipse project migration
Standalone environment migration

STK Java API 9.2

Eclipse project migration
Standalone environment migration

STK Java API 9.1

Eclipse project migration
Standalone environment migration

STK Java API 9.0

Eclipse project migration
Standalone environment migration

STK Java API 8.1.x

Eclipse project migration
Standalone environment migration

STK Java API 13.0

Eclipse project migration

Windows 64bit
Assuming your STK / STK Engine 13.0 installation is located at the default installation directory of C:\Program Files\AGI\STK_ODTK 13
- Update the Eclipse Java application project Jar libraries with those files in C:\Program Files\AGI\STK_ODTK 13\bin directory.
- Update any references to agi.stk.ui.application.jar to agi.ui.application.jar and references to agi.stk.ui.core.jar to agi.ui.core.jar in the Eclipse Java application project.
- Update the Eclipse Java application project JNI libraries with those files in C:\Program Files\AGI\STK_ODTK 13\bin directory.
- Update any refrences to AgJNIStkUiApplication.dll to AgJNIUiApplication.dll and references to AgJNIStkUiCore.dll to AgJNIUiCore.dll in the Eclipse Java application project.

Standalone environment migration

Windows 64bit

Assuming your STK / STK Engine 13.0 installation is located at the default installation directory of C:\Program Files\AGI\STK_ODTK 13

Update the Java application standalone CLASSPATH environment variable with the Jar libraries with those files in C:\Program Files\AGI\STK_ODTK 13\bin directory.
Update any references to agi.stk.ui.application.jar to agi.ui.application.jar and references to agi.stk.ui.core.jar to agi.ui.core.jar in the Java application standalone CLASSPATH environment variable.

Update the Java application standalone PATH environment variable with the JNI libraries with those files in C:\Program Files\AGI\STK_ODTK 13\bin directory.
Update any refrences to AgJNIStkUiApplication.dll to AgJNIUiApplication.dll and references to AgJNIStkUiCore.dll to AgJNIUiCore.dll in the Java application standalone PATH environment variable.

STK Java API 12.0

Eclipse project migration

Windows 64bit
Assuming your STK / STK Engine 12.0 installation is located at the default installation directory of C:\Program Files\AGI\STK 12
- Update the Eclipse Java application project Jar libraries with those files in C:\Program Files\AGI\STK 12\bin directory.
- Update the Eclipse Java application project JNI libraries with those files in C:\Program Files\AGI\STK 12\bin directory.

Standalone environment migration

Windows 64bit

Assuming your STK / STK Engine 12.0 installation is located at the default installation directory of C:\Program Files\AGI\STK 12

Update the Java application standalone CLASSPATH environment variable with the Jar libraries with those files in C:\Program Files\AGI\STK 12\bin directory.
Update the Java application standalone PATH environment variable with the JNI libraries with those files in C:\Program Files\AGI\STK 12\bin directory.

STK Java API 11.5

agi.ntvapp.jar migration

The agi.ntvapp.jar ALPHA library and several that depend on it have been removed from the STK Engine release. The full list of removed libraries:

agi.ntvapp.jar
agi.ntvapp.swing.jar
agi.ondemand.jar
agi.stkengine.swing.jar

Take the following steps to update your code for the removal of the libraries:

Update any classes that extends CustomApplicationSTKEngineSampleBaseJFrame to instead extend CustomApplicationSTKSampleBaseJFrame or another suitable JFrame class.
Remove any code calling getStkEngineJPanel().add and replace it with code adding your Globe, Map or GfxAnalysis control to the ContentPane or another suitable panel.
Remove IAgNtvAppEventsListener and move any initialization and uninitialization code called from onAgNtvAppEvent to appropriate places in your code. Typically the constructor for initialization and windowClosing for uninitialization.
Remove any calls to getStkEngine(). Instead add a AgSTKXApplicationClass and AgStkObjectRootClass property to your class and initialize them in the constructor or where appropriate for your application.

If the above changes are not feasible for your application then the source code for the removed libraries has be moved to the AWT_STK_Graphics_Globe_OverlayToolbar code sample. You can either merge the code into your application or use the build.xml ant script provided with the sample to generate agi.applet.jar which combines all four removed libraries into a single jar file.