Build SOIs using IntelliJ

This topic describes how to create, build, and deploy a server object interceptor (SOI) under the Maven framework using IntelliJ. It also describes how to consume the SOI from the ArcGIS Server Services Directory.

  1. Create the SOI project
  2. Build the SOI project
  3. Deploy the SOI and testing the SOI's functions

The SOI that you will create in this topic is also provided as a sample, named Simple SOI in the ArcGIS Enterprise SDK(..\EnterpriseSDK\Samples\Java\serverobjectinterceptors\SimpleSOI).

Create the SOI project

To create an SOI using IntelliJ, complete the following steps:

  1. Ensure that ArcGIS Enterprise SDK, Java, and Maven are all installed on your development environment. See more details at the installation section.

  2. Launch IntelliJ and choose Create New Project. The New Project wizard appears.

  3. Choose Maven on the left menu. Check the Create from archetype checkbox.

  4. If the soi-archetype has 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:

    • GroupId: com.esri.arcgis.enterprise.sdk
    • ArtifactId: soi-archetype
    • Version: 10.9.1 (use 10.9.0 for 10.9 SDK and 10.8.1 for 10.8.1 SDK)
    building soi intellij1

Other SOE and SOI archetypes will also be automatically picked up and show up next time when you choose Create from archetype.

  1. The soi-archetype is now added. Select this archetype and click Next.

Note: Ensure that Project SDK is set to use the supported JDK before you proceed.

building soi intellij2
  1. Enter the information in the parameters below and click Next:

    building soi intellij3
    • Name — simplesoi
    • GroupId — entsdksamples.soi
    • ArtifactId — simplesoi
  2. Click the + button on the right. Add a Maven property soiName with the value JavaSimpleMapSOI. Click OK.

Note: You must add the soiName property, which is a required property used for the SOI's class name, otherwise the SOI project can't be built.

building soi intellij4
  1. Ensure Maven home directory is set to use the supported Maven and the soiName property is added. Click Finish.

  2. A new SOI project is created. You should see Build Success on 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 entsdksamples.soi package and JavaSimpleMapSOI class under the src\main\java folder. You will address those warnings during project build. Continue to build the SOI project now.

building soi intellij5

Build the SOI project

Building an SOI 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 SOI. Read more about project build.

You can build the SOI project in either the Maven tool window or the Terminal tool window.

building soi intellij6

Because the project is created from soi-archetype, it automatically loads the boilerplate code that implements a ready-to-use SOI. For now, you can customize the displayName and description of the SOI and leave the rest of the code as is for now.

  1. Open the SOI class JavaSimpleMapSOI, located in the src\main\java folder (see A in the example above).

  2. Set the displayName and description to be Java Simple SOI (see B).

  3. 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).

      b. Expand simplesoi. 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.

      c. Type mvn clean install. This command does a clean build of the project, and you should see Build Success.

  4. Once the build finishes, a new folder named target appears in the project's base directory, and you can find the SOI file simplesoi.soe in 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.

Deploy the SOI and testing the SOI's functions

To deploy and test the Simple SOI's functions, follow the instructions at Audit requests in SOIs.

Also See


Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.