ArcGIS Engine Developer Guide

JAVA APPLICATION PROGRAMMING INTERFACE
On Windows, your path should include ...\ArcGIS\bin.
ESRI recommends setting an ARCENGINEHOME environment variable.
Although this is not a requirement to use the ArcGIS Engine Developer Kit, the
developer samples all use this variable to ensure your class path settings are accurate.
On Solaris and Linux, ARCENGINEHOME and all required ArcGIS paths are
set by sourcing one of the init_engine scripts.
• When using C-shell, use this command:
source /path/to/arcgis/init_engine.csh
• When using bash or bourne shell, use this command instead:
source /path/to/arcgis/init_engine.sh
Setting the ARCENGINEHOME variable on Windows:
ARCENGINEHOME=[path to ArcGIS install directory]
For example:
ARCENGINEHOME=c:\ArcGIS
Editing the path enables your system to use the native resource libraries that ship
with the ArcGIS Engine Runtime. Edit the PATH directory to include the
jre\bin directory of ARCENGINEHOME.
On Windows:
PATH=...;%ARCENGINEHOME%\java\jre\bin
Class path
The ArcGIS API for Java provides Java Archive (JAR) files and the native
runtime libraries. These JAR files are located on disk at
%ARCENGINEHOME%\java on Windows and $ARCENGINEHOME/java
on Solaris and Linux.
All Java applications built with any of the ArcGIS developer kits must have the
jintegra.jar file referenced in the respective application’s class path. This file
contains all of the class files for the runtime library that handle interoperability to
COM.
In addition, individual arcgis_xxx.jar files should be added to your class path as
needed. For example, applications that leverage the PageLayout bean included
with ArcObjects require that the arcgis_pagelayoutbean.jar file be added to the
class path.
As an optional convenience, you can use the JARs in
%ARCENGINEHOME%\java\opt or $ARCENGINEHOME/java/opt instead
of a long list of arcgis_xxx.jar files. These two convenience JARs are:
• arcobjects.jar—contains all of the non-UI class files in one complete archive.
• arcgis_visualbeans.jar—contains all of the UI class files in one complete
archive.
ANT
The ArcGIS SDK for Java includes numerous sample applications, each of which
is delivered with ANT scripts. ANT is a Java-based build tool that uses build
Chapter 4 • Developer environments • 183