Install the SDK

Start here to install and set up ArcGIS Runtime SDK for Java. You can install multiple versions of this software development kit (SDK) on the same machine. You can also install ArcGIS Runtime SDK for Java on the same machine as ArcGIS Runtime SDK for WPF or ArcGIS Runtime SDK for Qt.

Install the SDK on Windows

  1. Make sure your development machine meets the system requirements.
  2. Download and extract the SDK. Download the SDK for your operating system from the Downloads page.
  3. Install the Eclipse integrated development environment (IDE) before installing this SDK. For a list of supported IDEs, see the system requirements.
  4. Double-click the Setup.exe file at the top level of the extracted files you downloaded in step 2 to start the installation wizard. The ArcGIS Runtime SDK for Java installation wizard appears.
  5. Click Next.
  6. Follow the on-screen instructions. In the Select Features panel, you can change the default installation directory by clicking the Change button, then navigating to the desired directory. Make sure this directory is on your development machine and that you have write permissions to this directory. Ensure no other users are using the directory.
  7. On the last panel of the wizard, click Finish. The ArcGIS Runtime SDK for Java is now installed at the installation directory you chose in the previous step. You are now ready to install the Eclipse plug-in.

Install the SDK on Linux

  1. Make sure your development machine meets the system requirements.
  2. Download the SDK to a location from which the setup program can be run, typically the home folder of the developer installing the SDK. Download the SDK for your operating system from the Downloads page.
  3. Install the Eclipse integrated development environment (IDE) before installing this SDK. For a list of supported IDEs, see the system requirements.
  4. Double-click the Setup shell script, Setup.sh, located in the download location. Run it directly or in a terminal. The ArcGIS Runtime SDK for Java installation wizard appears.
  5. Click Next.
  6. Follow the on-screen instructions. In the Select Features panel, you can change the default installation directory by clicking the Change button, then navigating to the desired directory. Make sure this directory is on your development machine and that you have write permissions to this directory. Ensure no other users are using the directory.
  7. On the last panel of the wizard, click Done. ArcGIS Runtime SDK for Java is now installed at the installation directory you chose in the previous step. You are now ready to install the Eclipse plug-in.
  8. The ArcGIS Runtime SDK for Java environment variables can be set using a shell script and one of three options, as described in the following section.

Set ArcGIS Runtime SDK for Java environment variables

The ArcGIS Runtime SDK for Java environment variables can be set on your Linux machine using a shell script and one of the three options described in this section:

  • For all users logging in.
  • For an individual user logging in.
  • Each time a user needs to use the SDK, for example, for all programs executed from a single terminal session.

For all users logging in

Copy the SDK initialization scripts (both init_sdk_java.sh and init_sdk_java.csh) from <installation directory>/java10.2.4 to /etc/profile.d :

$ sudo cp <installation directory>/java10.2.4/init_sdk_java.sh /etc/profile.d
$ sudo cp <installation directory>/java10.2.4/init_sdk_java.csh /etc/profile.d

For an individual user logging in

  1. Add the contents of the SDK initialization script to the ${HOME}/.bashrc and ${HOME}/.cshrc file.
    $ cat <installation directory>/java10.2.4/init_sdk_java.sh >> ${HOME}/.bashrc
    $ cat <installation directory>/java10.2.4/init_sdk_java.csh >> ${HOME}/.cshrc
  2. Reboot the machine and have the user log in. Use the export command, and verify that the ArcGIS Runtime SDK environment variables are present.
  3. Start all applications that are dependent on ArcGIS Runtime SDK for Java from anywhere in the user's environment.

For a single terminal session

  1. Start the terminal.
  2. Decide which shell script is appropriate for the environment. You can determine the current shell by using the following command:
    $ echo ${SHELL}
  3. If the shell is bash or sh, then source init_sdk_java.sh.
    $ source <installation directory>/java10.2.4/init_sdk_java.sh
  4. If the shell is csh or tcsh, then source init_sdk_java.csh.
    $ source <installation directory>/java10.2.4/init_sdk_java.csh
  5. Use the export command; verify that the ArcGIS Runtime SDK environment variables are present.
  6. Start all applications that are dependent on ArcGIS Runtime SDK for Java from this terminal. Also start Eclipse from this terminal if Eclipse is to open ArcGIS Runtime SDK for Java applications.