Get started

There are a number of ways to get started to develop with the Maps SDK for Java. If you are new, follow the steps below to get started with Java and IntelliJ IDEA.

1. Sign up for an account

To use the ArcGIS Maps SDK for Java to access content, services, or an organization, you need an ArcGIS Developer account, ArcGIS Online account, or ArcGIS Enterprise account. The type of account, user type, and role you need depends on the resource you need to access and the operations you wish to undertake.

If you do not have an account, select one of the options below:

2. Get the SDK and dependencies

To use the ArcGIS Maps SDK for Java you need to:

Install a supported JDK

1. Download a JDK, filtering for your operating system, architecture, and version.
2. Use the installation guide and follow the instructions.

Install a Java IDE with Gradle integrated

1. Download IntelliJ IDEA Community Edition.
2. On the left of the download page, click installation instructions and follow them.

Get the ArcGIS Maps SDK for Java and dependencies

1. Expand the accordion below: Gradle build script.
2. Copy the script into your Java project's build.gradle file.
3. Reload the build script and execute the run task to download and unpack the API dependencies.

For additional considerations, go to Install and set up.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
plugins {
    id 'application'
    id 'org.openjfx.javafxplugin' version '0.0.14'
    id 'idea'
}

idea {
    module {
        downloadJavadoc = true
    }
}

ext {
    arcgisVersion = '200.2.0'
}

repositories {
    mavenCentral()
    maven {
        url 'https://esri.jfrog.io/artifactory/arcgis'
    }
}

configurations {
    natives
}

dependencies {
    implementation "com.esri.arcgisruntime:arcgis-java:$arcgisVersion"
    natives "com.esri.arcgisruntime:arcgis-java-jnilibs:$arcgisVersion"
    natives "com.esri.arcgisruntime:arcgis-java-resources:$arcgisVersion"
    // handle SLF4J http://www.slf4j.org/codes.html#StaticLoggerBinder using a no-operation logger
    implementation "org.slf4j:slf4j-nop:2.0.7"
}

javafx {
    version = "17.0.8"
    modules = [ 'javafx.controls', 'javafx.graphics', 'javafx.fxml', 'javafx.web', 'javafx.media' ]
}

task copyNatives(type: Copy) {
    description = "Copies the arcgis native libraries into the .arcgis directory for development."
    group = "build"
    configurations.natives.asFileTree.each {
        from(zipTree(it))
    }
    into "${System.properties.getProperty("user.home")}/.arcgis/$arcgisVersion"
}

run {
    dependsOn copyNatives
}

3. Get an access token

To access secure ArcGIS services and resources, you need to use an access token. The easiest way to get started is to create an API key. Learn more about access tokens and authentication in Security and authentication.

4. Create your first mapping application

Follow the step-by-step instructions in the display a map tutorial to create your first mapping application. The following code shows how you can create and display a map.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
// Authenticate with an API key or named user is required to access basemaps
// and other location services.
ArcGISRuntimeEnvironment.setApiKey(yourAPIKey);

// Create a map with the standard imagery basemap style.
ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_IMAGERY_STANDARD);


// Create a new MapView object.
mapView = new MapView();
// Set the MapView with the map.
mapView.setMap(map);

Once you are done building your application, make sure to license it before deploying to production. For more information, see License and deployment topic for details.

5. Follow the tutorials

Go to the tutorials to create and run applications to perform different operations.

Display a web map

Display a preauthored map stored as an ArcGIS Online portal item.

Add a point, line, and polygon

Learn how to display a point, line, and polygon graphic in a map.

Access services with OAuth 2.0

Learn how to authenticate a user to access a secure ArcGIS service with OAuth 2.0.

6. Explore the samples

Go to the samples to learn how to perform more tasks with the API.

OAuth

Authenticate with ArcGIS Online (or ArcGIS Enterprise) using OAuth2 to access secured resources.

Add features

Add features to a feture layer.

Add dynamic entity layer

Display data from an ArcGIS stream service using a dynamic entity layer.

Find route

Display directions for a route between two points.

Next steps

• Overview

  Learn about the API and developer resources.

• Key features

  Discover the capabilities of the API.

• Get started

  Get started using the API.