ETSI TS 129 198-16-2010 Digital cellular telecommunications system (Phase 2+) Universal Mobile Telecommunications System (UMTS) LTE Open Service Access (OSA) Application Programmin_1.pdf

1、 ETSI TS 129 198-16 V9.0.0 (2010-01)Technical Specification Digital cellular telecommunications system (Phase 2+);Universal Mobile Telecommunications System (UMTS);LTE;Open Service Access (OSA)Application Programming Interface (API);Part 16: Service broker Service Capability Feature (SCF) (3GPP TS 2

2、9.198-16 version 9.0.0 Release 9)floppy3ETSI ETSI TS 129 198-16 V9.0.0 (2010-01)13GPP TS 29.198-16 version 9.0.0 Release 9Reference RTS/TSGC-0029198-16v900 Keywords GSM, LTE, UMTS ETSI 650 Route des Lucioles F-06921 Sophia Antipolis Cedex - FRANCE Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 Siret

3、 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.org The present document may be made available in more than one electronic version or

4、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 ETSI printers of the PDF version kept on a specific network drive within ETSI Secretari

5、at. 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.org/tb/status/status.asp If you find errors in the present document, please send yo

6、ur 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 foregoing restriction extend to reproduction in all media. European Telecommunications Stand

7、ards Institute 2010. All rights reserved. DECTTM, PLUGTESTSTM, UMTSTM, TIPHONTM, the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered 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. LTE

8、is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners. GSM and the GSM logo are Trade Marks registered and owned by the GSM Association. ETSI ETSI TS 129 198-16 V9.0.0 (2010-01)23GPP TS 29.198-16 version 9.0.0 Release 9Intellectual

9、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 can be found in ETSI SR 000 314: “Intellectual Property Rights (IPRs

10、); 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). Pursuant to the ETSI IPR Policy, no investigation, including IPR search

11、es, 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 document. Foreword This Technical Specification (TS) has been produced

12、 by ETSI 3rd Generation Partnership Project (3GPP). The present document may refer to technical specifications or reports using their 3GPP identities, UMTS identities or GSM identities. These should be interpreted as being references to the corresponding ETSI deliverables. The cross reference betwee

13、n GSM, UMTS, 3GPP and ETSI identities can be found under http:/webapp.etsi.org/key/queryform.asp. ETSI ETSI TS 129 198-16 V9.0.0 (2010-01)33GPP TS 29.198-16 version 9.0.0 Release 9Contents Intellectual Property Rights 2g3Foreword . 2g3Foreword . 5g3Introduction 5g31 Scope 7g32 References 7g33 Defini

14、tions and abbreviations . 8g33.1 Definitions 8g33.2 Abbreviations . 8g34 Service Broker SCF 8g34.1 General requirements on support of methods . 8g35 Sequence Diagrams 8g36 Class Diagrams . 8g37 The Service Interface Specifications 9g37.1 Interface Specification Format . 9g37.1.1 Interface Class 9g37

15、.1.2 Method descriptions 9g37.1.3 Parameter descriptions 9g37.1.4 State Model . 9g37.2 Base Interface . 10g37.2.1 Interface Class IpInterface 10g37.3 Service Interfaces . 10g37.3.1 Overview 10g37.4 Generic Service Interface . 10g37.4.1 Interface Class IpService 10g37.4.1.1 Method setCallback() 10g37

16、.4.1.2 Method setCallbackWithSessionID() 11g38 Service Broker Interface Classes 11g38.1 Interface Class IpServiceBroker . 11g38.1.1 Method registerServiceInteraction() . 12g38.1.2 Method unregisterServiceInteraction() . 13g39 State Transition Diagrams 13g310 Service Broker Service Properties 13g311

17、Data Definitions . 14g311.1 Service Broker Data Definitions 14g311.1.1 clientBrokerID 14g311.1.2 TpEndpointAddress 14g311.1.3 TpEndpointAddressCategory 14g311.1.4 TpServiceKey . 15g311.1.5 TpServiceKeyType . 15g312 Exception Classes . 15g3Annex A (normative): OMG IDL Description of Service Broker SC

18、F . 16g3Annex B (informative): W3C WSDL Description of Service Broker SCF 17g3Annex C (informative): Java API Description of the Service Broker SCF . 18g3ETSI ETSI TS 129 198-16 V9.0.0 (2010-01)43GPP TS 29.198-16 version 9.0.0 Release 9Annex D (informative): Description of Service Broker for 3GPP2 c

19、dma2000 networks . 19g3D.1 General Exceptions. 19g3D.2 Specific Exceptions 19g3D.2.1 Clause 1: Scope 19g3D.2.2 Clause 2: References 19g3D.2.3 Clause 3: Definitions and abbreviations . 19g3D.2.4 Clause 4: Service Broker SCF 19g3D.2.5 Clause 5: Sequence Diagrams 19g3D.2.6 Clause 6 Class Diagrams 20g3D

20、.2.7 Clause 7: The Service Interface Specifications 20g3D.2.8 Clause 8: Service Broker Interface Classes 20g3D.2.9 Clause 9: State Transition Diagrams 20g3D.2.10 Clause 10: Service Broker Service Properties 20g3D.2.11 Clause 11: Data Definitions 20g3D.2.12 Annex A (normative): OMG IDL Description of

