《中国电信qchat业务终端参数配置接口技术要求群组数据分册.doc》由会员分享，可在线阅读，更多相关《中国电信qchat业务终端参数配置接口技术要求群组数据分册.doc（81页珍藏版）》请在三一办公上搜索。
1、中国电信Qchat业务终端参数配置接口技术要求群组数据分册（征求意见稿）中国电信股份有限公司广州研究院二零壹零年三月目录目录21范围41.1文档更改历史42缩略语53群组管理服务器HTTP服务63.1支持的HTTP方法63.2支持的HTTP头63.2.1适用于所有操作的头63.2.2PUT和POST 必须携带的头63.2.3GET 多播群组GSK必须携带的头：Q-CNONCE73.2.4用于条件操作HTTP头73.3群组管理服务器XCAP 请求URL83.4群组管理服务器器后向兼容对客户端XML解析的要求104群组管理服务器HTTP 接口规范114.1概述114.2正常响应114.2.1正常响
2、应描述114.3错误响应124.3.1错误响应描述124.4操作共享群组（Shared Group）文档164.4.1Data Schema164.4.2使用场景244.5多播共享群组的多播信息（Multicast Information）管理514.5.1Data Schema514.5.2使用场景534.6组关联（Group Association） 管理644.6.1Data Schema644.6.2使用场景654.7组查询接口684.7.1Data Schema684.7.2使用场景695群组管理服务器短消息（SMS）接口规范735.1GLMS不同类型通知的短消息负荷735.1.1组
3、关联更新通知735.1.2给组主管理人的“自动退出”通知756典型的端到端用例766.1.1向共享群组里加组成员767群组服务器客户端的配置信息797.1配置信息797.2主副地址切换建议798对手机端和用户管理平台群组操作能力的建议801 范围群组管理服务器(GLMS) 是基于OMA XDMS 的体系要求实现的群组管理和 XML文档管理服务器. 它提供对用户的XML 文档如共享群组文档的管理. 文档的管理操作包括读取/增加/修改/删除. 这些操作是通过XCAP接口完成的。群组管理服务器(GLMS) 还提供群组的搜索能力。客户端可以提供诸如组主管理人，组成员等信息来搜索对应的共享群组。本文定义
4、与群组管理服务器(GLMS)进行通信时的接口规范。本文用GLMS表示群组管理服务器。1.1 文档更改历史时间说明2009.2.16以下为更改的主要内容：3.3: 增加对FQDN使用的解释5.1: 短消息负荷更改5.1.1: 终端获取XUI的方法更改7.1: 服务器故障转移定时参数取值修改7.2: 增加了主副地址切换的方法建议另外更改了一些拼写错误。2009.3.23.2.3: 定义Q-CNONCE携带的cnonce格式 3.2.3, 4.5.2.1, 6.1.1: 增加GLMS在响应消息中返回Q-CNONCE的内容和示例，去掉GSK Time需要加密的内容4.6.1, 4.6.2.1.2, 6
5、.1.1, 组关联中增加可选的premium-flag指示该用户是否为特别用户4.5.1 Data Schema中gsk-old, gsk-new改为256 bit，gsk-time改为32 bit. 并据此改动4.5.2.1, 6.1.1中相应数据的格式2009.6.254.4.1 Data Schema中的修改为 4.5.1 Data Schema中的修改为2009.7.145.1、5.1.1、5.1.2：修改GLMS采用SMGP协议要求及流程说明。2009.8.55.1、5.1.1、5.1.2：修改GLMS发送的为，以及针对的样例“QCHAT”修改为“PTT”。2009.8.5修改组关联
6、更新流程图。2009.8.5修改组成员退出提示要求。2009.8.311回退2009.6.25在4.4.1和4.5.1中做的对schema的修改。即schema中“conference-id”仍然保持为minOccurs=024.6.1中group-association的data schema中加入“conference-id”元素。34.6.1中group-association的data schema中加入“xs:any”元素以备将来扩展别的元素44.6.2.1.2和6.1.1中查询用户组关联的返回消息示例中，加入conference-id”元素。5文档URI示例中改为6. 文档示例中用
7、户域名和群组域名改为, 和2009.11.18更正图5-1中的协议标识。2009.11.23修改文档中所有“”为“”。2010.3.1修改文档中所有“”为“”。2010.3.25修改文档中所有“”为“sh.glms.vnet.mobi:9444”。2 缩略语缩略语定义3GPP3rd Generation Partnership ProjectAUIDApplication Usage IDFQDNFully Qualified Domain NameGLMSGroup and List Management ServerHTTPHypertext Transfer ProtocolIETFIn
8、ternet Engineering Task ForceOMAOpen Mobile AllianceSMPPShort Message Peer-to-peer ProtocolSMSCShort Message Service CenterURI Uniform Resource IdentifierURLUniform Resource LocatorXCAPXML Configuration Access ProtocolXDMXML Document ManagementXDMCXML Document Management ClientXDMSXML Document Manag
9、ement ServerXMLExtensible Markup LanguageXUIXCAP User Identity3 群组管理服务器HTTP服务3.1 支持的HTTP方法GLMS支持以下HTTP操作: HTTP GET （获取群组信息） HTTP PUT (根据不同的上下文，PUT 操作支持增加或修改群组内容) HTTP DELETE （删除群组信息） HTTP POST （搜索群组信息）3.2 支持的HTTP头3.2.1 适用于所有操作的头3.2.1.1 用于认证的头: ClientID“ClientID” 在每个HTTP请求中都必须携带. “ClientID” 可以被WAP网关或
10、用户群组管理平台加入，并随请求消息送到GLMS。ClientID应该携带明文的用户ID信息。GLMS信任“ClientID”所包含的用户ID就是请求发起者的用户ID。 注意：运营商也可以选用其它的HTTP头作为用于认证的头，如：3GPP-Accerted-Identify. 但所有的发送到GLMS的请求必须使用相同的头。3.2.1.2 用于识别客户端协议版本的头: GLMSClientVersion“GLMSClientVersion” 在每个HTTP请求中都必须携带. GLMS客户端用“GLMSClientVersion”表示它所实现的GLMS协议版本。对应于本规范，版本号应为“11.01”
11、注意：运营商也可以选用其它的HTTP头作为用于版本标识的头，如：GLMS-Group-Version. 但所有的发送到GLMS的请求必须使用相同的头。3.2.2 PUT和POST 必须携带的头对XCAP PUT 操作 , 下列HTTP头必须携带：“Content Type” 和 “Content Length”. 3.2.2.1 Content TypeContent-Type 头域指定所包含的消息体的媒体类型。其格式为:Content-Type = Content-Type : media-typeGLMS中有效的content type 为:Content-Type: text/plain
12、Content-Type: application/xcap-error+xmlContent-Type: application/vnd.oma.poc.groups+xmlContent-Type: application/xcap-el+xmlContent-Type: application/xcap-att+xmlContent-Type: application/group-association+xmlContent-Type: application/vnd.oma.search+xml参见接口定义确定在何种情况下使用何种content type. 3.2.2.2 Conten
13、t LengthContent-Length 头域指定消息体的长度 （8位字节数）。其格式为：Content-Length = Content-Length : 1*DIGIT例如: Content-Length: 34953.2.3 GET 多播群组GSK必须携带的头：Q-CNONCE当客户端想要发送XCAP GET请求来获取多播群组的包括GSK在内的多播信息时，必须携带Q-CNONCE头。该HTTP头包含PTT客户端产生的cnonce 值。GLMS会利用该cnonce产生用于加密GSK的密钥：PEK。返回的GSK是加密后的格式。Q-CNONCE中携带的cnonce必须是128 bit, 以
14、16进制格式传送（0-9，A-E为有效字符），如：Q-CNONCE: 102E3A4D516B7085910A1E2C3D40526A在返回的响应消息中，GLMS会将请求中携带的cononce用Q-CNONCE头带回，以备终端使用。 具体参见4.5.2.1。3.2.4 用于条件操作HTTP头HTTP 定义了几个可以被客户端用来做条件请求的头域：If-None-Match 和If-Match。 客户端可以根据所请求资源的实体标签（entity tag）来做条件请求. 这些条件请求的头域在请求消息里是可选用的. 条件请求的头域可以解决并发请求的冲突问题。3.2.4.1 If-MatchIf-Mat
15、ch 请求头域被HTTP方法(PUT/DELETE)用来做有条件操作. 对一个或多个从群组服务器获得的实体，XDS客户端可以在请求的If-Match头中包含某个实体的entity tag以确认它所具有的那个实体是最新的.If-Match头可以被用在以下场景中: 条件PUTXDM客户端想增加或修改服务器XDM文档中的某个元素（element），并且希望服务器所具有的文档版本和客户端当前所具有的那个文档相同时才能修改。客户端可以在请求中包含If-Match头, 并将客户端所具有的实体标签（entity tag）值写在里面. 如果文档已经改变，群组服务器会拒绝这个请求返回412 （条件失败）. 在这
16、种情况下，客户端需要重新用GET请求从服务器获取这个文档并保存服务器在200 OK中返回的新的实体标签（entity tag）。 客户端可以把新的实体标签（entity tag）放在If-Matc头中重新请求修改文档。 如果操作成功， 响应消息的etag头会包含刚被修改过的资源的新的实体标签（entity tag）。 条件 DELETE XDM客户端也可以在DELETE请求中包含If-Match头来做条件删除. DELETE请求的 200 OK 响应会包含一个etag 头域, 带有所删除元素所在的整个文档的实体标签（entity tag）3.2.4.2 If-None-MatchIf-None
17、-Match请求头域可以和GET请求方法一起使用做条件请求. If-None-Match头中可以包含客户端以前从服务器所获取的资源实体的实体标签（entity tag）。If-None-Match 头可以被用在以下场景中: 条件GET 当 XDM 客户端本地存有一个文档的版本，它可以做条件GET来判断服务器对统一文档是否有更新。如果本地文档仍然是最新的，客户端就不会重新下载文档，以此节省网络的使用。为了达到这个目的，客户端在GET请求中携带 If-None-Match 头域，其中包含客户端当前文档的实体标签（entity tag）. 群组服务器如果发现服务器文档标签和客户端不同，会响应200
18、OK. 如果服务器文档标签和客户端相同, 服务器会响应304.3.3 群组管理服务器XCAP 请求URL1. XCAP 根节点 （XCAP root）XCAP根定义了所有可被请求的资源所在的位置. XCAP根用HTTP URI表示, 被称为XCAP根RUI。对群组服务XCAP根 被定义为/GLMS FQDN/glms-services.注：在具体构造HTTP 请求时，GLMS FQDN应该为GLMS 服务器的地址，并且在发出HTTP请求时放在HOST HTTP头中，而不是在Request-URI中。另外，由于GLMS有主副地址，GLMS FQDN可能是两个。（关于主副地址，请参见第7章）2.
19、文档选择器 （Document Selector）在文档根节点下的每一个XML文档使用文档选择器唯一标识，文档选择器类似于由多个路径标识符组成的一个完整路径，使用“/”作为路径分隔符. 第一个路径部分必须是XCAP AUID。对群组服务器而言，有以下三种XCAP AUID:* ORG.OPENMOBILEALLIANCE.GROUPS: 用来进行群组的操作* MULTICAST-INFO: 用来操作群组的多播信息* GROUP-ASSOCIATION：用来获取个人所在的群组信息在每个AUID下有两个子XCAP分支. 一个成为 “用户树”（“user”tree）, 保存某个用户的所有文档。 另一
20、个分支是“全局树”（“global”tree）, 保存适用于所有用户的文档. AUID 之后的路径部分必须是global 或 users. 在“用户树”下是零个或多个子树，每个子树包含某个用户的文档。每个用户对服务器而言都有一个用户名，被称为XCAP用户表示（XCAP User Identifier: XUI). 文档选择器余下的部分 (global 或 XUI以后的路径指向具体的文档名.3. 节点选择器 （Node selector）节点选择器指定XML文档中具体被操作的节点. 节点选择器指向XML元素或元素属性. 4. 产生GLMS请求URL 访问群组管理服务器的某个用户的XML文档, 使
21、用以下的URL格式:http:/FQDN of GLMS server/service name/AUID/users/XUI of user/group document name访问GLMS的全局的XML文档, 使用以下的URL格式:http:/FQDN of GLMS server/service name/AUID/global/index访问GLMS文档的XML元素，使用以下的URL格式:document selector/node selector文档选择器（Document selector） 部分可以是用户特定的文档或全局文档。节点选择器（node selector ）部分是X
22、ML文档中的元素. 更多详情参见本规范的具体例子. 3.4 群组管理服务器器后向兼容对客户端XML解析的要求这里的群组管理服务器客户端指所有与GLMS进行HTTP/XCAP通信客户端应用程序。GLMS会不断加入新的功能. 群组管理的XML schema 在将来可能会扩展。GLMS升级到新的版本而客户端有可能仍然是旧的版本。为了使GLMS后向兼容，GLMS客户端的实现必须要遵循以下建议:oGLMS客户端必须忽略服务器返回的合法的XML文档中不能识别的 XML 元素 或属性，而不是报错退出对文档的处理. 4 群组管理服务器HTTP 接口规范4.1 概述GLMS为客户端应用提供XCAP接口来管理服务
23、器存储的群组XML文档. 客户端应用可以 读取/更新/删除 XML文档及其 XML 元素和属性. 本章给出群组管理服务器XCAP 接口规范。4.2 正常响应如果客户端的请求被成功处理，GLMS支持成功的 2xx 状态码：状态码描述200OK201Created202Accepted4.2.1 正常响应描述4.2.1.1 200 (OK) 响应当XCAP GET/PUT/DELETE 请求被成功处理时返回.示例消息:HTTP/1.1 200 OKetag: bcbcbcContent-Length: 0. . .4.2.1.2 201 (Created) 响应当XCAP PUT 请求被执行并其请
24、求的resrouce已经产生.示例消息:HTTP/1.1 201 Createdetag: ababab. . .Content-Length: 04.2.1.3 202 (Accepted) 响应当XCAP PUT 请求正在执行但处理并没有全部完成示例消息:HTTP/1.1 202 Accepted. . .Content-Length: 04.3 错误响应XCAP 使用与HTTP协议相同定义的错误响应状态码。GLMS支持3类错误状态码：3xx, 4xx, 和 5xx. 3xx 是重定向状态码，指示客户端为满足请求去采取其它的行动。4xx 是客户端错误码，指出客户端请求可能包含的错误. 5x
25、x 是服务器错误码，指示服务器知道自己遇到问题而不能处理当前的请求。状态码描述304Not Modified400Bad Request403Forbidden404Not Found405Method Not Allowed409Conflict412Precondition Failed415Unsupported Media Type500Internal Server Error503Service Unavailable Error4.3.1 错误响应描述4.3.1.1 304 (Not Modified) 响应在条件GET中使用. 客户端在If-None-Match 头中包含的et
26、ag与服务器所具有的该文档etag相同响应消息示例:HTTP/1.1 304 Not ModifiedContent-Type: text/plain; charset=ISO-8859-1Content-Length: 04.3.1.2 403 (Forbidden) 响应可以对XCAP GET/PUT/DELETE 操作响应. GLMS不能处理该请求，尽管理解该请求。 GLMS可能携带请求被拒绝的原因在403响应的“reason-phrase”中。响应消息示例:HTTP/1.1 403 Forbidden. The request is not allowed since the asso
27、ciated feature is locked.Content-Type: text/plain; charset=ISO-8859-1Content-Length: 04.3.1.3 400 (Bad Request) 响应可以对XCAP GET/PUT/DELETE 操作响应。由于语法错误GLMS不能理解该请求.响应消息示例:HTTP/1.1 400 Bad RequestContent-Type: text/plain; charset=ISO-8859-1Content-Length: 04.3.1.4 404 (Not Found) 响应可以对XCAP GET/PUT/DELETE
28、 操作响应. GLMS不能找到被请求的资源。响应消息示例:HTTP/1.1 404 Not FoundContent-Type: text/plain; charset=ISO-8859-1Content-Length: 04.3.1.5 405 (Method Not Allowed) 响应可以对XCAP GET/PUT/DELETE 和HTTP POST 操作响应. GLMS理解请求的方法但是不支持该操作响应消息示例:HTTP/1.1 405 Method Not AllowedContent-Type: text/plain; charset=ISO-8859-1Content-Leng
29、th: 04.3.1.6 409 (Conflict) 响应可以对XCAP GET/PUT/DELETE 操作响应。请求因对当前资源的冲突而不能完成。409 响应可携带 XML 消息体来指定冲突的具体原因。以下是409响应中所包含的“xcap-error” data schema. “xcap-error” 可以用来给出具体冲突原因。客户端应该支持以下schema： 响应消息示例:HTTP/1.1 409 ConflictContent-Type: application/xcap-error+xmlContent-Length: xxxxx4.3.1.7 412 (Precondition
30、Failed) 响应可以对XCAP GET/PUT/DELETE 操作响应。 客户端可以携带If-Match 头域来包含客户端所具有的etag. 如果文档在服务器中已改变，412 就会被返回.响应消息示例:HTTP/1.1 412 Precondition FailedContent-Type: text/plain; charset=ISO-8859-1Content-Length: 04.3.1.8 415 (Unsupported Media Type) 响应可以对XCAP GET/PUT/DELETE 操作响应。 群组服务器不接受请求消息中的内容编码。响应消息示例:HTTP/1.1 4
31、15 Unsupported Media TypeContent-Type: text/plain; charset=ISO-8859-1Content-Length: 04.3.1.9 500 (Internal Server Error) 响应可以对XCAP GET/PUT/DELETE 操作响应. 群组服务器遇到不可预料的情况不能完成请求.响应消息示例:HTTP/1.1 500 Internal Server ErrorContent-Type: text/plain; charset=ISO-8859-1Content-Length: 04.3.1.10 503 (Service Un
32、available) 响应可以对XCAP GET/PUT/DELETE 操作响应. 群组服务器因过载或维护等原因暂时不能处理请求.响应消息示例:HTTP/1.1 503 Service UnavailableContent-Type: text/plain; charset=ISO-8859-1Content-Length: 04.4 操作共享群组（Shared Group）文档4.4.1 Data SchemaGLMS 扩展了共享群组（Shared Group） schema以支持QChat群组。.1. shared group schemaxs:schema targetNamespace=urn:oma:xml:poc:list-service xmlns=urn:oma:xml:poc:list-service xmlns:cr=urn:ietf:params:xml:ns:common-policy xmlns:ocr=urn:o
