Developing SOAP SOEs using Java

In this topic

• About developing SOAP SOEs using Java
• Creating a SOAP SOE using the Eclipse SOE wizard
• Adding initialization and business logic to the SOE
• Implementing SOE initialization logic
• Implementing business logic for the SOAP SOE
• Implementing SOAP operations
• Exporting the SOE to a .soe file
• Deploying the SOE to ArcGIS for Server
• Consuming the SOE in a Java console application

About developing SOAP SOEs using Java

Creating a SOAP SOE using the Eclipse SOE wizard

2. Expand the ESRI templates, ArcGIS Extension, and Server folders, then find the Server Object Extension wizard.
3. Select Sever Object Extension, and click Next in the wizard to get started. This opens the New Server Object Extension wizard.  On the first page of this wizard, you'll create your Java SOE class. See the following screen shot:

4. Enter a package name and class name for your SOE.
5. Enter a display name (can contain spaces) and some user-friendly description.
6. There is an option to implement the IObjectActivate interface. This interface provides methods to invoke custom logic upon SOE creation and destruction. Since your SimpleSOAPSOE will not have any custom logic at creation or destruction time, leave this check box unchecked, and click Next. 

7. Select the SOAP Support tab.
8. Click Enable SOAP Support, enter a name for your custom interface, and click Add to have the interface added to the SOE.  An interface is required for SOAP SOEs since methods declared here will be exposed as SOAP operations and would be made accessible via SOAP after the SOE is deployed to ArcGIS for Server. A SOAP SOE can have multiple interfaces but one is sufficient for the SimpleSOAPSOE.
9. Click Finish. A dialog box may appear asking if you would like to add the ArcGIS library to your build path.  Click OK to add the required arcobjects.jar to your project’s build path.
10. Verify that the wizard generated two Java classes, one holding the custom ArcGIS extension interface, ISimpleSOAPSOE.java, and the other holding the SOE class, SimpleSOAPSOE.java.

Adding initialization and business logic to the SOE

Implementing SOE initialization logic

public class SimpleSOAPSOE extends SOAPRequestHandler implements
    IServerObjectExtension, ISimpleSOAPSOE{
    private static final long serialVersionUID = 1L;
    private ILog serverLog;
    private IMapServerDataAccess mapServerDataAccess;
    private IMapLayerInfos layerInfos;

    public SimpleSOAPSOE()throws Exception{
        super();
    }

    /**
     * init() is called once, when the instance of the SOE is created.
     */
    public void init(IServerObjectHelper soh)throws IOException, AutomationException{
        this.serverLog = ServerUtilities.getServerLogger();
        this.mapServerDataAccess = (IMapServerDataAccess)soh.getServerObject();

        IMapServer3 ms = (IMapServer3)this.mapServerDataAccess;
        IMapServerInfo mapServerInfo = ms.getServerInfo(ms.getDefaultMapName());
        this.layerInfos = mapServerInfo.getMapLayerInfos();

        serverLog.addMessage(8000, 200, "Initialized " + this.getClass().getName() +
            " SOE.");
    }

    /**
     * shutdown() is called once when the Server Object's context is being shut down and is about to go away.
     */
    public void shutdown()throws IOException, AutomationException{

        serverLog.addMessage(8000, 200, "Shutting down " + this.getClass().getName()
            + " SOE.");
        this.serverLog = null;
        this.mapServerDataAccess = null;
    }

Implementing business logic for the SOAP SOE

1. Ensure your newly generated ISimpleSOAPSOE interface looks like the following code snippet and contains no method declarations:

package arcgissamples.soe;

import com.esri.arcgis.interop.extn.ArcGISExtension;

@ArcGISExtension public interface ISimpleSOAPSOE{}

package arcgissamples.soe;

import com.esri.arcgis.interop.extn.ArcGISExtension;

@ArcGISExtension public interface ISimpleSOAPSOE{
    public int getLayerCountByType(String type)throws Exception;
}

Implementing SOAP operations

public int getLayerCountByType(String type)throws Exception{
    if (type != null && !type.isEmpty()){
        String aoType = "";
        if (type.equalsIgnoreCase("all")){
            return layerInfos.getCount();
        }
        else if (type.equalsIgnoreCase("feature")){
            aoType = "Feature Layer";
        }
        else if (type.equalsIgnoreCase("raster")){
            aoType = "Raster Layer";
        }
        else if (type.equalsIgnoreCase("dataset")){
            aoType = "Network Dataset Layer";
        }

        int count = 0;
        for (int i = 0; i < layerInfos.getCount(); i++){
            if (layerInfos.getElement(i).getType().equalsIgnoreCase(aoType)){
                count++;
            }
        }

        return count;
    }
    else{
        throw new Exception(
            "Invalid layer type provided. Available types are: \"all\", \"feature\", \"raster\", \"dataset\".");
    }
}

Exporting the SOE to a .soe file

Deploying the SOE to ArcGIS for Server

Consuming the SOE in a Java console application

1. Create an Eclipse project, and add the stubs JAR (created in your output folder by the Eclipse Export SOE wizard) to your project’s class-path.
2. Add the following jar files to the project's build path.
   $AGSSERVER/framework/lib/shared_arcgis/arcgis_agsws_stubs.jar, $AGSSERVER/framework/lib/shared_arcgis/arcgis_ws_runtime.jar, $AGSSERVER/framework/lib/shared/jsr173_1.0.jar, $AGSSERVER/framework/lib/shared/jaxb-impl-2.1.jar, $AGSSERVER/framework/lib/shared/jaxb-api-2.1.jar, $AGSSERVER/framework/lib/shared/commons-logging-1.1.1.jar, $AGSSERVER/framework/lib/shared/activation-1.1.jar, $AGSSERVER/framework/lib/shared/commons-codec-1.3.jar, and commons-httpclient-3.0.1.jar (download from Apache's website).
   
   The above jars are required for compilation and execution of SOAP client applications. The $AGSSERVER environment variable points to the directory ArcGIS Server is installed in. If ArcGIS Server is not installed locally, copy over these jars from a computer that has ArcGIS Server installed.
3. Create a Java application that uses stubs to interact with the SOAP SOE. The following code snippet shows a simple Java application that consumes a SOAP SOE using stubs from the JAR file created by the Eclipse wizard:

package arcgissamples.soe.soapclient;

import arcgissamples.soe.SimpleSOAPSOEServiceBindingStub;

public class SimpleSOAPSOEClient{
    public static void main(String[] args){
        String serviceName = "";
        String url = "http://localhost:6080/arcgis/services/" + serviceName + 
            "/MapServer/SimpleSOAPSOE";
        SimpleSOAPSOEServiceBindingStub stub = new SimpleSOAPSOEServiceBindingStub
            (url);
        stub.enableRequestResponseLogging(true);

        System.out.println("Number of Feature Layers in map service: " +
            stub.getLayerCountByType("feature"));
        System.out.println("Number of Raster Layers in map service: " +
            stub.getLayerCountByType("raster"));
        System.out.println("Number of other layers in map service: " +
            stub.getLayerCountByType("datasets"));
        System.out.println("Total number of layers in map service: " +
            stub.getLayerCountByType("all"));
    }
}