【ArcGIS SOE】01开发服务器对象扩展概述

本文主要是介绍【ArcGIS SOE】01开发服务器对象扩展概述，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

ArcObjects API for developing SOEs

可以通过实现com.esri.arcgis.server.IServerObjectExtension接口来定义服务器对象扩展。

对于SOE，此接口是必需的，并且包括两个方法：init（）和shutdown（）。服务器对象使用此接口来管理SOE的生存期。服务器对象创建SOE并调用init（）方法，并通过ServerObjectHelper参数将对它的引用交还给服务器对象。ServerObjectHelper在服务器对象上实现了一个弱引用，该引用不受垃圾收集器的保护。该扩展可以在服务器对象帮助器上保留强引用（例如，在成员变量中），但是不建议这样做，因为强引用会导致不必要的对象保留在内存中并影响性能。扩展应该从服务器对象帮助器获取服务器对象，以便在服务器对象上进行任何方法调用，然后在进行方法调用后释放引用。

创建SOE实例后，将一次调用init（）方法。像init（）方法一样，shutdown（）方法仅被调用一次，并通知SOE服务器对象的上下文正在关闭并且即将消失。作为响应，SOE应该在服务器对象帮助器上释放其引用。任何日志条目仅是信息性的，是可选的。有关SOE日志记录的信息，请参见“日志记录消息”主题。

SOE annotations

在Java SOE内部使用注释来指示Java类是ArcGIS扩展，并保存ArcGIS for Server在运行时部署和管理SOE所需的元数据。在ArcGIS 10.1及更高版本中，Java SOE支持两种类型的注释：

@ArcGIS Extension

@ArcGISExtension批注指示带批注的接口或类作为ArcGIS扩展自动显示给ArcGIS平台。该@ ArcGISExtension注解用于由ArcGIS作为一种您的接口和类作为扩展，而不需要嵌入一些外部源的任何配置或API调用相关联。以下是带注释的SOE的接口和类的示例：

// Custom Interface
@ArcGISExtension
interface ISoeInterface{public String mySoeFoo();
}
// SOE class
@ArcGISExtension
public class test01 implements IServerObjectExtension,ISoeInterface {// IServerObjectExtension methodspublic 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 methodpublic String mySoeFoo(){return "some string";}}

此批注是必需的，并且缺少它会导致SOE的Java类在部署时对于ArcGIS for Server不可见。因此，该SOE在运行时将不存在。

@ServerObjectExtProperties

SOE需要@ServerObjectExtProperties批注来保存将SOE部署为地图服务的扩展时提供给ArcGIS for Server的名称/值对。

支持以下元素对：

displayName-这是当用户在ArcGIS for Server管理客户端（例如ArcGIS Server管理器）和ArcMap中的“目录”窗口中将其启用为功能时，SOE将具有的显示名称。这个名字可以有空格。
说明-用于更详细，更友好地描述您的SOE，并将显示在ArcGIS for Server管理客户端中，以帮助管理员了解SOE的用法。
属性-在这里可以定义SOE的属性。例如，如果SOE允许编辑层，则属性值可以指示哪个层可用于编辑，从而使管理员可以控制SOE的运行时间使用/行为。
allSOAPCapabilities-将SOE作为Web服务公开时，可以创建可由ArcGIS for Server管理员启用或禁用的功能。这种功能称为“网络功能”。此参数的值是一个逗号分隔的列表，其中包含SOE公开的所有功能。
defaultSOAPCapabilites-此参数的值列出了默认情况下在SOE上启用的所有Web功能。

以下代码段演示了上述注释和可用属性及其值的使用：

@ServerObjectExtProperties(displayName = "my soe",description = "my frist SOE",properties = {"property1Name=property1Value","property2Name=property2Value"},defaultSOAPCapabilities = {"myWebCapability1"},allSOAPCapabilities = {"myWebCapability1", "myWebCapability2"}
)// SOE class
@ArcGISExtension
public class test01 implements IServerObjectExtension,ISoeInterface {// IServerObjectExtension methodspublic 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 methodpublic String mySoeFoo(){return "some string";}}

Interfaces and classes

以下是您的SOE内部特定行为的一些接口。

com.esri.arcgis.system.IObjectConstruct

此接口是可选的，仅当SOE需要额外的初始化（例如使用ArcGIS Server管理器中的服务器管理员定义的值初始化属性）时才需要实现。该接口包括一个称为construct（）的方法，该方法在调用IServerObjectExtension.init（）之后仅在创建SOE时被调用一次。对于具有属性的SOE，construct（）将SOE的配置属性作为属性集移交。

com.esri.arcgis.system.IObjectActivate

IObjectActivate接口是可选的（也就是说，除非您的SOE需要在处理请求之前和之后执行的特殊逻辑，否则不需要其实现）。它包括两种方法：

activate（）-每次客户端通过SOAP或REST向SOE请求时调用
deactivate（）-每次客户端获取和释放服务器对象的上下文时调用。

com.esri.arcgis.server.SOAPRequestHandler

如果计划将Java SOE公开为基于SOAP的Web服务，则您的SOE类必须扩展SOAPRequestHandler基类。如果要创建REST SOE，则不需要扩展此基类。该基类定义了IRequestHandler接口公开的handleStringRequest（）方法。该方法接收SOAP请求，从SOE类调用适当的业务方法，生成SOAP响应，然后将其返回给客户端应用程序，从而减轻了您处理SOAP请求和响应的负担，并使您可以专注于SOE的业务逻辑开发。在“开发SOAP SOE”主题中将对此进行详细讨论。

com.esri.arcgis.system.IRESTRequestHandler

如果计划将Java SOE作为RESTful Web Service，则必须实现IRESTRequestHandler接口。该接口提供两种方法：

handleRESTRequest（）-为对SOE的每个HTTP请求调用一次。
getSchema（）-在运行时由ArcGIS REST处理程序调用以查询SOE的资源和操作层次结构。

ArcGIS Java ArcObjects软件开发套件

ArcGIS for Server随附有ArcGIS Java ArcObjects软件开发工具包（Java AO SDK），但是单独安装的。该SDK包括以下内容：

Eclipse IDE插件
这些插件有助于使用Java ArcObjects API来开发自定义应用程序和扩展。其中包括：
- 用于创建自定义SOAP和REST SOE，自定义地理处理工具，自定义渲染器，要素类扩展和加载项的向导。
- 可用于生成部署工件的工具，例如各种Java扩展的jar文件。
  
  有关为Eclipse安装ArcGIS插件的说明，请参阅“开发桌面应用程序”->“使用ESRI Eclipse插件”->“安装ESRI插件”。
样品
文件

这篇关于【ArcGIS SOE】01开发服务器对象扩展概述的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！