Overview of developing server object extensions

In this topic

• ArcObjects API for developing SOEs
• SOE annotations
• Interfaces and classes
• ArcGIS Java ArcObjects Software Development Kit
• Eclipse IDE wizards for SOE development and export

ArcObjects API for developing SOEs

 

 

This interface is mandatory for SOEs, and includes two methods: init() and shutdown(). This interface is used by the server object to manage the lifetime of the SOE. The server object creates the SOE and calls the init() method, handing it back a reference to the server object via the ServerObjectHelper argument. The ServerObjectHelper implements a weak reference, one that is not protected from  the garbage collector, on the server object. The extension can keep a strong reference on the server object helper (for example, in a member variable), but this is not recommended as a strong reference can cause unnecessary objects to remain in memory and hinder performance. An extension should get the server object from the server object helper in order to make any method calls on the server object, then release the reference after making the method calls.

 

The init() method is called once, when the instance of the SOE is created. Like the init() method, the shutdown() method is called only once and informs the SOE that the server object's context is being shut down and is about to go away. In response, the SOE should release its reference on the server object helper. Any log entries are merely informative and are optional. For information about SOE logging, see the “Logging messages” topic.

SOE annotations

@ArcGIS Extension

// Custom Interface
@ArcGISExtension public interface ISoeInterface{
    public String mySoeFoo();
}

// SOE class
@ArcGISExtension public class SOE implements IServerObjectExtension, IMySoeInterface{
    // IServerObjectExtension methods
    public void init(IServerObjectHelper arg0)throws IOException,
        AutomationException{
        // Called once when the instance of the SOE is created
    }
    public void shutdown()throws IOException, AutomationException{
        // Called once when the SOE’s context is shut down
    }

    //IMySoeInterface method
    public String mySoeFoo(){
        return "some string";
    }
}

@ServerObjectExtProperties

• displayName—This is the display name your SOE will have when users enable it as a capability in an ArcGIS for Server administrative client such as ArcGIS Server Manager and  the Catalog window in ArcMap. This name can have spaces. 
• description—This is used to describe your SOE in a more detailed and user-friendly manner, and will show up in an ArcGIS for Server administrative client to help administrators understand the usage of your SOE.
• properties—This is where you can define properties on your SOE. For example, if an SOE allows editing of a layer, a property value could dictate which layer would be available for editing, thus giving the administrator control over run time usage/behavior of the SOE.
• allSOAPCapabilities—When exposing your SOE as a web service, you can create functionality that can be enabled or disabled by an administrator of ArcGIS for Server. Such functionality is called a “web capability”. This parameter’s value is a comma-separated list that holds all capabilities exposed by an SOE.   
• defaultSOAPCapabilites—This parameter’s value lists all web capabilities that are enabled on the SOE by default. 
  

// SOE class
@ArcGISExtension 

@ServerObjectExtProperties(displayName = "My SOE", description = "My first SOE",
    properties = {
    "property1Name=property1Value", "property2Name=property2Value"
}

, defaultSOAPCapabilities = {
    "myWebCapability1"
}

, allSOAPCapabilities = {
    "myWebCapability1", "myWebCapability2"
}

)public class SOE implements IServerObjectExtension, IMySoeInterface{

    public void init(IServerObjectHelper arg0)throws IOException,
        AutomationException{
        // Called once when the instance of the SOE is created
    }

    public void shutdown()throws IOException, AutomationException{
        // Called once when the SOE’s context is shut down
    }

    //IMySoeInterface method
    public String mySoeFoo(){
        return "some string";
    }

}

Interfaces and classes

com.esri.arcgis.system.IObjectConstruct

com.esri.arcgis.system.IObjectActivate

com.esri.arcgis.server.SOAPRequestHandler

com.esri.arcgis.system.IRESTRequestHandler

ArcGIS Java ArcObjects Software Development Kit

Eclipse IDE wizards for SOE development and export