component


URI

<components_uri>/{componentName}[.<format>]

支持的方法

GETPUTHEAD

父资源

components

介绍

服务组件。用户可以通过 PUT 操作对已有的服务组件配置信息进行更改。

支持的方法:

支持的表述格式:RJSON、JSON、HTML、XML。

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求,以 rjson 输出格式为例加以说明,其中,localhost 是本地服务器,“map1”是服务组件名({componentName})。

http://localhost:8090/iserver/manager/components/map1.rjson

GET 请求

获取服务组件的配置信息。

响应结构

对 component 资源执行 GET 请求,返回的资源表述的结构如下(资源表述在响应消息的实体主体里):

字段 类型 说明
config   服务配置信息。包括输出路径、输出站点和日志级别信息。
其中,地图服务组件参考MapConfig,数据服务组件参考DataConfig
providers String 使用的服务提供者或服务提供者集合的名称,可以是多个,以逗号分隔。
type String 服务组件的类型。
name String 服务组件的名称。
interfaceNames String 绑定的服务接口名称列表,以逗号分隔多个接口名称 。
disabledInterfaceNames String 停止了的服务接口名称列表,以逗号分隔。
enabled boolean 当前服务组件是否可用。默认为 true,表示可用。

其中,interfaceNames 参数用于给正在创建的服务组件绑定服务接口。SuperMap iServer 中服务组件与服务接口的对应情况请参考通过 XML 文件配置服务组件

响应示例

对服务组件 map1 资源:http://localhost:8090/iserver/manager/components/map1.rjson 执行 GET 请求,返回的 rjson 格式的表述如下:

{

    "config": {

        "clip": true,

        "logLevel": null,

        "outputPath": null,

        "outputSite": null,

        "useCache": true

    },

    "disabledInterfaceNames": "",

    "enabled": true,

    "interfaceNames": "rest",

    "name": "map1",

    "providers": "ugcMapProvider-World",

    "type": "com.supermap.services.components.impl.MapImpl"

}

PUT 请求

更改服务组件对应的配置信息。

请求参数

字段 类型 说明
config   服务配置信息。包括输出路径、输出站点和日志级别信息。
其中,地图服务组件参考MapConfig,数据服务组件参考DataConfig
providers String 使用的服务提供者或服务提供者集合的名称,可以是多个,以逗号分隔。
type String 服务组件的类型。
name String 服务组件的名称。
interfaceNames String 绑定的服务接口名称列表,以逗号分隔多个接口名称 。
disabledInterfaceNames String 停止了的服务接口名称列表,以逗号分隔。
enabled boolean 当前服务组件是否可用。默认为 true,表示可用。

其中,interfaceNames 参数用于给正在创建的服务组件绑定服务接口。SuperMap iServer 中服务组件与服务接口的对应情况请参考通过 XML 文件配置服务组件

响应结构

对 component 资源执行 PUT 请求,返回的操作结果表述的结构如下(表述在响应消息的实体主体里):

字段 类型 说明
succeed boolean 修改服务组件对应的配置信息是否成功。

 

响应示例

对 map1 服务组件资源:http://localhost:8090/iserver/manager/components/map1.rjson 执行请求体如下的 PUT 请求,添加服务提供者 ugcMapProviderSet:

{

    "enabled": true,

    "providers": "ugcMapProvider-China400,ugcMapProviderSet",

    "name": "map1",

    "config": {

        "clip": true,

        "useCache": true

    },

    "interfaceNames": "rest",

    "type": "com.supermap.services.components.impl.MapImpl",

    "disabledInterfaceNames": ""

}

则返回 rjson 格式的响应结果如下:

{"succeed": true}

 

HEAD 请求

返回跟 GET 请求一样的 HTTP 响应头,但是没有响应实体。可以在不必传输整个响应内容的情况下,获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型,字符编码,压缩编码,实体内容长度等。

HEAD 请求可以用来判断 component 资源是否存在,或者客户端是否有权限访问 component 资源。通过对加.<format>的 URI 执行 HEAD 请求,还可以快速判断 component 资源是否支持<format>格式的表述。

请参见