21、 Service Broker SCF 20g3D.2.13 Annex B (informative): W3C WSDL Description of Service Broker SCF 20g3Annex E (informative): Change history . 21g3History 22g3ETSI ETSI TS 129 198-16 V9.0.0 (2010-01)53GPP TS 29.198-16 version 9.0.0 Release 9Foreword This Technical Specification has been produced by th

22、e 3rdGeneration Partnership Project (3GPP). The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of rel

23、ease date and an increase in version number as follows: Version x.y.z where: x the first digit: 1 presented to TSG for information; 2 presented to TSG for approval; 3 or greater indicates TSG approved document under change control. y the second digit is incremented for all changes of substance, i.e.

24、 technical enhancements, corrections, updates, etc. z the third digit is incremented when editorial only changes have been incorporated in the document. Introduction The present document is part 16 of a multi-part TS covering the 3rdGeneration Partnership Project: Technical Specification Group Core

25、Network; Open Service Access (OSA); Application Programming Interface (API), as identified below. The API specification (3GPP TS 29.198) is structured in the following Parts: Part 1: “Overview“; Part 2: “Common Data Definitions“; Part 3: “Framework“; Part 4: “Call Control“; Sub-part 1: “Call Control

26、 Common Definitions“; Sub-part 2: “Generic Call Control SCF“; Sub-part 3: “Multi-Party Call Control SCF“; Sub-part 4: “Multi-Media Call Control SCF“; Sub-part 5: “Conference Call Control SCF“; Part 5: “User Interaction SCF“; Part 6: “Mobility SCF“; Part 7: “Terminal Capabilities SCF“; Part 8: “Data

27、Session Control SCF“; Part 9: “Generic Messaging SCF“; (not part of 3GPP Release 8) Part 10: “Connectivity Manager SCF“; (new in Release 8) Part 11: “Account Management SCF“; Part 12: “Charging SCF“. Part 13: “Policy Management SCF“; Part 14: “Presence and Availability Management SCF“; Part 15: “Mul

28、ti Media Messaging SCF“; Part 16: “Service Broker SCF“;8 The Mapping specification of the OSA APIs and network protocols (3GPP TR 29.998) is also structured as above. A mapping to network protocols is however not applicable for all Parts, but the numbering of Parts is kept. Also in case a Part is no

29、t supported in a Release, the numbering of the parts is maintained. ETSI ETSI TS 129 198-16 V9.0.0 (2010-01)63GPP TS 29.198-16 version 9.0.0 Release 9Table: Overview of the OSA APIs Application Programming Interface; Part 1: Overview“. 2 3GPP TS 22.127: “Service Requirement for the Open Services Acc

30、ess (OSA); Stage 1“. 3 3GPP TS 23.198: “Open Service Access (OSA); Stage 2“. 4 3GPP TS 29.198-2: “Open Service Access (OSA) Application Programming Interface (API); Part 2: Common data definitions“. 5 ITU-T Recommendation Q.713: “Signalling connection control part formats and codes“. ETSI ETSI TS 12

31、9 198-16 V9.0.0 (2010-01)83GPP TS 29.198-16 version 9.0.0 Release 93 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the terms and definitions given in TS 29.198-1 1 apply. 3.2 Abbreviations For the purposes of the present document, the abbreviations given in

32、TS 29.198-1 1 apply. 4 Service Broker SCF The following clauses describe each aspect of the Service Broker Capability Feature (SCF). The order is as follows: The Sequence diagrams give the reader a practical idea of how each SCF is implemented. The Class relationships clause show how each of the int

33、erfaces 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 Transition Diagrams (STD) show the transition between states in the SCF. The states and transitions are well-defined; eit

34、her 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 used in other met

35、hods and classes and are therefore defined within the Common Data types part of this specification. 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 functionality descr

36、ibed 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 supported by an implemen

37、tation 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 Service Broker SCF. 6 Class Diagrams ETSI ETSI TS 129 198-16 V9.0.0 (2010-01)93GPP TS 29.198-16 version 9.0.0 Release 9IpService

38、BrokerregisterServiceInteraction()unregisterServiceInteraction()(from svcbroker)IpServicesetCallback()setCallbackWithSessionID()(from csapi)Figure: Service Broker Interfaces Overview 7 The Service Interface Specifications 7.1 Interface Specification Format This clause defines the interfaces, methods

39、 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 description of the methods supported b

40、y 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 interfaces between a Service and the

41、 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 are used in the API. Asynchronous

42、 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 developer must implement the relevant

43、 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 are those that contain the retur

44、n 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. ETSI ETSI TS 129 198-16 V9.0.0 (2010-01)103GPP TS 29.198-16 version 9.0.0 Release 97.2 Base Interface 7.2.1 Interface

45、Class IpInterface All application, framework and service interfaces 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 unde

46、rlying network - 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 denote

47、d as Application 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 IpInterfaceRe

48、f, sessionID : 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. Multiple invocations of thi

49、s method on an interface shall result in multiple callback references being specified. The SCS shall use the most recent callback interface provided by the application using this method. In the event that a callback reference fails or is no longer available, the next most recent callback reference available shall be used. ETSI ETSI TS 129 198-16 V9.0.0 (2010-01)113GPP TS 29.198-16 version 9.0.0 Release 9Parameters appInterface : in IpInterfaceRef Specifies a reference to the application interface, which is used for callbacks Raises TpComm