1、 ETSI ES 201 915-7 V1.4.1 (2003-07)ETSI Standard Open Service Access (OSA);Application Programming Interface (API);Part 7: Terminal Capabilities SCF(Parlay 3)floppy3 ETSI ETSI ES 201 915-7 V1.4.1 (2003-07) 2 Reference RES/SPAN-120095-7 Keywords API, OSA, IDL, UML 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, send your comment to: editoretsi.org Copyright Notification No part may be reproduced except as authorized by written permission. The copyright and the foregoing restriction extend to reproduction in all media. European Telecommun
6、ications Standards Institute 2003. The Parlay Group 2003. 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 being registered by ETSI for the benefit of its Members. 3GPPTM is a
7、Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners. ETSI ETSI ES 201 915-7 V1.4.1 (2003-07) 3 Contents Intellectual Property Rights5 Foreword.5 1 Scope 6 2 References 6 3 Definitions and abbreviations.6 3.1 Definitions6 3.2 Abbreviations .6 4 Termina
8、l Capabilities SCF .6 4.1 General requirements on support of methods.7 5 Sequence Diagrams 7 6 Class Diagrams.7 7 The Service Interface Specifications8 7.1 Interface Specification Format .8 7.1.1 Interface Class 8 7.1.2 Method descriptions8 7.1.3 Parameter descriptions8 7.1.4 State Model.8 7.2 Base
9、Interface.9 7.2.1 Interface Class IpInterface 9 7.3 Service Interfaces .9 7.3.1 Overview 9 7.4 Generic Service Interface .9 7.4.1 Interface Class IpService 9 8 Terminal Capabilities Interface Classes .10 8.1 Interface Class IpTerminalCapabilities 10 9 State Transition Diagrams11 10 Terminal Capabili
10、ties Data Definitions11 10.1 terminalIdentity 11 10.2 TpTerminalCapabilities11 10.3 TpTerminalCapabilitiesError .12 11 Exception Classes.12 Annex A (normative): OMG IDL Description of Terminal Capabilities SCF .13 Annex B (informative): Contents of 3GPP OSA R4 Terminal Capabilities .14 Annex C (info
11、rmative): Record of changes 15 C.1 Interfaces 15 C.1.1 New 15 C.1.2 Deprecated15 C.1.3 Modified.15 C.1.4 Removed.15 C.2 Methods15 C.2.1 New 15 C.2.2 Deprecated16 C.2.3 Modified.16 C.2.4 Removed.16 C.3 Data Definitions .16 ETSI ETSI ES 201 915-7 V1.4.1 (2003-07) 4 C.3.1 New 16 C.3.2 Modified.16 C.3.3
12、 Removed.16 C.4 Service Properties.17 C.4.1 New 17 C.4.2 Deprecated17 C.4.3 Modified.17 C.4.4 Removed.17 C.5 Exceptions 17 C.5.1 New 17 C.5.2 Modified.17 C.5.3 Removed.18 C.6 Others .18 History 19 ETSI ETSI ES 201 915-7 V1.4.1 (2003-07) 5 Intellectual Property Rights IPRs essential or potentially es
13、sential 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 can be found in ETSI SR 000 314: “Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs not
14、ified 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). Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee c
15、an 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 document. Foreword This ETSI Standard (ES) has been produced by ETSI Technical Committee Services and Protocols for Ad
16、vanced Networks (SPAN). 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 201 915) is structured in the following parts: Part 1: “Overview“; Part 2: “Common Data Defin
17、itions“; Part 3: “Framework“; Part 4: “Call Control SCF“; 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:
18、 “Charging 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 part of the Parlay 3.3 set of specifications. The present document i
19、s equivalent to 3GPP TS 29.198-7 V4.5.0 (Release 4). ETSI ETSI ES 201 915-7 V1.4.1 (2003-07) 6 1 Scope The present document is part 7 of the Stage 3 specification for an Application Programming Interface (API) for Open Service Access (OSA). The OSA specifications define an architecture that enables
20、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 interface. All aspects of the Terminal Capabilities SCF are defined here, th
21、ese being: Sequence Diagrams Class Diagrams Interface specification plus detailed method descriptions State Transition diagrams Data Definitions IDL Description of the interfaces The process by which this task is accomplished is through the use of object modelling techniques described by the Unified
22、 Modelling Language (UML). 2 References The references listed in clause 2 of ES 201 915-1 contain provisions which, through reference in this text, constitute provisions of the present document. ETSI ES 201 915-1: “Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
23、(Parlay 3)“. 3 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the terms and definitions given in ES 201 915-1 apply. 3.2 Abbreviations For the purposes of the present document, the abbreviations defined in ES 201 915-1 apply. 4 Terminal Capabilities SCF The f
24、ollowing clauses describe each aspect of the Terminal Capabilities Service Capability Feature (SCF). The order is as follows: The Sequence diagrams give the reader a practical idea of how each of the SCF is implemented. The Class relationships clause show how each of the interfaces applicable to the
25、 SCF, relate to one another. ETSI ETSI ES 201 915-7 V1.4.1 (2003-07) 7 The Interface specification clause describes in detail each of the interfaces shown within the Class diagram part. The State Transition Diagrams (STD) show the transition between states in the SCF. The states and transitions are
26、well-defined; either methods specified in the Interface specification or events occurring in the underlying networks cause state transitions. The Data Definitions clause show a detailed expansion of each of the data types associated with the methods within the classes. Note that some data types are
27、used in other methods and classes and are therefore defined within the Common Data types part of the present document. 4.1 General requirements on support of methods An implementation of this API which supports or implements a method described in the present document, shall support or implement the
28、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_METHOD_NOT_SUPPORTED shall be returned to any call of that method. Where a method is not suppo
29、rted by an implementation of an Application interface, a call to that method shall be possible, and no exception shall be returned. 5 Sequence Diagrams There are no Sequence Diagrams for the Terminal Capabilities SCF. 6 Class Diagrams Terminal Capabilities Class Diagram: IpTerminalCapabilitiesgetTer
30、minalCapabilities()(from termcap)IpServicesetCallback()setCallbackWithSessionID()(from csapi)Figure 1: Package Overview ETSI ETSI ES 201 915-7 V1.4.1 (2003-07) 8 7 The Service Interface Specifications 7.1 Interface Specification Format This clause defines the interfaces, methods and parameters that
31、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 description of the methods supported by that interface, and
32、 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 interfaces between a Service and the Framework, the Servi
33、ce 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 are used in the API. Asynchronous methods are identif
34、ied 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 developer must implement the relevant IpApp or IpSvc inte
35、rfaces 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 are those that contain the return result of the meth
36、od 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. ETSI ETSI ES 201 915-7 V1.4.1 (2003-07) 9 7.2 Base Interface 7.2.1 Interface Class IpInterface All application, framework and service inte
37、rfaces inherit from the following interface. This API Base Interface does not provide any additional methods. IpInterface 7.3 Service Interfaces 7.3.1 Overview The Service Interfaces provide the interfaces into the capabilities of the underlying network - such as call control, user interaction, mess
38、aging, 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 Application Interface. 7.4 Generic Service Interface 7.4
39、.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, sessionID : in TpSessionID) : void Method setCallback() Thi
40、s 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, w
41、hich is used for callbacks ETSI ETSI ES 201 915-7 V1.4.1 (2003-07) 10Raises TpCommonExceptions, P_INVALID_INTERFACE_TYPE Method setCallbackWithSessionID() This method specifies the reference address of the applications callback interface that a service uses for interactions associated with a specifi
42、c session ID: e.g. a specific call, or call leg. It is not allowed to invoke this method on an interface that does not use SessionIDs. Parameters appInterface : in IpInterfaceRef Specifies a reference to the application interface, which is used for callbacks sessionID : in TpSessionID Specifies the
43、session for which the service can invoke the applications callback interface. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_INTERFACE_TYPE 8 Terminal Capabilities Interface Classes The Terminal Capabilities SCF enables the application to retrieve the terminal capabilities of the specifi
44、ed terminal. The Terminal Capabilities service provides a SCF interface that is called IpTerminalCapabilities. There is no need for an application interface, since IpTerminalCapabilities only contains the synchronous method getTerminalCapabilities. 8.1 Interface Class IpTerminalCapabilities Inherits
45、 from: IpService. The Terminal Capabilities SCF interface IpTerminalCapabilities contains the synchronous method getTerminalCapabilities. The application has to provide the terminaIdentity as input to this method. The result indicates whether or not the terminal capabilities are available in the net
46、work and, in case they are, it will return the terminal capabilities (see the data definition of TpTerminalCapabilities for more information). This interface shall be implemented by a Terminal Capabilities SCF. The getTerminalCapabilities()method shall be implemented as a minimum requirement. IpTerm
47、inalCapabilities getTerminalCapabilities (terminalIdentity : in TpString) : TpTerminalCapabilities ETSI ETSI ES 201 915-7 V1.4.1 (2003-07) 11Method getTerminalCapabilities() This method is used by an application to get the capabilities of a users terminal. Direction: Application to Network. Returns
48、result: Specifies the latest available capabilities of the users terminal. This information, if available, is returned as CC/PP headers as specified in W3C and adopted in the WAP UAProf specifications (see references in Part 1 of the present document). It contains URLs; terminal attributes and value
49、s, in RDF format; or a combination of both. Parameters terminalIdentity : in TpString Identifies the terminal. It may be a logical address known by the WAP Gateway/PushProxy. Returns TpTerminalCapabilities Raises TpCommonExceptions, P_INVALID_TERMINAL_ID 9 State Transition Diagrams There are no State Transition Diagrams for the Terminal Capabilities SCF. 10 Terminal Capabilities Data Definitions The constants and types defined in the following clauses are defined in the org.csapi.termcap package. A
