componentSet

URI

<componentSets_URI>/{componentSetName}[.<format>]

支持的方法

GET、PUT、HEAD

父资源

componentSets

介绍

componentSet 资源标识一个服务组件集，包含了多个指向服务组件配置的引用，通过对 componentSet 资源执行 PUT 请求，可以对服务组件集的配置信息进行修改。

支持的方法：

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

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，localhost 是本地服务器，“components-rest”是服务组件集名（{componentSetName}）。

http://localhost:8090/iserver/manager/componentsets/components-rest.rjson

GET 请求

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

响应结构

对 componentSet 资源执行 GET 请求，返回的资源表述的结构如下（资源表述在响应消息的实体主体里）：  

字段 类型 说明
name String 服务组件集的名称。
settings List<ComponentSetting> 服务组件配置信息列表。即服务组件配置集合中包含的服务组件配置信息。
interfaceNames String 绑定的服务接口名称列表，以逗号分隔多个接口名称 。
disabledInterfaceNames String 停止了的服务接口名称列表，以逗号分隔。
enabled boolean 当前服务组件集是否可用。默认为 true，表示可用。

响应示例

对 components-rest 服务组件集资源：http://localhost:8090/iserver/manager/componentsets/components-rest.rjson 执行 GET 请求，返回的 rjson 格式的表述如下：

{

    "disabledInterfaceNames": "",

    "interfaceNames": "rest",

    "name": "components-rest",

    "settings": [{

        "config": {

            "clip": false,

            "logLevel": null,

            "outputPath": null,

            "outputSite": null,

            "useCache": false

        },

        "disabledInterfaceNames": "",

        "enabled": true,

        "interfaceNames": "rest,wms111,wms130,wmts100,wmts-china",

        "name": "map-world",

        "providers": "ugcMapProvider-World",

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

    },

    {

        "config": {

            "editable": true

        },

        "disabledInterfaceNames": "",

        "enabled": true,

        "interfaceNames": "rest,wfs100,wcs111,wcs112",

        "name": "data-world",

        "providers": "ugcDataProvider-World",

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

    }]

}

 

PUT 请求

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

请求参数

对 componentSet 资源执行 PUT 请求，更改服务组件集的配置信息，需要在请求体中包含以下参数：

字段 类型 说明
name String 服务组件集的名称。
settings List<ComponentSetting> 服务组件集配置信息列表。即服务组件配置集合中包含的服务组件配置信息。
interfaceNames String 绑定的服务接口名称列表，以逗号分隔多个接口名称 。
disabledInterfaceNames String 停止了的服务接口名称列表，以逗号分隔。
enabled boolean 当前服务组件集是否可用。默认为 true，表示可用。

响应结构

对 componentSet 资源执行 PUT 请求，返回的操作结果表述的结构如下（表述在响应消息的实体主体里）：  

字段 类型 说明
succeed boolean 修改操作是否成功。

响应示例

对 components-rest 服务组件集资源：http://localhost:8090/iserver/manager/componentsets/components-rest.rjson 执行请求体如下的 PUT 请求，添加服务组件 3D-sample：

{

    "name": "components-rest",

    "interfaceNames": "rest",

    "settings": [{

        "name": "map-world",

        "enabled": true

    },

    {

        "name": "data-world",

        "enabled": true

    },

    {

        "name": "3D-sample",

        "enabled": true

    }]

}

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

{"succeed": true}

HEAD 请求

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

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

请参见