1、 ETSI TR 102 397-8 V1.1.1 (2005-08)Technical Report Open Service Access (OSA);Mapping of Parlay X Web Services to Parlay/OSA APIs;Part 8: Terminal Status MappingETSI ETSI TR 102 397-8 V1.1.1 (2005-08) 2 Reference DTR/TISPAN-01021-08-OSA Keywords API, OSA, service ETSI 650 Route des Lucioles F-06921
2、Sophia Antipolis Cedex - FRANCE Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 Siret N 348 623 562 00017 - NAF 742 C Association but non lucratif enregistre la Sous-Prfecture de Grasse (06) N 7803/88 Important notice Individual copies of the present document can be downloaded from: http:/www.etsi.or
3、g The present document may be made available in more than one electronic version or in print. In any case of existing or perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF). In case of dispute, the reference shall be the printing on ETS
4、I printers of the PDF version kept on a specific network drive within ETSI Secretariat. Users of the present document should be aware that the document may be subject to revision or change of status. Information on the current status of this and other ETSI documents is available at http:/portal.etsi
5、.org/tb/status/status.asp If you find errors in the present document, please send your comment to one of the following services: http:/portal.etsi.org/chaircor/ETSI_support.asp Copyright Notification No part may be reproduced except as authorized by written permission. The copyright and the foregoin
6、g restriction extend to reproduction in all media. European Telecommunications Standards Institute 2005. The Parlay Group 2005. All rights reserved. DECTTM, PLUGTESTSTM and UMTSTM are Trade Marks of ETSI registered for the benefit of its Members. TIPHONTMand the TIPHON logo are Trade Marks currently
7、 being registered by ETSI for the benefit of its Members. 3GPPTM is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners. ETSI ETSI TR 102 397-8 V1.1.1 (2005-08) 3 Contents Intellectual Property Rights4 Foreword.4 1 Scope 5 2 References 5 3 Definitio
8、ns and abbreviations.5 3.1 Definitions5 3.2 Abbreviations .5 4 Mapping description.5 5 Sequence diagrams.6 5.1 Single address query.6 5.2 Group query7 5.3 Notification.8 6 Detailed mapping information9 6.1 Operations 9 6.1.1 getStatus9 6.1.1.1 Mapping to IpUserStatus.statusReportReq 9 6.1.1.2 Mappin
9、g from IpAppUserStatus.statusReportRes.9 6.1.1.3 Mapping from IpAppUserStatus.statusReportErr.9 6.1.2 getStatusForGroup10 6.1.2.1 Mapping to IpUserStatus.statusReportReq 10 6.1.2.2 Mapping from IpAppUserStatus.statusReportRes.10 6.1.2.3 Mapping from IpAppUserStatus.statusReportErr.11 6.1.3 startNoti
10、fication 11 6.1.3.1 Mapping to IpUserStatus.triggeredStatusReportingStartReq11 6.1.3.2 Mapping to IpUserStatus.statusReportReq 11 6.1.4 endNotification .12 6.1.4.1 Mapping to IpUserStatus.triggeredStatusReportingStop .12 6.1.5 statusNotification12 6.1.5.1 Mapping from IpAppUserStatus.triggeredStatus
11、Report13 6.1.5.2 Mapping from IpAppUserStatus.statusReportRes.13 6.1.6 statusError.13 6.1.6.1 Mapping from IpAppUserStatus.triggeredStatusReportErr.14 6.1.7 statusEnd.14 6.2 Exceptions 14 6.2.1 Mapping from TpMobilityError 14 6.2.2 Mapping from Parlay/OSA method exceptions 14 7 Additional notes .14
12、History 15 ETSI ETSI TR 102 397-8 V1.1.1 (2005-08) 4 Intellectual Property Rights IPRs essential or potentially essential to the present document may have been declared to ETSI. The information pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and ca
13、n be found in ETSI SR 000 314: “Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in respect of ETSI standards“, which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web server (http:/webapp.etsi.org/IPR/home.asp). Pursu
14、ant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web server) which are, or may be, or may become, essential to the present docu
15、ment. Foreword This Technical Report (TR) has been produced by ETSI Technical Committee Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN). The present document is part 8 of a multi-part deliverable covering Open Service Access (OSA); Mapping of Parlay
16、X Web Services to Parlay/OSA APIs, as identified below: Part 1: “Common Mapping“; Part 2: “Third Party Call Mapping“; Part 3: “Call Notification Mapping“; Part 4: “Short Messaging Mapping“; Part 5: “Multimedia Messaging Mapping“; Part 6: “Payment Mapping“; Part 7: “Account Management Mapping“; Part
17、8: “Terminal Status Mapping“; Part 9: “Terminal Location Mapping“; Part 10: “Call Handling Mapping“; Part 11: “Audio Call Mapping“; Part 12: “Multimedia Conference Mapping“; Part 14: “Presence Mapping“. NOTE: Part 13 has not been provided as there is currently no defined mapping between ES 202 391-1
18、3 4 and the Parlay/OSA APIs. If a mapping is developed, it will become part 13 of this series. The present document has been defined jointly between ETSI, The Parlay Group (http:/www.parlay.org) and the 3GPP. ETSI ETSI TR 102 397-8 V1.1.1 (2005-08) 5 1 Scope The present document specifies the mappin
19、g of the Parlay X Terminal Status Web Service to the Mobility User Status Service Capability Feature (SCF). The Parlay X Web Services provide powerful yet simple, highly abstracted, imaginative, telecommunications functions that application developers and the IT community can both quickly comprehend
20、 and use to generate new, innovative applications. The Open Service Access (OSA) specifications define an architecture that enables application developers to make use of network functionality through an open standardized interface, i.e. the Parlay/OSA APIs. 2 References For the purposes of this Tech
21、nical Reports (TR), the following references apply: 1 ETSI TR 121 905: “Universal Mobile Telecommunications System (UMTS); Vocabulary for 3GPP Specifications (3GPP TR 21.905)“. 2 W3C Recommendation (2 May 2001): “XML Schema Part 2: Datatypes“. NOTE: Available at http:/www.w3.org/TR/2001/REC-xmlschem
22、a-2-20010502/. 3 ETSI TR 102 397-1: “ Open Service Access (OSA); Mapping of Parlay X Web Services to Parlay/OSA APIs; Part 1: Common Mapping“. 4 ETSI ES 202 391-13: “Open Service Access (OSA); Parlay X Web Services; Part 13: Address List Management“. 3 Definitions and abbreviations 3.1 Definitions F
23、or the purposes of the present document, the terms and definitions given in TR 102 397-1 3 apply. 3.2 Abbreviations For the purposes of the present document, the abbreviations given in TR 102 397-1 3 apply. 4 Mapping description The Terminal Status capability can be implemented with Parlay/OSA Mobil
24、ity User Status. It is applicable to ETSI OSA 1.x/2.x/3.x, Parlay/OSA 3.x/4.x/5.x and 3GPP Releases 4 to 6. ETSI ETSI TR 102 397-8 V1.1.1 (2005-08) 6 5 Sequence diagrams 5.1 Single address query To query the terminal status for a single address, the synchronous request results in an asynchronous req
25、uest being made to the User Status SCF to retrieve the status, and the result translated to return to the Enterprise Application. Application Terminal StatusIpApp UserStatus IpUser Status getStatusRequest “forward event” “new” statusReportReq() statusReportRes() getStatusResponse Figure 1 ETSI ETSI
26、TR 102 397-8 V1.1.1 (2005-08) 7 5.2 Group query A query of the terminal status for a group of addresses (using either application or network managed groups) requires the service to create the set of terminals for which the request applies, then interacting with the User Status SCF to retrieve the in
27、formation for the set of terminals. Application Terminal StatusIpApp UserStatus IpUser Status getStatusForGroupRequest “forward event” “new” statusReportReq() statusReportRes() getStatusForGroupResponse Figure 2 ETSI ETSI TR 102 397-8 V1.1.1 (2005-08) 8 5.3 Notification Notifications of change in te
28、rminal status may be made by setting up a notification with the User Status SCF and managing those notifications to provide the appropriate notifications and content to the Enterprise Application. In the following sequence diagram, the yellow highlighted sub-sequence represents optional actions init
29、iated by the Terminal Status web service, if the checkImmediate flag in the startNotificationRequest message is enabled. statusNotificationRequest statusNotificationResponse “forward event” statusNotificationResponse statusNotificationRequest Application Terminal StatusIpApp UserStatus IpUser Status
30、 startNotificationRequest “new” triggeredStatusReportingstatusReportRes () statusNotificationRequest startNotificationResponse statusNotificationResponse “forward event” triggeredStatusReport () statusNotificationRequest statusNotificationResponse endNotificationRequest triggeredStatusReportingendNo
31、tificationResponse statusReportReq () “forward event” triggeredStatusReport () Figure 3 ETSI ETSI TR 102 397-8 V1.1.1 (2005-08) 9 6 Detailed mapping information 6.1 Operations 6.1.1 getStatus The sequence diagram in clause 5.1 illustrates the flow for the getStatus operation. The getStatus operation
32、 is synchronous from the Parlay X clients point of view. It is mapped to the following Parlay/OSA methods: IpUserStatus.statusReportReq; IpAppUserStatus.statusReportRes; IpAppUserStatus.statusReportErr. 6.1.1.1 Mapping to IpUserStatus.statusReportReq The IpUserStatus.statusReportReq operation is inv
33、oked with the following parameters. Name Type Comment appStatus IpAppUserStatusRef Reference to callback (internal). users TpAddressSet Populated with one TpAddress element, constructed based on the URI provided in address part of getStatusRequest, mapped as described in in TR 102 397-1 3. The resul
34、t from IpUserStatus.statusReportReq is used internally to correlate the callbacks. Parlay exceptions thrown by IpUserStatus.statusReportReq are mapped to Parlay X exceptions as defined in clause 6.2.2. 6.1.1.2 Mapping from IpAppUserStatus.statusReportRes When status information is available, the IpA
35、ppUserStatus.statusReportRes callback is invoked. It is expected to contain a TpUserStatus element whose UserID field matches the TpAddress passed to the status request operation. The fields of the TpUserStatus element are mapped to the result part of the getStatusResponse message as follows. Name T
36、ype Comment UserID TpAddress Matches the TpAddress element passed to the status request operation. StatusCode TpMobilityError If the value is P_M_OK, a result is returned, otherwise an exception is thrown by getStatus using the mapping from TpMobilityError values to Parlay X Exceptions as defined in
37、 clause 6.2.1. Status TpUserStatusIndicator If the StatusCode value (above) is P_M_OK, then the Status value is mapped to the Status enumeration as follows: P_US_REACHABLE - Reachable P_US_NOT_REACHABLE - Unreachable P_US_BUSY - Busy. TerminalType TpTerminalType Not mapped. 6.1.1.3 Mapping from IpAp
38、pUserStatus.statusReportErr If an error prevents the status information from being reported, the IpAppUserStatus.statusReportErr callback is invoked. If this occurs, an exception will be thrown by getStatus based on the value of the cause parameter. Refer to the TpMobilityError to Parlay X exception
39、 mapping as defined in clause 6.2.1. ETSI ETSI TR 102 397-8 V1.1.1 (2005-08) 106.1.2 getStatusForGroup The sequence diagram in clause 5.2 illustrates the flow for the getStatusForGroup operation. The getStatusForGroup operation is synchronous from the Parlay X clients point of view. It is mapped to
40、the following Parlay/OSA methods: IpUserStatus.statusReportReq; IpAppUserStatus.statusReportRes; IpAppUserStatus.statusReportErr. 6.1.2.1 Mapping to IpUserStatus.statusReportReq The IpUserStatus.statusReportReq operation is invoked with the following parameters. Name Type Comment appStatus IpAppUser
41、StatusRef Reference to callback (internal). users TpAddressSet Populated with TpAddress elements, constructed based on: The individual address URIs passed in the addresses part of getStatusForGroupRequest. The address URIs obtained by resolving group URIs in the addresses part into individual addres
42、s URIs. URI to TpAddress mapping is described in TR 102 397-1 3. The result from IpUserStatus.statusReportReq is used internally to correlate the callbacks. Parlay exceptions thrown by IpUserStatus.statusReportReq are mapped to Parlay X exceptions as defined in clause 6.2.2. 6.1.2.2 Mapping from IpA
43、ppUserStatus.statusReportRes When status information is available, the IpAppUserStatus.statusReportRes callback is invoked. It is expected to contain a TpUserStatus element for each requested TpAddress in the original request. The TpUserStatus elements are used to create an array of StatusData eleme
44、nts comprising the result part of the getStatusForGroupResponse message. The mapping between TpUserStatus and StatusData is as follows. TpUserStatus element StatusData element Name Type Name Type Comment UserID TpAddress address anyURI TpAddress to URI mapping is described in TR 102 397-1 3. StatusC
45、ode TpMobilityError reportStatus Retrieval Status StatusCode value is mapped to reportStatus as follows: P_M_OK - Retrieved P-M-xxx (i.e. all other values) - Error. Status TpUserStatus Indicator currentStatus Status If the StatusCode value (above) is P_M_OK, then the mapping is as follows: P_US_REAC
46、HABLE - Reachable P_US_NOT_REACHABLE - Unreachable P_US_BUSY - Busy. TerminalType TpTerminalType Not mapped. error Information common: ServiceError If the StatusCode value (above) is NOT P_M_OK, then the value of this element is defined in clause 6.2.1. In the event that a a TpUserStatus element is
47、missing for a requested address in the original request, then a StatusData element (with a reportStatus value = NotRetrieved) is included in the result part of the getStatusForGroupResponse message. ETSI ETSI TR 102 397-8 V1.1.1 (2005-08) 116.1.2.3 Mapping from IpAppUserStatus.statusReportErr If an
48、error prevents the status information from being reported, the IpAppUserStatus.statusReportErr callback is invoked. If this occurs, an exception will be thrown by getStatusForGroup based on the value of the cause parameter. Refer to the TpMobilityError to Parlay X exception mapping as defined in cla
49、use 6.2.1. 6.1.3 startNotification The sequence diagram in clause 5.3 illustrates the flow of events when a client establishes a triggered status notification request. The startNotification operation is mapped to the following Parlay/OSA methods: IpUserStatus.triggeredStatusReportingStartReq; IpUserStatus.statusReportReq. 6.1.3.1 Mapping to IpUserStatus.triggeredStatusReportingStartReq The Endpoint reference provided by the client in the reference part of the startNotificationRequest message will be used by the Parlay X implementati
