Build REST SOEs using IntelliJ
This topic describes how to create, build, and deploy a REST server object extension (SOE) under the Maven framework using IntelliJ. It also describes how to consume the SOE from the ArcGIS Server Services Directory.
- Create the REST SOE project
- Build the REST SOE project
- Deploy the SOE to ArcGIS Server
- Consume the REST SOE
The SOE that you will create in this topic is also provided as a sample, named Simple REST SOE in the ArcGIS Enterprise SDK(
To create a REST SOE using IntelliJ, complete the following steps:
Ensure that ArcGIS Enterprise SDK, Java, and Maven are all installed on your development environment. See more details at the Installation section.
Launch IntelliJ and choose Create New Project. The New Project wizard appears.
Choose Maven on the left menu. Check the Create from archetype checkbox.
rest-soe-archetypehas already been added, skip this step.
Otherwise, click the Add Archetype button on the right, type the following values in the Add Archetype wizard, and then click OK:
10.8.1for 10.8.1 SDK)
Other SOE and SOI archetypes will also be automatically picked up and show up next time when you choose Create from archetype.
rest-soe-archetypeis now added. Select this archetype and click Next.
Note: Ensure that Project SDK is set to use the supported JDK before you proceed.
Enter the information in the parameters below and click Next:
- Name — simplerestsoe
- GroupId — entsdksamples.soe
- ArtifactId — simplerestsoe
Click the + button on the right. Add a Maven property soeName with the value
JavaSimpleRESTSOE. Click OK.
Note: You must add the soeName property, which is a required property used for the SOE's class name, otherwise the SOE project can't be built.
Ensure Maven home directory is set to use the supported Maven and the soeName property is added. Click Finish.
A new SOE project is created. You should see
Build Successon the right of the bottom Run Tool Window.
If you see any warnings, you can ignore them for now as long as the project successfully generates the
JavaSimpleRESTSOEclass under the
src\main\javafolder. You will address those warnings during project build. Continue to build the REST SOE project now.
Building an SOE project will package the project's classes, dependencies, and resources into a
.soe file, which can be deployed to ArcGIS Server. Since it's a Maven project, the Maven build lifecycle must be followed to build the REST SOE. Read more about project build.
You can build the SOE project in either the Maven tool window or the Terminal tool window.
Because the project is created from
rest-soe-archetype, it automatically loads the boilerplate code that implements a ready-to-use SOE. For now, you can customize the
description of the SOE and leave the rest of the code as is.
Open the SOE class
JavaSimpleRESTSOE, located in the
src\main\javafolder (see A in the example above).
Java Simple REST SOE(see B).
Now follow these steps to build the project.
To build the project in the Maven tool window, do the following:
a. Click the Maven tab on the right side of IntelliJ (see C).
simplerestsoe. You should see Lifecycle, Plugins and Dependencies listed.
c. If you don't see Dependencies, click the Reimport All Maven Projects button (see D) on the far left of the tool bar in the Maven tool window.
d. Now you should see Dependencies, and com.esri.arcgis.enterprise.sdk:arcgis-enterprise-sdk:version is listed as one of the dependencies.
e. Expand Lifecycle and click install. You can also click clean and click install for a clean build of the project.
f. The project is built successfully with detailed log messages in the Run tool window (see E).
Alternatively, to build the project in the Terminal tool window, do the following:
a. Click the Terminal tab at the bottom of IntelliJ (see F).
b. Ensure the directory is pointing to the project's root directory.
mvn clean install. This command does a clean build of the project, and you should see
Once the build finishes, a new folder named
targetappears in the project's base directory, and you can find the SOE file
simplerestsoe.soein this folder (see G).
If you would like to add third-party libraries as dependencies, you can add them to the project's
pom.xml (see H). The POM contains project configuration information, such as the Java compiler (JDK) used, plug-ins used, project's dependencies, and project's version. Learn more about POM dependency management.
The SOE you created must be deployed to ArcGIS Server and enabled on a map service. To learn how to deploy an SOE, see the Deploy extensions topic in the ArcGIS Enterprise SDK help. Note that the term “deploy” is used here to mean uploading the .soe file to ArcGIS Server and registering it as an extension to map services. To learn how to enable an SOE on a map service, see the Enable extensions topic of the ArcGIS Enterprise SDK help.
To consume the SOE using the Services Directory, complete the following steps:
- Open the Services Directory at
- Navigate to your map service’s root page (its URL ends with “/MapServer”) and scroll down to the Supported Extensions section.
- Click the
JavaSimpleRESTSOEhyperlink. This brings up the SOE’s root resource web page, which lists name and description of the root resource, along with the
servicepropertiessub-resource in the Child Resources section and the
getLayerCountByTypeoperation in the Supported Operations section.
- Click on the
layerssub-resource. It displays information about all layers in JSON format.
- Navigate back to the root resource page and click on the
servicepropertiessub-resource. It displays several service configuration properties.
- Navigate back to the root resource page and click on the
featurein the layerType field and click the GET button. The JSON response will include the number of feature layers. Test this operation with other types, such as
- Undeploy the SOE when you're finished. To learn how to undeploy the SOE, see the Deploy extensions topic of the ArcGIS Enterprise SDK help.