ETSI ES 202 915-7-2006 Open Service Access (OSA) Application Programming Interface (API) Part 7 Terminal Capabilities SCF (Parlay 4) (V1 4 1 Includes Diskette)《开放业务接入(OSA) 应用编程接口(A_1.pdf

1、 ETSI ES 202 915-7 V1.4.1 (2006-12)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 7: Terminal Capabilities SCF(Parlay 4)floppy3 ETSI ETSI ES 202 915-7 V1.4.1 (2006-12) 2 Reference RES/TISPAN-01028-07-OSA Keywords API, IDL, OSA, UML ETSI 650 Route des Lucioles F-

2、06921 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.e

3、tsi.org 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

4、on ETSI 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:/porta

5、l.etsi.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 fo

6、regoing restriction extend to reproduction in all media. European Telecommunications Standards Institute 2006. The Parlay Group 2006. 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 cur

7、rently 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 ES 202 915-7 V1.4.1 (2006-12) 3 Contents Intellectual Property Rights5 Foreword.5 1 Scope 6 2 References 6 3 Def

8、initions and abbreviations.6 3.1 Definitions6 3.2 Abbreviations .6 4 Terminal Capabilities SCF .7 4.1 General requirements on support of methods.7 5 Sequence Diagrams 7 5.1 Terminal capabilities example7 6 Class Diagrams.9 7 The Service Interface Specifications10 7.1 Interface Specification Format .

9、10 7.1.1 Interface Class 10 7.1.2 Method descriptions10 7.1.3 Parameter descriptions10 7.1.4 State Model.10 7.2 Base Interface.10 7.2.1 Interface Class IpInterface 10 7.3 Service Interfaces .11 7.3.1 Overview 11 7.4 Generic Service Interface .11 7.4.1 Interface Class IpService 11 7.4.1.1 Method setC

10、allback()11 7.4.1.2 Method setCallbackWithSessionID()11 8 Terminal Capabilities Interface Classes .12 8.1 Interface Class IpTerminalCapabilities 12 8.1.1 Method getTerminalCapabilities()12 8.2 Interface Class IpExtendedTerminalCapabilities .13 8.2.1 Method triggeredTerminalCapabilityStartReq() 13 8.

11、2.2 Method triggeredTerminalCapabilityStop().14 8.3 Interface Class IpAppExtendedTerminalCapabilities 14 8.3.1 Method triggeredTerminalCapabilityReport() .15 8.3.2 Method triggeredTerminalCapabilityReportErr() 15 9 State Transition Diagrams15 10 Service Properties.15 11 Terminal Capabilities Data De

12、finitions16 11.1 terminalIdentity 16 11.2 TpTerminalCapabilities16 11.3 TpTerminalCapabilitiesError .16 11.4 TpTerminalCapabilityChangeCriteria17 11.5 TpTerminalCapabilityScopeType 17 11.6 TpTerminalCapabilityScope.17 12 Exception Classes.17 Annex A (normative): OMG IDL Description of Terminal Capab

13、ilities SCF .18 Annex B (informative): W3C WSDL Description of Terminal Capabilities SCF19 ETSI ETSI ES 202 915-7 V1.4.1 (2006-12) 4 Annex C (informative): Java API Description of the Terminal Capabilities SCF .20 Annex D (informative): Contents of 3GPP OSA R5 Terminal Capabilities .21 Annex E (info

14、rmative): Record of changes 22 E.1 Interfaces 22 E.1.1 New 22 E.1.2 Deprecated22 E.1.3 Removed.22 E.2 Methods23 E.2.1 New 23 E.2.2 Deprecated23 E.2.3 Modified.23 E.2.4 Removed.23 E.3 Data Definitions .24 E.3.1 New 24 E.3.2 Modified.24 E.3.3 Removed.24 E.4 Service Properties.25 E.4.1 New 25 E.4.2 Dep

15、recated25 E.4.3 Modified.25 E.4.4 Removed.25 E.5 Exceptions 26 E.5.1 New 26 E.5.2 Modified.26 E.5.3 Removed.26 E.6 Others .26 History 27 ETSI ETSI ES 202 915-7 V1.4.1 (2006-12) 5 Intellectual Property Rights IPRs essential or potentially essential to the present document may have been declared to ET

16、SI. The information pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can 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 availa

17、ble from the ETSI Secretariat. Latest updates are available on the ETSI Web server (http:/webapp.etsi.org/IPR/home.asp). Pursuant 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

18、 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 document. Foreword This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet converged Services and Protocols for Advanced Networking

19、(TISPAN). The present document is part 7 of a multi-part deliverable covering Open Service Access (OSA); Application Programming Interface (API), as identified below. The API specification (ES 202 915) is structured in the following parts: Part 1: “Overview“; Part 2: “Common Data Definitions“; Part

20、3: “Framework“; Part 4: “Call Control“; Part 5: “User Interaction SCF“; Part 6: “Mobility SCF“; Part 7: “Terminal Capabilities SCF“; Part 8: “Data Session Control SCF“; Part 9: “Generic Messaging SCF“; Part 10: “Connectivity Manager SCF“; Part 11: “Account Management SCF“; Part 12: “Charging SCF“; P

21、art 13: “Policy Management SCF“; Part 14: “Presence and Availability Management SCF“. The present document has been defined jointly between ETSI, The Parlay Group (http:/www.parlay.org) and the 3GPP, in co-operation with a number of JAIN Community (http:/ member companies. The present document forms

22、 part of the Parlay 4.3 set of specifications. The present document is equivalent to 3GPP TS 29.198-7 V5.8.0 (Release 5). ETSI ETSI ES 202 915-7 V1.4.1 (2006-12) 6 1 Scope The present document is part 7 of the Stage 3 specification for an Application Programming Interface (API) for Open Service Acce

23、ss (OSA). The OSA specifications define an architecture that enables application developers to make use of network functionality through an open standardised interface, i.e. the OSA APIs. The present document specifies the Terminal Capabilities Service Capability Feature (SCF) aspects of the interfa

24、ce. All aspects of the Terminal Capabilities SCF are defined here, these being: Sequence Diagrams. Class Diagrams. Interface specification plus detailed method descriptions. State Transition diagrams. Data Definitions. IDL Description of the interfaces. WSDL Description of the interfaces. The proces

25、s by which this task is accomplished is through the use of object modelling techniques described by the Unified Modelling Language (UML). 2 References The references listed in clause 2 of ES 202 915-1 contain provisions which, through reference in this text, constitute provisions of the present docu

26、ment. ETSI ES 202 915-1: “Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview (Parlay 4)“. 3 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the terms and definitions given in ES 202 915-1 apply. 3.2 Abbreviations For the purpo

27、ses of the present document, the abbreviations defined in ES 202 915-1 apply. ETSI ETSI ES 202 915-7 V1.4.1 (2006-12) 7 4 Terminal Capabilities SCF The following clauses describe each aspect of the Terminal Capabilities Capability Feature (SCF). The order is as follows: The Sequence diagrams give th

28、e reader a practical idea of how each of the SCF is implemented. The Class relationships clause shows how each of the interfaces applicable to the SCF, relate to one another. The Interface specification clause describes in detail each of the interfaces shown within the Class diagram part. The State

29、Transition Diagrams (STD) show the transition between states in the SCF. The states and transitions are well-defined; either methods specified in the Interface specification or events occurring in the underlying networks cause state transitions. The Data Definitions clause shows a detailed expansion

30、 of each of the data types associated with the methods within the classes. Note that some data types are used in other methods and classes and are therefore defined within the Common Data types part ES 202 915-2. 4.1 General requirements on support of methods An implementation of this API which supp

31、orts or implements a method described in the present document, shall support or implement the functionality described for that method, for at least one valid set of values for the parameters of that method. Where a method is not supported by an implementation of a Service interface, the exception P_

32、METHOD_NOT_SUPPORTED shall be returned to any call of that method. Where a method is not supported by an implementation of an Application interface, a call to that method shall be possible, and no exception shall be returned. 5 Sequence Diagrams 5.1 Terminal capabilities example The following exampl

33、e sequence diagram illustrates how the terminal capabilities can be retrieved and their changes monitored. ETSI ETSI ES 202 915-7 V1.4.1 (2006-12) 8 Application : IpAppExtendedTerminalCapabilities: IpTe rminalC apabi l it ies: IpExtendedTerminalCapabilities1: getTerminalCapability( )2: new( )3: trig

34、geredTerminalCapabilityStartReq( )4: triggeredTerminalCapabilityReport( )6: triggeredTerminalCapabilityReport( )5: forward notification7: forward notification8: triggeredTerminalCapabilityReportErr( )9: forward error10: triggeredTerminalCapabilityReport( )11: forward notification12: triggeredTermina

35、lCapabilityStop( )1: The application retrieves the terminal capability of a terminal. 2: The application creates an object to implement IpAppExtendedTerminalCapabilities. 3: The terminal capabilities changes are started to be monitored. 4: The terminal capabilities have changed and they are reported

36、 as requested. 5: The report is forwarded internally to the application. 6: The terminal capabilities have changed and they are reported as requested. 7: The report is forwarded internally to the application. 8: An error has happened in the monitoring and it is reported. 9: The error report is forwa

37、rded internally to the application. 10: The terminal capabilities have changed and they are reported as requested. 11: The report is forwarded internally to the application. 12: The terminal capability monitoring is stopped. ETSI ETSI ES 202 915-7 V1.4.1 (2006-12) 9 6 Class Diagrams Terminal Capabil

38、ities Class Diagram: IpTerminalCapabilitiesgetTerminalCapabilities()(f ro m t e rm c a p)IpServicesetCallback()setCallbackWithSessionID()(from c sapi)IpExtendedTerminalCapabilities triggeredTerminalCapabilityStartReq() triggeredTerminalCapabilityStop()(f ro m t e rm c a p)IpAppExtendedTerminalCapabi

39、lities triggeredTerminalCapabilityReport() triggeredTerminalCapabilityReportErr()(f ro m t e rm c a p)IpInterface(from c sapi)Figure 1: Terminal Capabilities Class Diagram ETSI ETSI ES 202 915-7 V1.4.1 (2006-12) 107 The Service Interface Specifications 7.1 Interface Specification Format This clause

40、defines the interfaces, methods and parameters that form a part of the API specification. The Unified Modelling Language (UML) is used to specify the interface classes. The general format of an interface specification is described below. 7.1.1 Interface Class This shows a UML interface class descrip

41、tion of the methods supported by that interface, and the relevant parameters and types. The Service and Framework interfaces for enterprise-based client applications are denoted by classes with name Ip. The callback interfaces to the applications are denoted by classes with name IpApp. For the inter

42、faces between a Service and the Framework, the Service interfaces are typically denoted by classes with name IpSvc, while the Framework interfaces are denoted by classes with name IpFw. 7.1.2 Method descriptions Each method (API method “call“) is described. Both synchronous and asynchronous methods

43、are used in the API. Asynchronous methods are identified by a Req suffix for a method request, and, if applicable, are served by asynchronous methods identified by either a Res or Err suffix for method results and errors, respectively. To handle responses and reports, the application or service deve

44、loper must implement the relevant IpApp or IpSvc interfaces to provide the callback mechanism. 7.1.3 Parameter descriptions Each method parameter and its possible values are described. Parameters described as in represent those that must have a value when the method is called. Those described as out

45、 are those that contain the return result of the method when the method returns. 7.1.4 State Model If relevant, a state model is shown to illustrate the states of the objects that implement the described interface. 7.2 Base Interface 7.2.1 Interface Class IpInterface All application, framework and s

46、ervice interfaces inherit from the following interface. This API Base Interface does not provide any additional methods. IpInterface ETSI ETSI ES 202 915-7 V1.4.1 (2006-12) 117.3 Service Interfaces 7.3.1 Overview The Service Interfaces provide the interfaces into the capabilities of the underlying n

47、etwork - such as call control, user interaction, messaging, mobility and connectivity management. The interfaces that are implemented by the services are denoted as Service Interface. The corresponding interfaces that must be implemented by the application (e.g. for API callbacks) are denoted as App

48、lication Interface. 7.4 Generic Service Interface 7.4.1 Interface Class IpService Inherits from: IpInterface; All service interfaces inherit from the following interface. IpService setCallback (appInterface : in IpInterfaceRef) : void setCallbackWithSessionID (appInterface : in IpInterfaceRef, sessi

49、onID : in TpSessionID) : void 7.4.1.1 Method setCallback() This method specifies the reference address of the callback interface that a service uses to invoke methods on the application. It is not allowed to invoke this method on an interface that uses SessionIDs. Parameters appInterface : in IpInterfaceRef Specifies a reference to the application interface, which is used for callbacks. Raises TpCommonExceptions, P_INVALID_INTERFACE_TYPE 7.4.1.2 Method setCallbackWithSessionID() This method specifie